xref: /linux-6.15/kernel/workqueue.c (revision d64f2fa0)
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>
57e22bee78STejun Heo 
58ea138446STejun Heo #include "workqueue_internal.h"
591da177e4SLinus Torvalds 
60e563d0a7STejun Heo enum worker_pool_flags {
61bc2ae0f5STejun Heo 	/*
6224647570STejun Heo 	 * worker_pool flags
63bc2ae0f5STejun Heo 	 *
6424647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
65bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
66bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
67bc2ae0f5STejun Heo 	 * is in effect.
68bc2ae0f5STejun Heo 	 *
69bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
70bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
7124647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
72bc2ae0f5STejun Heo 	 *
73bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
741258fae7STejun Heo 	 * wq_pool_attach_mutex to avoid changing binding state while
754736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
764cb1ef64STejun Heo 	 *
774cb1ef64STejun Heo 	 * As there can only be one concurrent BH execution context per CPU, a
784cb1ef64STejun Heo 	 * BH pool is per-CPU and always DISASSOCIATED.
79bc2ae0f5STejun Heo 	 */
804cb1ef64STejun Heo 	POOL_BH			= 1 << 0,	/* is a BH pool */
814cb1ef64STejun Heo 	POOL_MANAGER_ACTIVE	= 1 << 1,	/* being managed */
8224647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
83e563d0a7STejun Heo };
84db7bccf4STejun Heo 
85e563d0a7STejun Heo enum worker_flags {
86c8e55f36STejun Heo 	/* worker flags */
87c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
88c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
89e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
90fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
91f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
92a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
93e22bee78STejun Heo 
94a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
95a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
96e563d0a7STejun Heo };
97db7bccf4STejun Heo 
98e563d0a7STejun Heo enum wq_internal_consts {
99e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
1004ce62e9eSTejun Heo 
10129c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
102c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
103db7bccf4STejun Heo 
104e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
105e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
106e22bee78STejun Heo 
1073233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
1083233cdbdSTejun Heo 						/* call for help after 10ms
1093233cdbdSTejun Heo 						   (min two ticks) */
110e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
111e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
1121da177e4SLinus Torvalds 
1131da177e4SLinus Torvalds 	/*
114e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1158698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
116e22bee78STejun Heo 	 */
1178698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1188698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
119ecf6881fSTejun Heo 
12031c89007SAudra Mitchell 	WQ_NAME_LEN		= 32,
121c8e55f36STejun Heo };
122c8e55f36STejun Heo 
1231da177e4SLinus Torvalds /*
1244cb1ef64STejun Heo  * We don't want to trap softirq for too long. See MAX_SOFTIRQ_TIME and
1254cb1ef64STejun Heo  * MAX_SOFTIRQ_RESTART in kernel/softirq.c. These are macros because
1264cb1ef64STejun Heo  * msecs_to_jiffies() can't be an initializer.
1274cb1ef64STejun Heo  */
1284cb1ef64STejun Heo #define BH_WORKER_JIFFIES	msecs_to_jiffies(2)
1294cb1ef64STejun Heo #define BH_WORKER_RESTARTS	10
1304cb1ef64STejun Heo 
1314cb1ef64STejun Heo /*
1324690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1334690c4abSTejun Heo  *
134e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
135e41e704bSTejun Heo  *    everyone else.
1364690c4abSTejun Heo  *
137e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
138e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
139e22bee78STejun Heo  *
140d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1414690c4abSTejun Heo  *
1425797b1c1STejun Heo  * LN: pool->lock and wq_node_nr_active->lock protected for writes. Either for
1435797b1c1STejun Heo  *     reads.
1445797b1c1STejun Heo  *
145bdf8b9bfSTejun Heo  * K: Only modified by worker while holding pool->lock. Can be safely read by
146bdf8b9bfSTejun Heo  *    self, while holding pool->lock or from IRQ context if %current is the
147bdf8b9bfSTejun Heo  *    kworker.
148bdf8b9bfSTejun Heo  *
149bdf8b9bfSTejun Heo  * S: Only modified by worker self.
150bdf8b9bfSTejun Heo  *
1511258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
152822d8405STejun Heo  *
15368e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
15476af4d93STejun Heo  *
15524acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  RCU protected for reads.
1565bcab335STejun Heo  *
1575b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1585b95e1afSLai Jiangshan  *
1595b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
16024acfb71SThomas Gleixner  *      RCU for reads.
1615b95e1afSLai Jiangshan  *
1623c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1633c25a55dSLai Jiangshan  *
16424acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  RCU protected for reads.
1652e109a28STejun Heo  *
166a045a272STejun Heo  * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read
167a045a272STejun Heo  *     with READ_ONCE() without locking.
168a045a272STejun Heo  *
1692e109a28STejun Heo  * MD: wq_mayday_lock protected.
170cd2440d6SPetr Mladek  *
171cd2440d6SPetr Mladek  * WD: Used internally by the watchdog.
1724690c4abSTejun Heo  */
1734690c4abSTejun Heo 
1742eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
175c34056a3STejun Heo 
176bd7bdd43STejun Heo struct worker_pool {
177a9b8a985SSebastian Andrzej Siewior 	raw_spinlock_t		lock;		/* the pool lock */
178d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
179f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1809daf9e67STejun Heo 	int			id;		/* I: pool ID */
181bc8b50c2STejun Heo 	unsigned int		flags;		/* L: flags */
182bd7bdd43STejun Heo 
18382607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
184cd2440d6SPetr Mladek 	bool			cpu_stall;	/* WD: stalled cpu bound pool */
18582607adcSTejun Heo 
186bc35f7efSLai Jiangshan 	/*
187bc35f7efSLai Jiangshan 	 * The counter is incremented in a process context on the associated CPU
188bc35f7efSLai Jiangshan 	 * w/ preemption disabled, and decremented or reset in the same context
189bc35f7efSLai Jiangshan 	 * but w/ pool->lock held. The readers grab pool->lock and are
190bc35f7efSLai Jiangshan 	 * guaranteed to see if the counter reached zero.
191bc35f7efSLai Jiangshan 	 */
192bc35f7efSLai Jiangshan 	int			nr_running;
19384f91c62SLai Jiangshan 
194bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
195ea1abd61SLai Jiangshan 
1965826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
1975826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
198bd7bdd43STejun Heo 
1992c1f1a91SLai Jiangshan 	struct list_head	idle_list;	/* L: list of idle workers */
200bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
2013f959aa3SValentin Schneider 	struct work_struct      idle_cull_work; /* L: worker idle cleanup */
2023f959aa3SValentin Schneider 
203bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	  /* L: SOS timer for workers */
204bd7bdd43STejun Heo 
205c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
206c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
207c9e7cf27STejun Heo 						/* L: hash of busy workers */
208c9e7cf27STejun Heo 
2092607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
21092f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
211e02b9312SValentin Schneider 	struct list_head        dying_workers;  /* A: workers about to die */
21260f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
213e19e397aSTejun Heo 
2147cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
215e19e397aSTejun Heo 
2167a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
21768e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
21868e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
2197a4e344cSTejun Heo 
220e19e397aSTejun Heo 	/*
22124acfb71SThomas Gleixner 	 * Destruction of pool is RCU protected to allow dereferences
22229c91e99STejun Heo 	 * from get_work_pool().
22329c91e99STejun Heo 	 */
22429c91e99STejun Heo 	struct rcu_head		rcu;
22584f91c62SLai Jiangshan };
2268b03ae3cSTejun Heo 
2278b03ae3cSTejun Heo /*
228725e8ec5STejun Heo  * Per-pool_workqueue statistics. These can be monitored using
229725e8ec5STejun Heo  * tools/workqueue/wq_monitor.py.
230725e8ec5STejun Heo  */
231725e8ec5STejun Heo enum pool_workqueue_stats {
232725e8ec5STejun Heo 	PWQ_STAT_STARTED,	/* work items started execution */
233725e8ec5STejun Heo 	PWQ_STAT_COMPLETED,	/* work items completed execution */
2348a1dd1e5STejun Heo 	PWQ_STAT_CPU_TIME,	/* total CPU time consumed */
235616db877STejun Heo 	PWQ_STAT_CPU_INTENSIVE,	/* wq_cpu_intensive_thresh_us violations */
236725e8ec5STejun Heo 	PWQ_STAT_CM_WAKEUP,	/* concurrency-management worker wakeups */
2378639ecebSTejun Heo 	PWQ_STAT_REPATRIATED,	/* unbound workers brought back into scope */
238725e8ec5STejun Heo 	PWQ_STAT_MAYDAY,	/* maydays to rescuer */
239725e8ec5STejun Heo 	PWQ_STAT_RESCUED,	/* linked work items executed by rescuer */
240725e8ec5STejun Heo 
241725e8ec5STejun Heo 	PWQ_NR_STATS,
242725e8ec5STejun Heo };
243725e8ec5STejun Heo 
244725e8ec5STejun Heo /*
245112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
246112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
247112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
248112202d9STejun Heo  * number of flag bits.
2491da177e4SLinus Torvalds  */
250112202d9STejun Heo struct pool_workqueue {
251bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2524690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
25373f53c4aSTejun Heo 	int			work_color;	/* L: current color */
25473f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2558864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
25673f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
25773f53c4aSTejun Heo 						/* L: nr of in_flight works */
2584c065dbcSWaiman Long 	bool			plugged;	/* L: execution suspended */
259018f3a13SLai Jiangshan 
260018f3a13SLai Jiangshan 	/*
261018f3a13SLai Jiangshan 	 * nr_active management and WORK_STRUCT_INACTIVE:
262018f3a13SLai Jiangshan 	 *
263018f3a13SLai Jiangshan 	 * When pwq->nr_active >= max_active, new work item is queued to
264018f3a13SLai Jiangshan 	 * pwq->inactive_works instead of pool->worklist and marked with
265018f3a13SLai Jiangshan 	 * WORK_STRUCT_INACTIVE.
266018f3a13SLai Jiangshan 	 *
2675797b1c1STejun Heo 	 * All work items marked with WORK_STRUCT_INACTIVE do not participate in
2685797b1c1STejun Heo 	 * nr_active and all work items in pwq->inactive_works are marked with
2695797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE work items are
2705797b1c1STejun Heo 	 * in pwq->inactive_works. Some of them are ready to run in
2715797b1c1STejun Heo 	 * pool->worklist or worker->scheduled. Those work itmes are only struct
2725797b1c1STejun Heo 	 * wq_barrier which is used for flush_work() and should not participate
2735797b1c1STejun Heo 	 * in nr_active. For non-barrier work item, it is marked with
2745797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
275018f3a13SLai Jiangshan 	 */
2761e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
277f97a4a1aSLai Jiangshan 	struct list_head	inactive_works;	/* L: inactive works */
2785797b1c1STejun Heo 	struct list_head	pending_node;	/* LN: node on wq_node_nr_active->pending_pwqs */
2793c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2802e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2818864b4e5STejun Heo 
282725e8ec5STejun Heo 	u64			stats[PWQ_NR_STATS];
283725e8ec5STejun Heo 
2848864b4e5STejun Heo 	/*
285967b494eSTejun Heo 	 * Release of unbound pwq is punted to a kthread_worker. See put_pwq()
286687a9aa5STejun Heo 	 * and pwq_release_workfn() for details. pool_workqueue itself is also
287687a9aa5STejun Heo 	 * RCU protected so that the first pwq can be determined without
288967b494eSTejun Heo 	 * grabbing wq->mutex.
2898864b4e5STejun Heo 	 */
290687a9aa5STejun Heo 	struct kthread_work	release_work;
2918864b4e5STejun Heo 	struct rcu_head		rcu;
292e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2931da177e4SLinus Torvalds 
2941da177e4SLinus Torvalds /*
29573f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
29673f53c4aSTejun Heo  */
29773f53c4aSTejun Heo struct wq_flusher {
2983c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2993c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
30073f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
30173f53c4aSTejun Heo };
3021da177e4SLinus Torvalds 
303226223abSTejun Heo struct wq_device;
304226223abSTejun Heo 
30573f53c4aSTejun Heo /*
30691ccc6e7STejun Heo  * Unlike in a per-cpu workqueue where max_active limits its concurrency level
30791ccc6e7STejun Heo  * on each CPU, in an unbound workqueue, max_active applies to the whole system.
30891ccc6e7STejun Heo  * As sharing a single nr_active across multiple sockets can be very expensive,
30991ccc6e7STejun Heo  * the counting and enforcement is per NUMA node.
3105797b1c1STejun Heo  *
3115797b1c1STejun Heo  * The following struct is used to enforce per-node max_active. When a pwq wants
3125797b1c1STejun Heo  * to start executing a work item, it should increment ->nr using
3135797b1c1STejun Heo  * tryinc_node_nr_active(). If acquisition fails due to ->nr already being over
3145797b1c1STejun Heo  * ->max, the pwq is queued on ->pending_pwqs. As in-flight work items finish
3155797b1c1STejun Heo  * and decrement ->nr, node_activate_pending_pwq() activates the pending pwqs in
3165797b1c1STejun Heo  * round-robin order.
31791ccc6e7STejun Heo  */
31891ccc6e7STejun Heo struct wq_node_nr_active {
3195797b1c1STejun Heo 	int			max;		/* per-node max_active */
3205797b1c1STejun Heo 	atomic_t		nr;		/* per-node nr_active */
3215797b1c1STejun Heo 	raw_spinlock_t		lock;		/* nests inside pool locks */
3225797b1c1STejun Heo 	struct list_head	pending_pwqs;	/* LN: pwqs with inactive works */
32391ccc6e7STejun Heo };
32491ccc6e7STejun Heo 
32591ccc6e7STejun Heo /*
326c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
327c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
3281da177e4SLinus Torvalds  */
3291da177e4SLinus Torvalds struct workqueue_struct {
3303c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
331e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
33273f53c4aSTejun Heo 
3333c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
3343c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
3353c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
336112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
3373c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
3383c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
3393c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
34073f53c4aSTejun Heo 
3412e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
34230ae2fc0STejun Heo 	struct worker		*rescuer;	/* MD: rescue worker */
343e22bee78STejun Heo 
34487fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
3455797b1c1STejun Heo 
3465797b1c1STejun Heo 	/* See alloc_workqueue() function comment for info on min/max_active */
347a045a272STejun Heo 	int			max_active;	/* WO: max active works */
3485797b1c1STejun Heo 	int			min_active;	/* WO: min active works */
349a045a272STejun Heo 	int			saved_max_active; /* WQ: saved max_active */
3505797b1c1STejun Heo 	int			saved_min_active; /* WQ: saved min_active */
351226223abSTejun Heo 
3525b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
3539f66cff2STejun Heo 	struct pool_workqueue __rcu *dfl_pwq;   /* PW: only for unbound wqs */
3546029a918STejun Heo 
355226223abSTejun Heo #ifdef CONFIG_SYSFS
356226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
357226223abSTejun Heo #endif
3584e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
359669de8bdSBart Van Assche 	char			*lock_name;
360669de8bdSBart Van Assche 	struct lock_class_key	key;
3614e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
3624e6045f1SJohannes Berg #endif
363ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
3642728fd2fSTejun Heo 
365e2dca7adSTejun Heo 	/*
36624acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
36724acfb71SThomas Gleixner 	 * the workqueues list without grabbing wq_pool_mutex.
368e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
369e2dca7adSTejun Heo 	 */
370e2dca7adSTejun Heo 	struct rcu_head		rcu;
371e2dca7adSTejun Heo 
3722728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
3732728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
374636b927eSTejun Heo 	struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */
37591ccc6e7STejun Heo 	struct wq_node_nr_active *node_nr_active[]; /* I: per-node nr_active */
3761da177e4SLinus Torvalds };
3771da177e4SLinus Torvalds 
378e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
379e904e6c2STejun Heo 
38084193c07STejun Heo /*
38184193c07STejun Heo  * Each pod type describes how CPUs should be grouped for unbound workqueues.
38284193c07STejun Heo  * See the comment above workqueue_attrs->affn_scope.
38384193c07STejun Heo  */
38484193c07STejun Heo struct wq_pod_type {
38584193c07STejun Heo 	int			nr_pods;	/* number of pods */
38684193c07STejun Heo 	cpumask_var_t		*pod_cpus;	/* pod -> cpus */
38784193c07STejun Heo 	int			*pod_node;	/* pod -> node */
38884193c07STejun Heo 	int			*cpu_pod;	/* cpu -> pod */
38984193c07STejun Heo };
39084193c07STejun Heo 
39184193c07STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES];
392523a301eSTejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE;
39363c5484eSTejun Heo 
39463c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = {
395523a301eSTejun Heo 	[WQ_AFFN_DFL]			= "default",
39663c5484eSTejun Heo 	[WQ_AFFN_CPU]			= "cpu",
39763c5484eSTejun Heo 	[WQ_AFFN_SMT]			= "smt",
39863c5484eSTejun Heo 	[WQ_AFFN_CACHE]			= "cache",
39963c5484eSTejun Heo 	[WQ_AFFN_NUMA]			= "numa",
40063c5484eSTejun Heo 	[WQ_AFFN_SYSTEM]		= "system",
40163c5484eSTejun Heo };
402bce90380STejun Heo 
403c5f8cd6cSTejun Heo static bool wq_topo_initialized __read_mostly = false;
404c5f8cd6cSTejun Heo 
405616db877STejun Heo /*
406616db877STejun Heo  * Per-cpu work items which run for longer than the following threshold are
407616db877STejun Heo  * automatically considered CPU intensive and excluded from concurrency
408616db877STejun Heo  * management to prevent them from noticeably delaying other per-cpu work items.
409aa6fde93STejun Heo  * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter.
410aa6fde93STejun Heo  * The actual value is initialized in wq_cpu_intensive_thresh_init().
411616db877STejun Heo  */
412aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX;
413616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644);
414616db877STejun Heo 
415cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
416552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
417cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
418cee22a15SViresh Kumar 
419863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
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 
4604cb1ef64STejun Heo /* the BH worker pools */
4614cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
4624cb1ef64STejun Heo 				     bh_worker_pools);
4634cb1ef64STejun Heo 
4647d19c5ceSTejun Heo /* the per-cpu worker pools */
4654cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
4664cb1ef64STejun Heo 				     cpu_worker_pools);
4677d19c5ceSTejun Heo 
46868e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
4697d19c5ceSTejun Heo 
47068e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
47129c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
47229c91e99STejun Heo 
473c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
47429c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
47529c91e99STejun Heo 
4768a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
4778a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
4788a2b7538STejun Heo 
479967b494eSTejun Heo /*
480967b494eSTejun Heo  * I: kthread_worker to release pwq's. pwq release needs to be bounced to a
481967b494eSTejun Heo  * process context while holding a pool lock. Bounce to a dedicated kthread
482967b494eSTejun Heo  * worker to avoid A-A deadlocks.
483967b494eSTejun Heo  */
48468279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init;
485967b494eSTejun Heo 
48668279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init;
487ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
48868279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init;
4891aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
49068279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init;
491d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
49268279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init;
493f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
49468279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init;
49524d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
49668279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init;
4970668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
49868279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init;
4990668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
5004cb1ef64STejun Heo struct workqueue_struct *system_bh_wq;
5014cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_wq);
5024cb1ef64STejun Heo struct workqueue_struct *system_bh_highpri_wq;
5034cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_highpri_wq);
504d320c038STejun Heo 
5057d19c5ceSTejun Heo static int worker_thread(void *__worker);
5066ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
507c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq);
50855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool);
5097d19c5ceSTejun Heo 
51097bd2347STejun Heo #define CREATE_TRACE_POINTS
51197bd2347STejun Heo #include <trace/events/workqueue.h>
51297bd2347STejun Heo 
51368e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
51424acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
515f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
51624acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
5175bcab335STejun Heo 
5185b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
51924acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
520f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
521f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
52224acfb71SThomas Gleixner 			 "RCU, wq->mutex or wq_pool_mutex should be held")
5235b95e1afSLai Jiangshan 
5244cb1ef64STejun Heo #define for_each_bh_worker_pool(pool, cpu)				\
5254cb1ef64STejun Heo 	for ((pool) = &per_cpu(bh_worker_pools, cpu)[0];		\
5264cb1ef64STejun Heo 	     (pool) < &per_cpu(bh_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5274cb1ef64STejun Heo 	     (pool)++)
5284cb1ef64STejun Heo 
529f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
530f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
531f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5327a62c2c8STejun Heo 	     (pool)++)
5334ce62e9eSTejun Heo 
53449e3cf44STejun Heo /**
53517116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
53617116969STejun Heo  * @pool: iteration cursor
537611c92a0STejun Heo  * @pi: integer used for iteration
538fa1b54e6STejun Heo  *
53924acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or RCU read
54068e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
54168e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
542fa1b54e6STejun Heo  *
543fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
544fa1b54e6STejun Heo  * ignored.
54517116969STejun Heo  */
546611c92a0STejun Heo #define for_each_pool(pool, pi)						\
547611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
54868e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
549fa1b54e6STejun Heo 		else
55017116969STejun Heo 
55117116969STejun Heo /**
552822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
553822d8405STejun Heo  * @worker: iteration cursor
554822d8405STejun Heo  * @pool: worker_pool to iterate workers of
555822d8405STejun Heo  *
5561258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
557822d8405STejun Heo  *
558822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
559822d8405STejun Heo  * ignored.
560822d8405STejun Heo  */
561da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
562da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
5631258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
564822d8405STejun Heo 		else
565822d8405STejun Heo 
566822d8405STejun Heo /**
56749e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
56849e3cf44STejun Heo  * @pwq: iteration cursor
56949e3cf44STejun Heo  * @wq: the target workqueue
57076af4d93STejun Heo  *
57124acfb71SThomas Gleixner  * This must be called either with wq->mutex held or RCU read locked.
572794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
573794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
57476af4d93STejun Heo  *
57576af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
57676af4d93STejun Heo  * ignored.
57749e3cf44STejun Heo  */
57849e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
57949e9d1a9SSebastian Andrzej Siewior 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node,		\
5805a644662SJoel Fernandes (Google) 				 lockdep_is_held(&(wq->mutex)))
581f3421797STejun Heo 
582dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
583dc186ad7SThomas Gleixner 
584f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr;
585dc186ad7SThomas Gleixner 
58699777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
58799777288SStanislaw Gruszka {
58899777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
58999777288SStanislaw Gruszka }
59099777288SStanislaw Gruszka 
591b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
592b9fdac7fSDu, Changbin {
593b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
594b9fdac7fSDu, Changbin 
595b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
596b9fdac7fSDu, Changbin }
597b9fdac7fSDu, Changbin 
598dc186ad7SThomas Gleixner /*
599dc186ad7SThomas Gleixner  * fixup_init is called when:
600dc186ad7SThomas Gleixner  * - an active object is initialized
601dc186ad7SThomas Gleixner  */
60202a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
603dc186ad7SThomas Gleixner {
604dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
605dc186ad7SThomas Gleixner 
606dc186ad7SThomas Gleixner 	switch (state) {
607dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
608dc186ad7SThomas Gleixner 		cancel_work_sync(work);
609dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
61002a982a6SDu, Changbin 		return true;
611dc186ad7SThomas Gleixner 	default:
61202a982a6SDu, Changbin 		return false;
613dc186ad7SThomas Gleixner 	}
614dc186ad7SThomas Gleixner }
615dc186ad7SThomas Gleixner 
616dc186ad7SThomas Gleixner /*
617dc186ad7SThomas Gleixner  * fixup_free is called when:
618dc186ad7SThomas Gleixner  * - an active object is freed
619dc186ad7SThomas Gleixner  */
62002a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
621dc186ad7SThomas Gleixner {
622dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
623dc186ad7SThomas Gleixner 
624dc186ad7SThomas Gleixner 	switch (state) {
625dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
626dc186ad7SThomas Gleixner 		cancel_work_sync(work);
627dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
62802a982a6SDu, Changbin 		return true;
629dc186ad7SThomas Gleixner 	default:
63002a982a6SDu, Changbin 		return false;
631dc186ad7SThomas Gleixner 	}
632dc186ad7SThomas Gleixner }
633dc186ad7SThomas Gleixner 
634f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = {
635dc186ad7SThomas Gleixner 	.name		= "work_struct",
63699777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
637b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
638dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
639dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
640dc186ad7SThomas Gleixner };
641dc186ad7SThomas Gleixner 
642dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
643dc186ad7SThomas Gleixner {
644dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
645dc186ad7SThomas Gleixner }
646dc186ad7SThomas Gleixner 
647dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
648dc186ad7SThomas Gleixner {
649dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
650dc186ad7SThomas Gleixner }
651dc186ad7SThomas Gleixner 
652dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
653dc186ad7SThomas Gleixner {
654dc186ad7SThomas Gleixner 	if (onstack)
655dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
656dc186ad7SThomas Gleixner 	else
657dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
658dc186ad7SThomas Gleixner }
659dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
660dc186ad7SThomas Gleixner 
661dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
662dc186ad7SThomas Gleixner {
663dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
664dc186ad7SThomas Gleixner }
665dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
666dc186ad7SThomas Gleixner 
667ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
668ea2e64f2SThomas Gleixner {
669ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
670ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
671ea2e64f2SThomas Gleixner }
672ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
673ea2e64f2SThomas Gleixner 
674dc186ad7SThomas Gleixner #else
675dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
676dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
677dc186ad7SThomas Gleixner #endif
678dc186ad7SThomas Gleixner 
6794e8b22bdSLi Bin /**
68067dc8325SCai Huoqing  * worker_pool_assign_id - allocate ID and assign it to @pool
6814e8b22bdSLi Bin  * @pool: the pool pointer of interest
6824e8b22bdSLi Bin  *
6834e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
6844e8b22bdSLi Bin  * successfully, -errno on failure.
6854e8b22bdSLi Bin  */
6869daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
6879daf9e67STejun Heo {
6889daf9e67STejun Heo 	int ret;
6899daf9e67STejun Heo 
69068e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6915bcab335STejun Heo 
6924e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
6934e8b22bdSLi Bin 			GFP_KERNEL);
694229641a6STejun Heo 	if (ret >= 0) {
695e68035fbSTejun Heo 		pool->id = ret;
696229641a6STejun Heo 		return 0;
697229641a6STejun Heo 	}
6989daf9e67STejun Heo 	return ret;
6999daf9e67STejun Heo }
7009daf9e67STejun Heo 
7019f66cff2STejun Heo static struct pool_workqueue __rcu **
7029f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu)
7039f66cff2STejun Heo {
7049f66cff2STejun Heo        if (cpu >= 0)
7059f66cff2STejun Heo                return per_cpu_ptr(wq->cpu_pwq, cpu);
7069f66cff2STejun Heo        else
7079f66cff2STejun Heo                return &wq->dfl_pwq;
7089f66cff2STejun Heo }
7099f66cff2STejun Heo 
7109f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */
7119f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu)
7129f66cff2STejun Heo {
7139f66cff2STejun Heo 	return rcu_dereference_check(*unbound_pwq_slot(wq, cpu),
7149f66cff2STejun Heo 				     lockdep_is_held(&wq_pool_mutex) ||
7159f66cff2STejun Heo 				     lockdep_is_held(&wq->mutex));
7169f66cff2STejun Heo }
7179f66cff2STejun Heo 
7185797b1c1STejun Heo /**
7195797b1c1STejun Heo  * unbound_effective_cpumask - effective cpumask of an unbound workqueue
7205797b1c1STejun Heo  * @wq: workqueue of interest
7215797b1c1STejun Heo  *
7225797b1c1STejun Heo  * @wq->unbound_attrs->cpumask contains the cpumask requested by the user which
7235797b1c1STejun Heo  * is masked with wq_unbound_cpumask to determine the effective cpumask. The
7245797b1c1STejun Heo  * default pwq is always mapped to the pool with the current effective cpumask.
7255797b1c1STejun Heo  */
7265797b1c1STejun Heo static struct cpumask *unbound_effective_cpumask(struct workqueue_struct *wq)
7275797b1c1STejun Heo {
7285797b1c1STejun Heo 	return unbound_pwq(wq, -1)->pool->attrs->__pod_cpumask;
7295797b1c1STejun Heo }
7305797b1c1STejun Heo 
73173f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
73273f53c4aSTejun Heo {
73373f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
73473f53c4aSTejun Heo }
73573f53c4aSTejun Heo 
736c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data)
73773f53c4aSTejun Heo {
738c4560c2cSLai Jiangshan 	return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
73973f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
74073f53c4aSTejun Heo }
74173f53c4aSTejun Heo 
74273f53c4aSTejun Heo static int work_next_color(int color)
74373f53c4aSTejun Heo {
74473f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
745a848e3b6SOleg Nesterov }
746a848e3b6SOleg Nesterov 
7474594bf15SDavid Howells /*
748112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
749112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
7507c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
7517a22ad75STejun Heo  *
752112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
753112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
754bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
755bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
7567a22ad75STejun Heo  *
757112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7587c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
759112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
7607c3eed5cSTejun Heo  * available only while the work item is queued.
761bbb68dfaSTejun Heo  *
762bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
763bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
764bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
765bbb68dfaSTejun Heo  * try to steal the PENDING bit.
7664594bf15SDavid Howells  */
7677a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
7687a22ad75STejun Heo 				 unsigned long flags)
7697a22ad75STejun Heo {
7706183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
7717a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
7727a22ad75STejun Heo }
7737a22ad75STejun Heo 
774112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
7754690c4abSTejun Heo 			 unsigned long extra_flags)
776365970a1SDavid Howells {
777112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
778112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
779365970a1SDavid Howells }
780365970a1SDavid Howells 
7814468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
7824468a00fSLai Jiangshan 					   int pool_id)
7834468a00fSLai Jiangshan {
7844468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
7854468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
7864468a00fSLai Jiangshan }
7874468a00fSLai Jiangshan 
7887c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
7897c3eed5cSTejun Heo 					    int pool_id)
7904d707b9fSOleg Nesterov {
79123657bb1STejun Heo 	/*
79223657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
79323657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
79423657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
79523657bb1STejun Heo 	 * owner.
79623657bb1STejun Heo 	 */
79723657bb1STejun Heo 	smp_wmb();
7987c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
799346c09f8SRoman Pen 	/*
800346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
801346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
802346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
8038bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
804346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
805346c09f8SRoman Pen 	 *
806346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
807346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
808346c09f8SRoman Pen 	 *
809346c09f8SRoman Pen 	 * 1  STORE event_indicated
810346c09f8SRoman Pen 	 * 2  queue_work_on() {
811346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
812346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
813346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
814346c09f8SRoman Pen 	 * 6                                 smp_mb()
815346c09f8SRoman Pen 	 * 7                               work->current_func() {
816346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
817346c09f8SRoman Pen 	 *				   }
818346c09f8SRoman Pen 	 *
819346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
820346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
821346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
822346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
823346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
824346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
825346c09f8SRoman Pen 	 * before actual STORE.
826346c09f8SRoman Pen 	 */
827346c09f8SRoman Pen 	smp_mb();
8284d707b9fSOleg Nesterov }
8294d707b9fSOleg Nesterov 
8307a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
831365970a1SDavid Howells {
8327c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
8337c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
8347a22ad75STejun Heo }
8357a22ad75STejun Heo 
836afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data)
837afa4bb77SLinus Torvalds {
838afa4bb77SLinus Torvalds 	return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK);
839afa4bb77SLinus Torvalds }
840afa4bb77SLinus Torvalds 
841112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
8427a22ad75STejun Heo {
843e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8447a22ad75STejun Heo 
845112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
846afa4bb77SLinus Torvalds 		return work_struct_pwq(data);
847e120153dSTejun Heo 	else
848e120153dSTejun Heo 		return NULL;
8497a22ad75STejun Heo }
8507a22ad75STejun Heo 
8517c3eed5cSTejun Heo /**
8527c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
8537c3eed5cSTejun Heo  * @work: the work item of interest
8547c3eed5cSTejun Heo  *
85568e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
85624acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
85724acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
858fa1b54e6STejun Heo  *
859fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
860fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
861fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
862fa1b54e6STejun Heo  * returned pool is and stays online.
863d185af30SYacine Belkadi  *
864d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
8657c3eed5cSTejun Heo  */
8667c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
8677a22ad75STejun Heo {
868e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8697c3eed5cSTejun Heo 	int pool_id;
8707a22ad75STejun Heo 
87168e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
872fa1b54e6STejun Heo 
873112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
874afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool;
8757a22ad75STejun Heo 
8767c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
8777c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
8787a22ad75STejun Heo 		return NULL;
8797a22ad75STejun Heo 
880fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
8817c3eed5cSTejun Heo }
8827c3eed5cSTejun Heo 
8837c3eed5cSTejun Heo /**
8847c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
8857c3eed5cSTejun Heo  * @work: the work item of interest
8867c3eed5cSTejun Heo  *
887d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
8887c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
8897c3eed5cSTejun Heo  */
8907c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
8917c3eed5cSTejun Heo {
89254d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
8937c3eed5cSTejun Heo 
894112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
895afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool->id;
89654d5b7d0SLai Jiangshan 
89754d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
8987c3eed5cSTejun Heo }
8997c3eed5cSTejun Heo 
900bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
901bbb68dfaSTejun Heo {
9027c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
903bbb68dfaSTejun Heo 
9047c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
9057c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
906bbb68dfaSTejun Heo }
907bbb68dfaSTejun Heo 
908bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
909bbb68dfaSTejun Heo {
910bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
911bbb68dfaSTejun Heo 
912112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
913bbb68dfaSTejun Heo }
914bbb68dfaSTejun Heo 
915e22bee78STejun Heo /*
9163270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
9173270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
918d565ed63STejun Heo  * they're being called with pool->lock held.
919e22bee78STejun Heo  */
920e22bee78STejun Heo 
921e22bee78STejun Heo /*
922e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
923e22bee78STejun Heo  * running workers.
924974271c4STejun Heo  *
925974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
926706026c2STejun Heo  * function will always return %true for unbound pools as long as the
927974271c4STejun Heo  * worklist isn't empty.
928e22bee78STejun Heo  */
92963d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
930e22bee78STejun Heo {
9310219a352STejun Heo 	return !list_empty(&pool->worklist) && !pool->nr_running;
932e22bee78STejun Heo }
933e22bee78STejun Heo 
934e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
93563d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
936e22bee78STejun Heo {
93763d95a91STejun Heo 	return pool->nr_idle;
938e22bee78STejun Heo }
939e22bee78STejun Heo 
940e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
94163d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
942e22bee78STejun Heo {
943bc35f7efSLai Jiangshan 	return !list_empty(&pool->worklist) && (pool->nr_running <= 1);
944e22bee78STejun Heo }
945e22bee78STejun Heo 
946e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
94763d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
948e22bee78STejun Heo {
94963d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
950e22bee78STejun Heo }
951e22bee78STejun Heo 
952e22bee78STejun Heo /* Do we have too many workers and should some go away? */
95363d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
954e22bee78STejun Heo {
955692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
95663d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
95763d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
958e22bee78STejun Heo 
959e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
960e22bee78STejun Heo }
961e22bee78STejun Heo 
9624690c4abSTejun Heo /**
963e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
964cb444766STejun Heo  * @worker: self
965d302f017STejun Heo  * @flags: flags to set
966d302f017STejun Heo  *
967228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
968d302f017STejun Heo  */
969228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
970d302f017STejun Heo {
971bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
972e22bee78STejun Heo 
973bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
974cb444766STejun Heo 
975228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
976e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
977e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
978bc35f7efSLai Jiangshan 		pool->nr_running--;
979e22bee78STejun Heo 	}
980e22bee78STejun Heo 
981d302f017STejun Heo 	worker->flags |= flags;
982d302f017STejun Heo }
983d302f017STejun Heo 
984d302f017STejun Heo /**
985e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
986cb444766STejun Heo  * @worker: self
987d302f017STejun Heo  * @flags: flags to clear
988d302f017STejun Heo  *
989e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
990d302f017STejun Heo  */
991d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
992d302f017STejun Heo {
99363d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
994e22bee78STejun Heo 	unsigned int oflags = worker->flags;
995e22bee78STejun Heo 
996bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
997cb444766STejun Heo 
998d302f017STejun Heo 	worker->flags &= ~flags;
999e22bee78STejun Heo 
100042c025f3STejun Heo 	/*
100142c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
100242c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
100342c025f3STejun Heo 	 * of multiple flags, not a single flag.
100442c025f3STejun Heo 	 */
1005e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1006e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
1007bc35f7efSLai Jiangshan 			pool->nr_running++;
1008d302f017STejun Heo }
1009d302f017STejun Heo 
1010797e8345STejun Heo /* Return the first idle worker.  Called with pool->lock held. */
1011797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool)
1012797e8345STejun Heo {
1013797e8345STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
1014797e8345STejun Heo 		return NULL;
1015797e8345STejun Heo 
1016797e8345STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
1017797e8345STejun Heo }
1018797e8345STejun Heo 
1019797e8345STejun Heo /**
1020797e8345STejun Heo  * worker_enter_idle - enter idle state
1021797e8345STejun Heo  * @worker: worker which is entering idle state
1022797e8345STejun Heo  *
1023797e8345STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1024797e8345STejun Heo  * necessary.
1025797e8345STejun Heo  *
1026797e8345STejun Heo  * LOCKING:
1027797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1028797e8345STejun Heo  */
1029797e8345STejun Heo static void worker_enter_idle(struct worker *worker)
1030797e8345STejun Heo {
1031797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1032797e8345STejun Heo 
1033797e8345STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1034797e8345STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
1035797e8345STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
1036797e8345STejun Heo 		return;
1037797e8345STejun Heo 
1038797e8345STejun Heo 	/* can't use worker_set_flags(), also called from create_worker() */
1039797e8345STejun Heo 	worker->flags |= WORKER_IDLE;
1040797e8345STejun Heo 	pool->nr_idle++;
1041797e8345STejun Heo 	worker->last_active = jiffies;
1042797e8345STejun Heo 
1043797e8345STejun Heo 	/* idle_list is LIFO */
1044797e8345STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1045797e8345STejun Heo 
1046797e8345STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1047797e8345STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1048797e8345STejun Heo 
1049797e8345STejun Heo 	/* Sanity check nr_running. */
1050797e8345STejun Heo 	WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running);
1051797e8345STejun Heo }
1052797e8345STejun Heo 
1053797e8345STejun Heo /**
1054797e8345STejun Heo  * worker_leave_idle - leave idle state
1055797e8345STejun Heo  * @worker: worker which is leaving idle state
1056797e8345STejun Heo  *
1057797e8345STejun Heo  * @worker is leaving idle state.  Update stats.
1058797e8345STejun Heo  *
1059797e8345STejun Heo  * LOCKING:
1060797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1061797e8345STejun Heo  */
1062797e8345STejun Heo static void worker_leave_idle(struct worker *worker)
1063797e8345STejun Heo {
1064797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1065797e8345STejun Heo 
1066797e8345STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1067797e8345STejun Heo 		return;
1068797e8345STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1069797e8345STejun Heo 	pool->nr_idle--;
1070797e8345STejun Heo 	list_del_init(&worker->entry);
1071797e8345STejun Heo }
1072797e8345STejun Heo 
1073797e8345STejun Heo /**
1074797e8345STejun Heo  * find_worker_executing_work - find worker which is executing a work
1075797e8345STejun Heo  * @pool: pool of interest
1076797e8345STejun Heo  * @work: work to find worker for
1077797e8345STejun Heo  *
1078797e8345STejun Heo  * Find a worker which is executing @work on @pool by searching
1079797e8345STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
1080797e8345STejun Heo  * to match, its current execution should match the address of @work and
1081797e8345STejun Heo  * its work function.  This is to avoid unwanted dependency between
1082797e8345STejun Heo  * unrelated work executions through a work item being recycled while still
1083797e8345STejun Heo  * being executed.
1084797e8345STejun Heo  *
1085797e8345STejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1086797e8345STejun Heo  * starts and nothing prevents the freed area from being recycled for
1087797e8345STejun Heo  * another work item.  If the same work item address ends up being reused
1088797e8345STejun Heo  * before the original execution finishes, workqueue will identify the
1089797e8345STejun Heo  * recycled work item as currently executing and make it wait until the
1090797e8345STejun Heo  * current execution finishes, introducing an unwanted dependency.
1091797e8345STejun Heo  *
1092797e8345STejun Heo  * This function checks the work item address and work function to avoid
1093797e8345STejun Heo  * false positives.  Note that this isn't complete as one may construct a
1094797e8345STejun Heo  * work function which can introduce dependency onto itself through a
1095797e8345STejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1096797e8345STejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1097797e8345STejun Heo  * actually occurs, it should be easy to locate the culprit work function.
1098797e8345STejun Heo  *
1099797e8345STejun Heo  * CONTEXT:
1100797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1101797e8345STejun Heo  *
1102797e8345STejun Heo  * Return:
1103797e8345STejun Heo  * Pointer to worker which is executing @work if found, %NULL
1104797e8345STejun Heo  * otherwise.
1105797e8345STejun Heo  */
1106797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
1107797e8345STejun Heo 						 struct work_struct *work)
1108797e8345STejun Heo {
1109797e8345STejun Heo 	struct worker *worker;
1110797e8345STejun Heo 
1111797e8345STejun Heo 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1112797e8345STejun Heo 			       (unsigned long)work)
1113797e8345STejun Heo 		if (worker->current_work == work &&
1114797e8345STejun Heo 		    worker->current_func == work->func)
1115797e8345STejun Heo 			return worker;
1116797e8345STejun Heo 
1117797e8345STejun Heo 	return NULL;
1118797e8345STejun Heo }
1119797e8345STejun Heo 
1120797e8345STejun Heo /**
1121797e8345STejun Heo  * move_linked_works - move linked works to a list
1122797e8345STejun Heo  * @work: start of series of works to be scheduled
1123797e8345STejun Heo  * @head: target list to append @work to
1124797e8345STejun Heo  * @nextp: out parameter for nested worklist walking
1125797e8345STejun Heo  *
1126873eaca6STejun Heo  * Schedule linked works starting from @work to @head. Work series to be
1127873eaca6STejun Heo  * scheduled starts at @work and includes any consecutive work with
1128873eaca6STejun Heo  * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on
1129873eaca6STejun Heo  * @nextp.
1130797e8345STejun Heo  *
1131797e8345STejun Heo  * CONTEXT:
1132797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1133797e8345STejun Heo  */
1134797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1135797e8345STejun Heo 			      struct work_struct **nextp)
1136797e8345STejun Heo {
1137797e8345STejun Heo 	struct work_struct *n;
1138797e8345STejun Heo 
1139797e8345STejun Heo 	/*
1140797e8345STejun Heo 	 * Linked worklist will always end before the end of the list,
1141797e8345STejun Heo 	 * use NULL for list head.
1142797e8345STejun Heo 	 */
1143797e8345STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1144797e8345STejun Heo 		list_move_tail(&work->entry, head);
1145797e8345STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1146797e8345STejun Heo 			break;
1147797e8345STejun Heo 	}
1148797e8345STejun Heo 
1149797e8345STejun Heo 	/*
1150797e8345STejun Heo 	 * If we're already inside safe list traversal and have moved
1151797e8345STejun Heo 	 * multiple works to the scheduled queue, the next position
1152797e8345STejun Heo 	 * needs to be updated.
1153797e8345STejun Heo 	 */
1154797e8345STejun Heo 	if (nextp)
1155797e8345STejun Heo 		*nextp = n;
1156797e8345STejun Heo }
1157797e8345STejun Heo 
1158797e8345STejun Heo /**
1159873eaca6STejun Heo  * assign_work - assign a work item and its linked work items to a worker
1160873eaca6STejun Heo  * @work: work to assign
1161873eaca6STejun Heo  * @worker: worker to assign to
1162873eaca6STejun Heo  * @nextp: out parameter for nested worklist walking
1163873eaca6STejun Heo  *
1164873eaca6STejun Heo  * Assign @work and its linked work items to @worker. If @work is already being
1165873eaca6STejun Heo  * executed by another worker in the same pool, it'll be punted there.
1166873eaca6STejun Heo  *
1167873eaca6STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of the last
1168873eaca6STejun Heo  * scheduled work. This allows assign_work() to be nested inside
1169873eaca6STejun Heo  * list_for_each_entry_safe().
1170873eaca6STejun Heo  *
1171873eaca6STejun Heo  * Returns %true if @work was successfully assigned to @worker. %false if @work
1172873eaca6STejun Heo  * was punted to another worker already executing it.
1173873eaca6STejun Heo  */
1174873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker,
1175873eaca6STejun Heo 			struct work_struct **nextp)
1176873eaca6STejun Heo {
1177873eaca6STejun Heo 	struct worker_pool *pool = worker->pool;
1178873eaca6STejun Heo 	struct worker *collision;
1179873eaca6STejun Heo 
1180873eaca6STejun Heo 	lockdep_assert_held(&pool->lock);
1181873eaca6STejun Heo 
1182873eaca6STejun Heo 	/*
1183873eaca6STejun Heo 	 * A single work shouldn't be executed concurrently by multiple workers.
1184873eaca6STejun Heo 	 * __queue_work() ensures that @work doesn't jump to a different pool
1185873eaca6STejun Heo 	 * while still running in the previous pool. Here, we should ensure that
1186873eaca6STejun Heo 	 * @work is not executed concurrently by multiple workers from the same
1187873eaca6STejun Heo 	 * pool. Check whether anyone is already processing the work. If so,
1188873eaca6STejun Heo 	 * defer the work to the currently executing one.
1189873eaca6STejun Heo 	 */
1190873eaca6STejun Heo 	collision = find_worker_executing_work(pool, work);
1191873eaca6STejun Heo 	if (unlikely(collision)) {
1192873eaca6STejun Heo 		move_linked_works(work, &collision->scheduled, nextp);
1193873eaca6STejun Heo 		return false;
1194873eaca6STejun Heo 	}
1195873eaca6STejun Heo 
1196873eaca6STejun Heo 	move_linked_works(work, &worker->scheduled, nextp);
1197873eaca6STejun Heo 	return true;
1198873eaca6STejun Heo }
1199873eaca6STejun Heo 
1200873eaca6STejun Heo /**
12010219a352STejun Heo  * kick_pool - wake up an idle worker if necessary
12020219a352STejun Heo  * @pool: pool to kick
1203797e8345STejun Heo  *
12040219a352STejun Heo  * @pool may have pending work items. Wake up worker if necessary. Returns
12050219a352STejun Heo  * whether a worker was woken up.
1206797e8345STejun Heo  */
12070219a352STejun Heo static bool kick_pool(struct worker_pool *pool)
1208797e8345STejun Heo {
1209797e8345STejun Heo 	struct worker *worker = first_idle_worker(pool);
12108639ecebSTejun Heo 	struct task_struct *p;
1211797e8345STejun Heo 
12120219a352STejun Heo 	lockdep_assert_held(&pool->lock);
12130219a352STejun Heo 
12140219a352STejun Heo 	if (!need_more_worker(pool) || !worker)
12150219a352STejun Heo 		return false;
12160219a352STejun Heo 
12174cb1ef64STejun Heo 	if (pool->flags & POOL_BH) {
12184cb1ef64STejun Heo 		if (pool->attrs->nice == HIGHPRI_NICE_LEVEL)
12194cb1ef64STejun Heo 			raise_softirq_irqoff(HI_SOFTIRQ);
12204cb1ef64STejun Heo 		else
12214cb1ef64STejun Heo 			raise_softirq_irqoff(TASKLET_SOFTIRQ);
12224cb1ef64STejun Heo 		return true;
12234cb1ef64STejun Heo 	}
12244cb1ef64STejun Heo 
12258639ecebSTejun Heo 	p = worker->task;
12268639ecebSTejun Heo 
12278639ecebSTejun Heo #ifdef CONFIG_SMP
12288639ecebSTejun Heo 	/*
12298639ecebSTejun Heo 	 * Idle @worker is about to execute @work and waking up provides an
12308639ecebSTejun Heo 	 * opportunity to migrate @worker at a lower cost by setting the task's
12318639ecebSTejun Heo 	 * wake_cpu field. Let's see if we want to move @worker to improve
12328639ecebSTejun Heo 	 * execution locality.
12338639ecebSTejun Heo 	 *
12348639ecebSTejun Heo 	 * We're waking the worker that went idle the latest and there's some
12358639ecebSTejun Heo 	 * chance that @worker is marked idle but hasn't gone off CPU yet. If
12368639ecebSTejun Heo 	 * so, setting the wake_cpu won't do anything. As this is a best-effort
12378639ecebSTejun Heo 	 * optimization and the race window is narrow, let's leave as-is for
12388639ecebSTejun Heo 	 * now. If this becomes pronounced, we can skip over workers which are
12398639ecebSTejun Heo 	 * still on cpu when picking an idle worker.
12408639ecebSTejun Heo 	 *
12418639ecebSTejun Heo 	 * If @pool has non-strict affinity, @worker might have ended up outside
12428639ecebSTejun Heo 	 * its affinity scope. Repatriate.
12438639ecebSTejun Heo 	 */
12448639ecebSTejun Heo 	if (!pool->attrs->affn_strict &&
12458639ecebSTejun Heo 	    !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) {
12468639ecebSTejun Heo 		struct work_struct *work = list_first_entry(&pool->worklist,
12478639ecebSTejun Heo 						struct work_struct, entry);
12488639ecebSTejun Heo 		p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask);
12498639ecebSTejun Heo 		get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++;
12508639ecebSTejun Heo 	}
12518639ecebSTejun Heo #endif
12528639ecebSTejun Heo 	wake_up_process(p);
12530219a352STejun Heo 	return true;
1254797e8345STejun Heo }
1255797e8345STejun Heo 
125663638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT
125763638450STejun Heo 
125863638450STejun Heo /*
125963638450STejun Heo  * Concurrency-managed per-cpu work items that hog CPU for longer than
126063638450STejun Heo  * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism,
126163638450STejun Heo  * which prevents them from stalling other concurrency-managed work items. If a
126263638450STejun Heo  * work function keeps triggering this mechanism, it's likely that the work item
126363638450STejun Heo  * should be using an unbound workqueue instead.
126463638450STejun Heo  *
126563638450STejun Heo  * wq_cpu_intensive_report() tracks work functions which trigger such conditions
126663638450STejun Heo  * and report them so that they can be examined and converted to use unbound
126763638450STejun Heo  * workqueues as appropriate. To avoid flooding the console, each violating work
126863638450STejun Heo  * function is tracked and reported with exponential backoff.
126963638450STejun Heo  */
127063638450STejun Heo #define WCI_MAX_ENTS 128
127163638450STejun Heo 
127263638450STejun Heo struct wci_ent {
127363638450STejun Heo 	work_func_t		func;
127463638450STejun Heo 	atomic64_t		cnt;
127563638450STejun Heo 	struct hlist_node	hash_node;
127663638450STejun Heo };
127763638450STejun Heo 
127863638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS];
127963638450STejun Heo static int wci_nr_ents;
128063638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock);
128163638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS));
128263638450STejun Heo 
128363638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func)
128463638450STejun Heo {
128563638450STejun Heo 	struct wci_ent *ent;
128663638450STejun Heo 
128763638450STejun Heo 	hash_for_each_possible_rcu(wci_hash, ent, hash_node,
128863638450STejun Heo 				   (unsigned long)func) {
128963638450STejun Heo 		if (ent->func == func)
129063638450STejun Heo 			return ent;
129163638450STejun Heo 	}
129263638450STejun Heo 	return NULL;
129363638450STejun Heo }
129463638450STejun Heo 
129563638450STejun Heo static void wq_cpu_intensive_report(work_func_t func)
129663638450STejun Heo {
129763638450STejun Heo 	struct wci_ent *ent;
129863638450STejun Heo 
129963638450STejun Heo restart:
130063638450STejun Heo 	ent = wci_find_ent(func);
130163638450STejun Heo 	if (ent) {
130263638450STejun Heo 		u64 cnt;
130363638450STejun Heo 
130463638450STejun Heo 		/*
130563638450STejun Heo 		 * Start reporting from the fourth time and back off
130663638450STejun Heo 		 * exponentially.
130763638450STejun Heo 		 */
130863638450STejun Heo 		cnt = atomic64_inc_return_relaxed(&ent->cnt);
130963638450STejun Heo 		if (cnt >= 4 && is_power_of_2(cnt))
131063638450STejun Heo 			printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n",
131163638450STejun Heo 					ent->func, wq_cpu_intensive_thresh_us,
131263638450STejun Heo 					atomic64_read(&ent->cnt));
131363638450STejun Heo 		return;
131463638450STejun Heo 	}
131563638450STejun Heo 
131663638450STejun Heo 	/*
131763638450STejun Heo 	 * @func is a new violation. Allocate a new entry for it. If wcn_ents[]
131863638450STejun Heo 	 * is exhausted, something went really wrong and we probably made enough
131963638450STejun Heo 	 * noise already.
132063638450STejun Heo 	 */
132163638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS)
132263638450STejun Heo 		return;
132363638450STejun Heo 
132463638450STejun Heo 	raw_spin_lock(&wci_lock);
132563638450STejun Heo 
132663638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS) {
132763638450STejun Heo 		raw_spin_unlock(&wci_lock);
132863638450STejun Heo 		return;
132963638450STejun Heo 	}
133063638450STejun Heo 
133163638450STejun Heo 	if (wci_find_ent(func)) {
133263638450STejun Heo 		raw_spin_unlock(&wci_lock);
133363638450STejun Heo 		goto restart;
133463638450STejun Heo 	}
133563638450STejun Heo 
133663638450STejun Heo 	ent = &wci_ents[wci_nr_ents++];
133763638450STejun Heo 	ent->func = func;
133863638450STejun Heo 	atomic64_set(&ent->cnt, 1);
133963638450STejun Heo 	hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func);
134063638450STejun Heo 
134163638450STejun Heo 	raw_spin_unlock(&wci_lock);
134263638450STejun Heo }
134363638450STejun Heo 
134463638450STejun Heo #else	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
134563638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {}
134663638450STejun Heo #endif	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
134763638450STejun Heo 
1348c54d5046STejun Heo /**
13491da177e4SLinus Torvalds  * wq_worker_running - a worker is running again
13501da177e4SLinus Torvalds  * @task: task waking up
13511da177e4SLinus Torvalds  *
13521da177e4SLinus Torvalds  * This function is called when a worker returns from schedule()
13531da177e4SLinus Torvalds  */
13541da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task)
13551da177e4SLinus Torvalds {
13561da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
13571da177e4SLinus Torvalds 
1358c8f6219bSZqiang 	if (!READ_ONCE(worker->sleeping))
13591da177e4SLinus Torvalds 		return;
13601da177e4SLinus Torvalds 
13611da177e4SLinus Torvalds 	/*
13621da177e4SLinus Torvalds 	 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
13631da177e4SLinus Torvalds 	 * and the nr_running increment below, we may ruin the nr_running reset
13641da177e4SLinus Torvalds 	 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
13651da177e4SLinus Torvalds 	 * pool. Protect against such race.
13661da177e4SLinus Torvalds 	 */
13671da177e4SLinus Torvalds 	preempt_disable();
13681da177e4SLinus Torvalds 	if (!(worker->flags & WORKER_NOT_RUNNING))
13691da177e4SLinus Torvalds 		worker->pool->nr_running++;
13701da177e4SLinus Torvalds 	preempt_enable();
1371616db877STejun Heo 
1372616db877STejun Heo 	/*
1373616db877STejun Heo 	 * CPU intensive auto-detection cares about how long a work item hogged
1374616db877STejun Heo 	 * CPU without sleeping. Reset the starting timestamp on wakeup.
1375616db877STejun Heo 	 */
1376616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
1377616db877STejun Heo 
1378c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 0);
13791da177e4SLinus Torvalds }
13801da177e4SLinus Torvalds 
13811da177e4SLinus Torvalds /**
13821da177e4SLinus Torvalds  * wq_worker_sleeping - a worker is going to sleep
13831da177e4SLinus Torvalds  * @task: task going to sleep
13841da177e4SLinus Torvalds  *
13851da177e4SLinus Torvalds  * This function is called from schedule() when a busy worker is
13861da177e4SLinus Torvalds  * going to sleep.
13871da177e4SLinus Torvalds  */
13881da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task)
13891da177e4SLinus Torvalds {
13901da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
13911da177e4SLinus Torvalds 	struct worker_pool *pool;
13921da177e4SLinus Torvalds 
13931da177e4SLinus Torvalds 	/*
13941da177e4SLinus Torvalds 	 * Rescuers, which may not have all the fields set up like normal
13951da177e4SLinus Torvalds 	 * workers, also reach here, let's not access anything before
13961da177e4SLinus Torvalds 	 * checking NOT_RUNNING.
13971da177e4SLinus Torvalds 	 */
13981da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING)
13991da177e4SLinus Torvalds 		return;
14001da177e4SLinus Torvalds 
14011da177e4SLinus Torvalds 	pool = worker->pool;
14021da177e4SLinus Torvalds 
14031da177e4SLinus Torvalds 	/* Return if preempted before wq_worker_running() was reached */
1404c8f6219bSZqiang 	if (READ_ONCE(worker->sleeping))
14051da177e4SLinus Torvalds 		return;
14061da177e4SLinus Torvalds 
1407c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 1);
14081da177e4SLinus Torvalds 	raw_spin_lock_irq(&pool->lock);
14091da177e4SLinus Torvalds 
14101da177e4SLinus Torvalds 	/*
14111da177e4SLinus Torvalds 	 * Recheck in case unbind_workers() preempted us. We don't
14121da177e4SLinus Torvalds 	 * want to decrement nr_running after the worker is unbound
14131da177e4SLinus Torvalds 	 * and nr_running has been reset.
14141da177e4SLinus Torvalds 	 */
14151da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING) {
14161da177e4SLinus Torvalds 		raw_spin_unlock_irq(&pool->lock);
14171da177e4SLinus Torvalds 		return;
14181da177e4SLinus Torvalds 	}
14191da177e4SLinus Torvalds 
14201da177e4SLinus Torvalds 	pool->nr_running--;
14210219a352STejun Heo 	if (kick_pool(pool))
1422725e8ec5STejun Heo 		worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++;
14230219a352STejun Heo 
14241da177e4SLinus Torvalds 	raw_spin_unlock_irq(&pool->lock);
14251da177e4SLinus Torvalds }
14261da177e4SLinus Torvalds 
14271da177e4SLinus Torvalds /**
1428616db877STejun Heo  * wq_worker_tick - a scheduler tick occurred while a kworker is running
1429616db877STejun Heo  * @task: task currently running
1430616db877STejun Heo  *
1431616db877STejun Heo  * Called from scheduler_tick(). We're in the IRQ context and the current
1432616db877STejun Heo  * worker's fields which follow the 'K' locking rule can be accessed safely.
1433616db877STejun Heo  */
1434616db877STejun Heo void wq_worker_tick(struct task_struct *task)
1435616db877STejun Heo {
1436616db877STejun Heo 	struct worker *worker = kthread_data(task);
1437616db877STejun Heo 	struct pool_workqueue *pwq = worker->current_pwq;
1438616db877STejun Heo 	struct worker_pool *pool = worker->pool;
1439616db877STejun Heo 
1440616db877STejun Heo 	if (!pwq)
1441616db877STejun Heo 		return;
1442616db877STejun Heo 
14438a1dd1e5STejun Heo 	pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC;
14448a1dd1e5STejun Heo 
144518c8ae81SZqiang 	if (!wq_cpu_intensive_thresh_us)
144618c8ae81SZqiang 		return;
144718c8ae81SZqiang 
1448616db877STejun Heo 	/*
1449616db877STejun Heo 	 * If the current worker is concurrency managed and hogged the CPU for
1450616db877STejun Heo 	 * longer than wq_cpu_intensive_thresh_us, it's automatically marked
1451616db877STejun Heo 	 * CPU_INTENSIVE to avoid stalling other concurrency-managed work items.
1452c8f6219bSZqiang 	 *
1453c8f6219bSZqiang 	 * Set @worker->sleeping means that @worker is in the process of
1454c8f6219bSZqiang 	 * switching out voluntarily and won't be contributing to
1455c8f6219bSZqiang 	 * @pool->nr_running until it wakes up. As wq_worker_sleeping() also
1456c8f6219bSZqiang 	 * decrements ->nr_running, setting CPU_INTENSIVE here can lead to
1457c8f6219bSZqiang 	 * double decrements. The task is releasing the CPU anyway. Let's skip.
1458c8f6219bSZqiang 	 * We probably want to make this prettier in the future.
1459616db877STejun Heo 	 */
1460c8f6219bSZqiang 	if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) ||
1461616db877STejun Heo 	    worker->task->se.sum_exec_runtime - worker->current_at <
1462616db877STejun Heo 	    wq_cpu_intensive_thresh_us * NSEC_PER_USEC)
1463616db877STejun Heo 		return;
1464616db877STejun Heo 
1465616db877STejun Heo 	raw_spin_lock(&pool->lock);
1466616db877STejun Heo 
1467616db877STejun Heo 	worker_set_flags(worker, WORKER_CPU_INTENSIVE);
146863638450STejun Heo 	wq_cpu_intensive_report(worker->current_func);
1469616db877STejun Heo 	pwq->stats[PWQ_STAT_CPU_INTENSIVE]++;
1470616db877STejun Heo 
14710219a352STejun Heo 	if (kick_pool(pool))
1472616db877STejun Heo 		pwq->stats[PWQ_STAT_CM_WAKEUP]++;
1473616db877STejun Heo 
1474616db877STejun Heo 	raw_spin_unlock(&pool->lock);
1475616db877STejun Heo }
1476616db877STejun Heo 
1477616db877STejun Heo /**
14781da177e4SLinus Torvalds  * wq_worker_last_func - retrieve worker's last work function
14791da177e4SLinus Torvalds  * @task: Task to retrieve last work function of.
14801da177e4SLinus Torvalds  *
14811da177e4SLinus Torvalds  * Determine the last function a worker executed. This is called from
14821da177e4SLinus Torvalds  * the scheduler to get a worker's last known identity.
14831da177e4SLinus Torvalds  *
14841da177e4SLinus Torvalds  * CONTEXT:
14859b41ea72SAndrew Morton  * raw_spin_lock_irq(rq->lock)
14861da177e4SLinus Torvalds  *
14871da177e4SLinus Torvalds  * This function is called during schedule() when a kworker is going
1488f756d5e2SNathan Lynch  * to sleep. It's used by psi to identify aggregation workers during
1489f756d5e2SNathan Lynch  * dequeuing, to allow periodic aggregation to shut-off when that
14901da177e4SLinus Torvalds  * worker is the last task in the system or cgroup to go to sleep.
14911da177e4SLinus Torvalds  *
14921da177e4SLinus Torvalds  * As this function doesn't involve any workqueue-related locking, it
14931da177e4SLinus Torvalds  * only returns stable values when called from inside the scheduler's
14941da177e4SLinus Torvalds  * queuing and dequeuing paths, when @task, which must be a kworker,
14951da177e4SLinus Torvalds  * is guaranteed to not be processing any works.
1496365970a1SDavid Howells  *
1497365970a1SDavid Howells  * Return:
1498365970a1SDavid Howells  * The last work function %current executed as a worker, NULL if it
1499365970a1SDavid Howells  * hasn't executed any work yet.
1500365970a1SDavid Howells  */
1501365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task)
1502365970a1SDavid Howells {
1503365970a1SDavid Howells 	struct worker *worker = kthread_data(task);
1504365970a1SDavid Howells 
1505365970a1SDavid Howells 	return worker->last_func;
1506365970a1SDavid Howells }
1507365970a1SDavid Howells 
1508d302f017STejun Heo /**
150991ccc6e7STejun Heo  * wq_node_nr_active - Determine wq_node_nr_active to use
151091ccc6e7STejun Heo  * @wq: workqueue of interest
151191ccc6e7STejun Heo  * @node: NUMA node, can be %NUMA_NO_NODE
151291ccc6e7STejun Heo  *
151391ccc6e7STejun Heo  * Determine wq_node_nr_active to use for @wq on @node. Returns:
151491ccc6e7STejun Heo  *
151591ccc6e7STejun Heo  * - %NULL for per-cpu workqueues as they don't need to use shared nr_active.
151691ccc6e7STejun Heo  *
151791ccc6e7STejun Heo  * - node_nr_active[nr_node_ids] if @node is %NUMA_NO_NODE.
151891ccc6e7STejun Heo  *
151991ccc6e7STejun Heo  * - Otherwise, node_nr_active[@node].
152091ccc6e7STejun Heo  */
152191ccc6e7STejun Heo static struct wq_node_nr_active *wq_node_nr_active(struct workqueue_struct *wq,
152291ccc6e7STejun Heo 						   int node)
152391ccc6e7STejun Heo {
152491ccc6e7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
152591ccc6e7STejun Heo 		return NULL;
152691ccc6e7STejun Heo 
152791ccc6e7STejun Heo 	if (node == NUMA_NO_NODE)
152891ccc6e7STejun Heo 		node = nr_node_ids;
152991ccc6e7STejun Heo 
153091ccc6e7STejun Heo 	return wq->node_nr_active[node];
153191ccc6e7STejun Heo }
153291ccc6e7STejun Heo 
153391ccc6e7STejun Heo /**
15345797b1c1STejun Heo  * wq_update_node_max_active - Update per-node max_actives to use
15355797b1c1STejun Heo  * @wq: workqueue to update
15365797b1c1STejun Heo  * @off_cpu: CPU that's going down, -1 if a CPU is not going down
15375797b1c1STejun Heo  *
15385797b1c1STejun Heo  * Update @wq->node_nr_active[]->max. @wq must be unbound. max_active is
15395797b1c1STejun Heo  * distributed among nodes according to the proportions of numbers of online
15405797b1c1STejun Heo  * cpus. The result is always between @wq->min_active and max_active.
15415797b1c1STejun Heo  */
15425797b1c1STejun Heo static void wq_update_node_max_active(struct workqueue_struct *wq, int off_cpu)
15435797b1c1STejun Heo {
15445797b1c1STejun Heo 	struct cpumask *effective = unbound_effective_cpumask(wq);
15455797b1c1STejun Heo 	int min_active = READ_ONCE(wq->min_active);
15465797b1c1STejun Heo 	int max_active = READ_ONCE(wq->max_active);
15475797b1c1STejun Heo 	int total_cpus, node;
15485797b1c1STejun Heo 
15495797b1c1STejun Heo 	lockdep_assert_held(&wq->mutex);
15505797b1c1STejun Heo 
1551c5f8cd6cSTejun Heo 	if (!wq_topo_initialized)
1552c5f8cd6cSTejun Heo 		return;
1553c5f8cd6cSTejun Heo 
155415930da4STejun Heo 	if (off_cpu >= 0 && !cpumask_test_cpu(off_cpu, effective))
15555797b1c1STejun Heo 		off_cpu = -1;
15565797b1c1STejun Heo 
15575797b1c1STejun Heo 	total_cpus = cpumask_weight_and(effective, cpu_online_mask);
15585797b1c1STejun Heo 	if (off_cpu >= 0)
15595797b1c1STejun Heo 		total_cpus--;
15605797b1c1STejun Heo 
15615797b1c1STejun Heo 	for_each_node(node) {
15625797b1c1STejun Heo 		int node_cpus;
15635797b1c1STejun Heo 
15645797b1c1STejun Heo 		node_cpus = cpumask_weight_and(effective, cpumask_of_node(node));
15655797b1c1STejun Heo 		if (off_cpu >= 0 && cpu_to_node(off_cpu) == node)
15665797b1c1STejun Heo 			node_cpus--;
15675797b1c1STejun Heo 
15685797b1c1STejun Heo 		wq_node_nr_active(wq, node)->max =
15695797b1c1STejun Heo 			clamp(DIV_ROUND_UP(max_active * node_cpus, total_cpus),
15705797b1c1STejun Heo 			      min_active, max_active);
15715797b1c1STejun Heo 	}
15725797b1c1STejun Heo 
15735797b1c1STejun Heo 	wq_node_nr_active(wq, NUMA_NO_NODE)->max = min_active;
15745797b1c1STejun Heo }
15755797b1c1STejun Heo 
15765797b1c1STejun Heo /**
15778864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
15788864b4e5STejun Heo  * @pwq: pool_workqueue to get
15798864b4e5STejun Heo  *
15808864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
15818864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
15828864b4e5STejun Heo  */
15838864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
15848864b4e5STejun Heo {
15858864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
15868864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
15878864b4e5STejun Heo 	pwq->refcnt++;
15888864b4e5STejun Heo }
15898864b4e5STejun Heo 
15908864b4e5STejun Heo /**
15918864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
15928864b4e5STejun Heo  * @pwq: pool_workqueue to put
15938864b4e5STejun Heo  *
15948864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
15958864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
15968864b4e5STejun Heo  */
15978864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
15988864b4e5STejun Heo {
15998864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
16008864b4e5STejun Heo 	if (likely(--pwq->refcnt))
16018864b4e5STejun Heo 		return;
16028864b4e5STejun Heo 	/*
1603967b494eSTejun Heo 	 * @pwq can't be released under pool->lock, bounce to a dedicated
1604967b494eSTejun Heo 	 * kthread_worker to avoid A-A deadlocks.
16058864b4e5STejun Heo 	 */
1606687a9aa5STejun Heo 	kthread_queue_work(pwq_release_worker, &pwq->release_work);
16078864b4e5STejun Heo }
16088864b4e5STejun Heo 
1609dce90d47STejun Heo /**
1610dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1611dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1612dce90d47STejun Heo  *
1613dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1614dce90d47STejun Heo  */
1615dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1616dce90d47STejun Heo {
1617dce90d47STejun Heo 	if (pwq) {
1618dce90d47STejun Heo 		/*
161924acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1620dce90d47STejun Heo 		 * following lock operations are safe.
1621dce90d47STejun Heo 		 */
1622a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
1623dce90d47STejun Heo 		put_pwq(pwq);
1624a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
1625dce90d47STejun Heo 	}
1626dce90d47STejun Heo }
1627dce90d47STejun Heo 
1628afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq)
1629afa87ce8STejun Heo {
1630afa87ce8STejun Heo 	return !pwq->nr_active && list_empty(&pwq->inactive_works);
1631afa87ce8STejun Heo }
1632afa87ce8STejun Heo 
16334c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq,
16344c638030STejun Heo 				struct work_struct *work)
1635bf4ede01STejun Heo {
16361c270b79STejun Heo 	unsigned long *wdb = work_data_bits(work);
16371c270b79STejun Heo 
16381c270b79STejun Heo 	WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE));
1639bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
164082607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
164182607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1642112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
16431c270b79STejun Heo 	__clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb);
16444c638030STejun Heo }
16454c638030STejun Heo 
16464c638030STejun Heo /**
16474c638030STejun Heo  * pwq_activate_work - Activate a work item if inactive
16484c638030STejun Heo  * @pwq: pool_workqueue @work belongs to
16494c638030STejun Heo  * @work: work item to activate
16504c638030STejun Heo  *
16514c638030STejun Heo  * Returns %true if activated. %false if already active.
16524c638030STejun Heo  */
16534c638030STejun Heo static bool pwq_activate_work(struct pool_workqueue *pwq,
16544c638030STejun Heo 			      struct work_struct *work)
16554c638030STejun Heo {
16564c638030STejun Heo 	struct worker_pool *pool = pwq->pool;
165791ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
16584c638030STejun Heo 
16594c638030STejun Heo 	lockdep_assert_held(&pool->lock);
16604c638030STejun Heo 
16614c638030STejun Heo 	if (!(*work_data_bits(work) & WORK_STRUCT_INACTIVE))
16624c638030STejun Heo 		return false;
16634c638030STejun Heo 
166491ccc6e7STejun Heo 	nna = wq_node_nr_active(pwq->wq, pool->node);
166591ccc6e7STejun Heo 	if (nna)
166691ccc6e7STejun Heo 		atomic_inc(&nna->nr);
166791ccc6e7STejun Heo 
1668112202d9STejun Heo 	pwq->nr_active++;
16694c638030STejun Heo 	__pwq_activate_work(pwq, work);
16704c638030STejun Heo 	return true;
1671bf4ede01STejun Heo }
1672bf4ede01STejun Heo 
16735797b1c1STejun Heo static bool tryinc_node_nr_active(struct wq_node_nr_active *nna)
16745797b1c1STejun Heo {
16755797b1c1STejun Heo 	int max = READ_ONCE(nna->max);
16765797b1c1STejun Heo 
16775797b1c1STejun Heo 	while (true) {
16785797b1c1STejun Heo 		int old, tmp;
16795797b1c1STejun Heo 
16805797b1c1STejun Heo 		old = atomic_read(&nna->nr);
16815797b1c1STejun Heo 		if (old >= max)
16825797b1c1STejun Heo 			return false;
16835797b1c1STejun Heo 		tmp = atomic_cmpxchg_relaxed(&nna->nr, old, old + 1);
16845797b1c1STejun Heo 		if (tmp == old)
16855797b1c1STejun Heo 			return true;
16865797b1c1STejun Heo 	}
16875797b1c1STejun Heo }
16885797b1c1STejun Heo 
16891c270b79STejun Heo /**
16901c270b79STejun Heo  * pwq_tryinc_nr_active - Try to increment nr_active for a pwq
16911c270b79STejun Heo  * @pwq: pool_workqueue of interest
16925797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
16931c270b79STejun Heo  *
16941c270b79STejun Heo  * Try to increment nr_active for @pwq. Returns %true if an nr_active count is
16951c270b79STejun Heo  * successfully obtained. %false otherwise.
16961c270b79STejun Heo  */
16975797b1c1STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq, bool fill)
16983aa62497SLai Jiangshan {
16991c270b79STejun Heo 	struct workqueue_struct *wq = pwq->wq;
17001c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
170191ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(wq, pool->node);
17025797b1c1STejun Heo 	bool obtained = false;
17031c270b79STejun Heo 
17041c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
17051c270b79STejun Heo 
17065797b1c1STejun Heo 	if (!nna) {
17074cb1ef64STejun Heo 		/* BH or per-cpu workqueue, pwq->nr_active is sufficient */
17081c270b79STejun Heo 		obtained = pwq->nr_active < READ_ONCE(wq->max_active);
17095797b1c1STejun Heo 		goto out;
171091ccc6e7STejun Heo 	}
17115797b1c1STejun Heo 
17124c065dbcSWaiman Long 	if (unlikely(pwq->plugged))
17134c065dbcSWaiman Long 		return false;
17144c065dbcSWaiman Long 
17155797b1c1STejun Heo 	/*
17165797b1c1STejun Heo 	 * Unbound workqueue uses per-node shared nr_active $nna. If @pwq is
17175797b1c1STejun Heo 	 * already waiting on $nna, pwq_dec_nr_active() will maintain the
17185797b1c1STejun Heo 	 * concurrency level. Don't jump the line.
17195797b1c1STejun Heo 	 *
17205797b1c1STejun Heo 	 * We need to ignore the pending test after max_active has increased as
17215797b1c1STejun Heo 	 * pwq_dec_nr_active() can only maintain the concurrency level but not
17225797b1c1STejun Heo 	 * increase it. This is indicated by @fill.
17235797b1c1STejun Heo 	 */
17245797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node) && likely(!fill))
17255797b1c1STejun Heo 		goto out;
17265797b1c1STejun Heo 
17275797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17285797b1c1STejun Heo 	if (obtained)
17295797b1c1STejun Heo 		goto out;
17305797b1c1STejun Heo 
17315797b1c1STejun Heo 	/*
17325797b1c1STejun Heo 	 * Lockless acquisition failed. Lock, add ourself to $nna->pending_pwqs
17335797b1c1STejun Heo 	 * and try again. The smp_mb() is paired with the implied memory barrier
17345797b1c1STejun Heo 	 * of atomic_dec_return() in pwq_dec_nr_active() to ensure that either
17355797b1c1STejun Heo 	 * we see the decremented $nna->nr or they see non-empty
17365797b1c1STejun Heo 	 * $nna->pending_pwqs.
17375797b1c1STejun Heo 	 */
17385797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
17395797b1c1STejun Heo 
17405797b1c1STejun Heo 	if (list_empty(&pwq->pending_node))
17415797b1c1STejun Heo 		list_add_tail(&pwq->pending_node, &nna->pending_pwqs);
17425797b1c1STejun Heo 	else if (likely(!fill))
17435797b1c1STejun Heo 		goto out_unlock;
17445797b1c1STejun Heo 
17455797b1c1STejun Heo 	smp_mb();
17465797b1c1STejun Heo 
17475797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17485797b1c1STejun Heo 
17495797b1c1STejun Heo 	/*
17505797b1c1STejun Heo 	 * If @fill, @pwq might have already been pending. Being spuriously
17515797b1c1STejun Heo 	 * pending in cold paths doesn't affect anything. Let's leave it be.
17525797b1c1STejun Heo 	 */
17535797b1c1STejun Heo 	if (obtained && likely(!fill))
17545797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
17555797b1c1STejun Heo 
17565797b1c1STejun Heo out_unlock:
17575797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
17585797b1c1STejun Heo out:
17595797b1c1STejun Heo 	if (obtained)
17605797b1c1STejun Heo 		pwq->nr_active++;
17611c270b79STejun Heo 	return obtained;
17621c270b79STejun Heo }
17631c270b79STejun Heo 
17641c270b79STejun Heo /**
17651c270b79STejun Heo  * pwq_activate_first_inactive - Activate the first inactive work item on a pwq
17661c270b79STejun Heo  * @pwq: pool_workqueue of interest
17675797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
17681c270b79STejun Heo  *
17691c270b79STejun Heo  * Activate the first inactive work item of @pwq if available and allowed by
17701c270b79STejun Heo  * max_active limit.
17711c270b79STejun Heo  *
17721c270b79STejun Heo  * Returns %true if an inactive work item has been activated. %false if no
17731c270b79STejun Heo  * inactive work item is found or max_active limit is reached.
17741c270b79STejun Heo  */
17755797b1c1STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq, bool fill)
17761c270b79STejun Heo {
17771c270b79STejun Heo 	struct work_struct *work =
17781c270b79STejun Heo 		list_first_entry_or_null(&pwq->inactive_works,
17793aa62497SLai Jiangshan 					 struct work_struct, entry);
17803aa62497SLai Jiangshan 
17815797b1c1STejun Heo 	if (work && pwq_tryinc_nr_active(pwq, fill)) {
17821c270b79STejun Heo 		__pwq_activate_work(pwq, work);
17831c270b79STejun Heo 		return true;
17841c270b79STejun Heo 	} else {
17851c270b79STejun Heo 		return false;
17861c270b79STejun Heo 	}
17871c270b79STejun Heo }
17881c270b79STejun Heo 
17891c270b79STejun Heo /**
17904c065dbcSWaiman Long  * unplug_oldest_pwq - restart an oldest plugged pool_workqueue
17914c065dbcSWaiman Long  * @wq: workqueue_struct to be restarted
17924c065dbcSWaiman Long  *
17934c065dbcSWaiman Long  * pwq's are linked into wq->pwqs with the oldest first. For ordered
17944c065dbcSWaiman Long  * workqueues, only the oldest pwq is unplugged, the others are plugged to
17954c065dbcSWaiman Long  * suspend execution until the oldest one is drained. When this happens, the
17964c065dbcSWaiman Long  * next oldest one (first plugged pwq in iteration) will be unplugged to
17974c065dbcSWaiman Long  * restart work item execution to ensure proper work item ordering.
17984c065dbcSWaiman Long  *
17994c065dbcSWaiman Long  *    dfl_pwq --------------+     [P] - plugged
18004c065dbcSWaiman Long  *                          |
18014c065dbcSWaiman Long  *                          v
18024c065dbcSWaiman Long  *    pwqs -> A -> B [P] -> C [P] (newest)
18034c065dbcSWaiman Long  *            |    |        |
18044c065dbcSWaiman Long  *            1    3        5
18054c065dbcSWaiman Long  *            |    |        |
18064c065dbcSWaiman Long  *            2    4        6
18074c065dbcSWaiman Long  */
18084c065dbcSWaiman Long static void unplug_oldest_pwq(struct workqueue_struct *wq)
18094c065dbcSWaiman Long {
18104c065dbcSWaiman Long 	struct pool_workqueue *pwq;
18114c065dbcSWaiman Long 
18124c065dbcSWaiman Long 	lockdep_assert_held(&wq->mutex);
18134c065dbcSWaiman Long 
18144c065dbcSWaiman Long 	/* Caller should make sure that pwqs isn't empty before calling */
18154c065dbcSWaiman Long 	pwq = list_first_entry_or_null(&wq->pwqs, struct pool_workqueue,
18164c065dbcSWaiman Long 				       pwqs_node);
18174c065dbcSWaiman Long 	raw_spin_lock_irq(&pwq->pool->lock);
18184c065dbcSWaiman Long 	if (pwq->plugged) {
18194c065dbcSWaiman Long 		pwq->plugged = false;
18204c065dbcSWaiman Long 		if (pwq_activate_first_inactive(pwq, true))
18214c065dbcSWaiman Long 			kick_pool(pwq->pool);
18224c065dbcSWaiman Long 	}
18234c065dbcSWaiman Long 	raw_spin_unlock_irq(&pwq->pool->lock);
18244c065dbcSWaiman Long }
18254c065dbcSWaiman Long 
18264c065dbcSWaiman Long /**
18275797b1c1STejun Heo  * node_activate_pending_pwq - Activate a pending pwq on a wq_node_nr_active
18285797b1c1STejun Heo  * @nna: wq_node_nr_active to activate a pending pwq for
18295797b1c1STejun Heo  * @caller_pool: worker_pool the caller is locking
18305797b1c1STejun Heo  *
18315797b1c1STejun Heo  * Activate a pwq in @nna->pending_pwqs. Called with @caller_pool locked.
18325797b1c1STejun Heo  * @caller_pool may be unlocked and relocked to lock other worker_pools.
18335797b1c1STejun Heo  */
18345797b1c1STejun Heo static void node_activate_pending_pwq(struct wq_node_nr_active *nna,
18355797b1c1STejun Heo 				      struct worker_pool *caller_pool)
18365797b1c1STejun Heo {
18375797b1c1STejun Heo 	struct worker_pool *locked_pool = caller_pool;
18385797b1c1STejun Heo 	struct pool_workqueue *pwq;
18395797b1c1STejun Heo 	struct work_struct *work;
18405797b1c1STejun Heo 
18415797b1c1STejun Heo 	lockdep_assert_held(&caller_pool->lock);
18425797b1c1STejun Heo 
18435797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
18445797b1c1STejun Heo retry:
18455797b1c1STejun Heo 	pwq = list_first_entry_or_null(&nna->pending_pwqs,
18465797b1c1STejun Heo 				       struct pool_workqueue, pending_node);
18475797b1c1STejun Heo 	if (!pwq)
18485797b1c1STejun Heo 		goto out_unlock;
18495797b1c1STejun Heo 
18505797b1c1STejun Heo 	/*
18515797b1c1STejun Heo 	 * If @pwq is for a different pool than @locked_pool, we need to lock
18525797b1c1STejun Heo 	 * @pwq->pool->lock. Let's trylock first. If unsuccessful, do the unlock
18535797b1c1STejun Heo 	 * / lock dance. For that, we also need to release @nna->lock as it's
18545797b1c1STejun Heo 	 * nested inside pool locks.
18555797b1c1STejun Heo 	 */
18565797b1c1STejun Heo 	if (pwq->pool != locked_pool) {
18575797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
18585797b1c1STejun Heo 		locked_pool = pwq->pool;
18595797b1c1STejun Heo 		if (!raw_spin_trylock(&locked_pool->lock)) {
18605797b1c1STejun Heo 			raw_spin_unlock(&nna->lock);
18615797b1c1STejun Heo 			raw_spin_lock(&locked_pool->lock);
18625797b1c1STejun Heo 			raw_spin_lock(&nna->lock);
18635797b1c1STejun Heo 			goto retry;
18645797b1c1STejun Heo 		}
18655797b1c1STejun Heo 	}
18665797b1c1STejun Heo 
18675797b1c1STejun Heo 	/*
18685797b1c1STejun Heo 	 * $pwq may not have any inactive work items due to e.g. cancellations.
18695797b1c1STejun Heo 	 * Drop it from pending_pwqs and see if there's another one.
18705797b1c1STejun Heo 	 */
18715797b1c1STejun Heo 	work = list_first_entry_or_null(&pwq->inactive_works,
18725797b1c1STejun Heo 					struct work_struct, entry);
18735797b1c1STejun Heo 	if (!work) {
18745797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
18755797b1c1STejun Heo 		goto retry;
18765797b1c1STejun Heo 	}
18775797b1c1STejun Heo 
18785797b1c1STejun Heo 	/*
18795797b1c1STejun Heo 	 * Acquire an nr_active count and activate the inactive work item. If
18805797b1c1STejun Heo 	 * $pwq still has inactive work items, rotate it to the end of the
18815797b1c1STejun Heo 	 * pending_pwqs so that we round-robin through them. This means that
18825797b1c1STejun Heo 	 * inactive work items are not activated in queueing order which is fine
18835797b1c1STejun Heo 	 * given that there has never been any ordering across different pwqs.
18845797b1c1STejun Heo 	 */
18855797b1c1STejun Heo 	if (likely(tryinc_node_nr_active(nna))) {
18865797b1c1STejun Heo 		pwq->nr_active++;
18875797b1c1STejun Heo 		__pwq_activate_work(pwq, work);
18885797b1c1STejun Heo 
18895797b1c1STejun Heo 		if (list_empty(&pwq->inactive_works))
18905797b1c1STejun Heo 			list_del_init(&pwq->pending_node);
18915797b1c1STejun Heo 		else
18925797b1c1STejun Heo 			list_move_tail(&pwq->pending_node, &nna->pending_pwqs);
18935797b1c1STejun Heo 
18945797b1c1STejun Heo 		/* if activating a foreign pool, make sure it's running */
18955797b1c1STejun Heo 		if (pwq->pool != caller_pool)
18965797b1c1STejun Heo 			kick_pool(pwq->pool);
18975797b1c1STejun Heo 	}
18985797b1c1STejun Heo 
18995797b1c1STejun Heo out_unlock:
19005797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
19015797b1c1STejun Heo 	if (locked_pool != caller_pool) {
19025797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
19035797b1c1STejun Heo 		raw_spin_lock(&caller_pool->lock);
19045797b1c1STejun Heo 	}
19055797b1c1STejun Heo }
19065797b1c1STejun Heo 
19075797b1c1STejun Heo /**
19081c270b79STejun Heo  * pwq_dec_nr_active - Retire an active count
19091c270b79STejun Heo  * @pwq: pool_workqueue of interest
19101c270b79STejun Heo  *
19111c270b79STejun Heo  * Decrement @pwq's nr_active and try to activate the first inactive work item.
19125797b1c1STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock.
19131c270b79STejun Heo  */
19141c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq)
19151c270b79STejun Heo {
19161c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
191791ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(pwq->wq, pool->node);
19181c270b79STejun Heo 
19191c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
19201c270b79STejun Heo 
192191ccc6e7STejun Heo 	/*
192291ccc6e7STejun Heo 	 * @pwq->nr_active should be decremented for both percpu and unbound
192391ccc6e7STejun Heo 	 * workqueues.
192491ccc6e7STejun Heo 	 */
19251c270b79STejun Heo 	pwq->nr_active--;
192691ccc6e7STejun Heo 
192791ccc6e7STejun Heo 	/*
192891ccc6e7STejun Heo 	 * For a percpu workqueue, it's simple. Just need to kick the first
192991ccc6e7STejun Heo 	 * inactive work item on @pwq itself.
193091ccc6e7STejun Heo 	 */
193191ccc6e7STejun Heo 	if (!nna) {
19325797b1c1STejun Heo 		pwq_activate_first_inactive(pwq, false);
193391ccc6e7STejun Heo 		return;
193491ccc6e7STejun Heo 	}
193591ccc6e7STejun Heo 
19365797b1c1STejun Heo 	/*
19375797b1c1STejun Heo 	 * If @pwq is for an unbound workqueue, it's more complicated because
19385797b1c1STejun Heo 	 * multiple pwqs and pools may be sharing the nr_active count. When a
19395797b1c1STejun Heo 	 * pwq needs to wait for an nr_active count, it puts itself on
19405797b1c1STejun Heo 	 * $nna->pending_pwqs. The following atomic_dec_return()'s implied
19415797b1c1STejun Heo 	 * memory barrier is paired with smp_mb() in pwq_tryinc_nr_active() to
19425797b1c1STejun Heo 	 * guarantee that either we see non-empty pending_pwqs or they see
19435797b1c1STejun Heo 	 * decremented $nna->nr.
19445797b1c1STejun Heo 	 *
19455797b1c1STejun Heo 	 * $nna->max may change as CPUs come online/offline and @pwq->wq's
19465797b1c1STejun Heo 	 * max_active gets updated. However, it is guaranteed to be equal to or
19475797b1c1STejun Heo 	 * larger than @pwq->wq->min_active which is above zero unless freezing.
19485797b1c1STejun Heo 	 * This maintains the forward progress guarantee.
19495797b1c1STejun Heo 	 */
19505797b1c1STejun Heo 	if (atomic_dec_return(&nna->nr) >= READ_ONCE(nna->max))
19515797b1c1STejun Heo 		return;
19525797b1c1STejun Heo 
19535797b1c1STejun Heo 	if (!list_empty(&nna->pending_pwqs))
19545797b1c1STejun Heo 		node_activate_pending_pwq(nna, pool);
19553aa62497SLai Jiangshan }
19563aa62497SLai Jiangshan 
1957bf4ede01STejun Heo /**
1958112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1959112202d9STejun Heo  * @pwq: pwq of interest
1960c4560c2cSLai Jiangshan  * @work_data: work_data of work which left the queue
1961bf4ede01STejun Heo  *
1962bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1963112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1964bf4ede01STejun Heo  *
1965dd6c3c54STejun Heo  * NOTE:
1966dd6c3c54STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock
1967dd6c3c54STejun Heo  * and thus should be called after all other state updates for the in-flight
1968dd6c3c54STejun Heo  * work item is complete.
1969dd6c3c54STejun Heo  *
1970bf4ede01STejun Heo  * CONTEXT:
1971a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1972bf4ede01STejun Heo  */
1973c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
1974bf4ede01STejun Heo {
1975c4560c2cSLai Jiangshan 	int color = get_work_color(work_data);
1976c4560c2cSLai Jiangshan 
19771c270b79STejun Heo 	if (!(work_data & WORK_STRUCT_INACTIVE))
19781c270b79STejun Heo 		pwq_dec_nr_active(pwq);
1979018f3a13SLai Jiangshan 
1980018f3a13SLai Jiangshan 	pwq->nr_in_flight[color]--;
1981bf4ede01STejun Heo 
1982bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1983112202d9STejun Heo 	if (likely(pwq->flush_color != color))
19848864b4e5STejun Heo 		goto out_put;
1985bf4ede01STejun Heo 
1986bf4ede01STejun Heo 	/* are there still in-flight works? */
1987112202d9STejun Heo 	if (pwq->nr_in_flight[color])
19888864b4e5STejun Heo 		goto out_put;
1989bf4ede01STejun Heo 
1990112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1991112202d9STejun Heo 	pwq->flush_color = -1;
1992bf4ede01STejun Heo 
1993bf4ede01STejun Heo 	/*
1994112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1995bf4ede01STejun Heo 	 * will handle the rest.
1996bf4ede01STejun Heo 	 */
1997112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1998112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
19998864b4e5STejun Heo out_put:
20008864b4e5STejun Heo 	put_pwq(pwq);
2001bf4ede01STejun Heo }
2002bf4ede01STejun Heo 
200336e227d2STejun Heo /**
2004bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
200536e227d2STejun Heo  * @work: work item to steal
200636e227d2STejun Heo  * @is_dwork: @work is a delayed_work
2007bbb68dfaSTejun Heo  * @flags: place to store irq state
200836e227d2STejun Heo  *
200936e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
2010d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
201136e227d2STejun Heo  *
2012d185af30SYacine Belkadi  * Return:
20133eb6b31bSMauro Carvalho Chehab  *
20143eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
201536e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
201636e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
201736e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
2018bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
2019bbb68dfaSTejun Heo  *		for arbitrarily long
20203eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
202136e227d2STejun Heo  *
2022d185af30SYacine Belkadi  * Note:
2023bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
2024e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
2025e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
2026e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
2027bbb68dfaSTejun Heo  *
2028bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
2029bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
2030bbb68dfaSTejun Heo  *
2031e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
2032bf4ede01STejun Heo  */
2033bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
2034bbb68dfaSTejun Heo 			       unsigned long *flags)
2035bf4ede01STejun Heo {
2036d565ed63STejun Heo 	struct worker_pool *pool;
2037112202d9STejun Heo 	struct pool_workqueue *pwq;
2038bf4ede01STejun Heo 
2039bbb68dfaSTejun Heo 	local_irq_save(*flags);
2040bbb68dfaSTejun Heo 
204136e227d2STejun Heo 	/* try to steal the timer if it exists */
204236e227d2STejun Heo 	if (is_dwork) {
204336e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
204436e227d2STejun Heo 
2045e0aecdd8STejun Heo 		/*
2046e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
2047e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
2048e0aecdd8STejun Heo 		 * running on the local CPU.
2049e0aecdd8STejun Heo 		 */
205036e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
205136e227d2STejun Heo 			return 1;
205236e227d2STejun Heo 	}
205336e227d2STejun Heo 
205436e227d2STejun Heo 	/* try to claim PENDING the normal way */
2055bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2056bf4ede01STejun Heo 		return 0;
2057bf4ede01STejun Heo 
205824acfb71SThomas Gleixner 	rcu_read_lock();
2059bf4ede01STejun Heo 	/*
2060bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
2061bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2062bf4ede01STejun Heo 	 */
2063d565ed63STejun Heo 	pool = get_work_pool(work);
2064d565ed63STejun Heo 	if (!pool)
2065bbb68dfaSTejun Heo 		goto fail;
2066bf4ede01STejun Heo 
2067a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&pool->lock);
2068bf4ede01STejun Heo 	/*
2069112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
2070112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
2071112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
2072112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
2073112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
20740b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
2075bf4ede01STejun Heo 	 */
2076112202d9STejun Heo 	pwq = get_work_pwq(work);
2077112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
2078c70e1779STejun Heo 		unsigned long work_data;
2079c70e1779STejun Heo 
2080bf4ede01STejun Heo 		debug_work_deactivate(work);
20813aa62497SLai Jiangshan 
20823aa62497SLai Jiangshan 		/*
2083018f3a13SLai Jiangshan 		 * A cancelable inactive work item must be in the
2084018f3a13SLai Jiangshan 		 * pwq->inactive_works since a queued barrier can't be
2085018f3a13SLai Jiangshan 		 * canceled (see the comments in insert_wq_barrier()).
2086018f3a13SLai Jiangshan 		 *
2087f97a4a1aSLai Jiangshan 		 * An inactive work item cannot be grabbed directly because
2088d812796eSLai Jiangshan 		 * it might have linked barrier work items which, if left
2089f97a4a1aSLai Jiangshan 		 * on the inactive_works list, will confuse pwq->nr_active
209016062836STejun Heo 		 * management later on and cause stall.  Make sure the work
209116062836STejun Heo 		 * item is activated before grabbing.
20923aa62497SLai Jiangshan 		 */
20934c638030STejun Heo 		pwq_activate_work(pwq, work);
20943aa62497SLai Jiangshan 
2095bf4ede01STejun Heo 		list_del_init(&work->entry);
209636e227d2STejun Heo 
2097c70e1779STejun Heo 		/*
2098c70e1779STejun Heo 		 * work->data points to pwq iff queued. Let's point to pool. As
2099c70e1779STejun Heo 		 * this destroys work->data needed by the next step, stash it.
2100c70e1779STejun Heo 		 */
2101c70e1779STejun Heo 		work_data = *work_data_bits(work);
21024468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
21034468a00fSLai Jiangshan 
2104dd6c3c54STejun Heo 		/* must be the last step, see the function comment */
2105c70e1779STejun Heo 		pwq_dec_nr_in_flight(pwq, work_data);
2106dd6c3c54STejun Heo 
2107a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock(&pool->lock);
210824acfb71SThomas Gleixner 		rcu_read_unlock();
210936e227d2STejun Heo 		return 1;
2110bf4ede01STejun Heo 	}
2111a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pool->lock);
2112bbb68dfaSTejun Heo fail:
211324acfb71SThomas Gleixner 	rcu_read_unlock();
2114bbb68dfaSTejun Heo 	local_irq_restore(*flags);
2115bbb68dfaSTejun Heo 	if (work_is_canceling(work))
2116bbb68dfaSTejun Heo 		return -ENOENT;
2117bbb68dfaSTejun Heo 	cpu_relax();
211836e227d2STejun Heo 	return -EAGAIN;
2119bf4ede01STejun Heo }
2120bf4ede01STejun Heo 
2121bf4ede01STejun Heo /**
2122706026c2STejun Heo  * insert_work - insert a work into a pool
2123112202d9STejun Heo  * @pwq: pwq @work belongs to
21244690c4abSTejun Heo  * @work: work to insert
21254690c4abSTejun Heo  * @head: insertion point
21264690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
21274690c4abSTejun Heo  *
2128112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
2129706026c2STejun Heo  * work_struct flags.
21304690c4abSTejun Heo  *
21314690c4abSTejun Heo  * CONTEXT:
2132a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2133365970a1SDavid Howells  */
2134112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
2135112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
2136b89deed3SOleg Nesterov {
2137fe089f87STejun Heo 	debug_work_activate(work);
2138e1d8aa9fSFrederic Weisbecker 
2139e89a85d6SWalter Wu 	/* record the work call stack in order to print it in KASAN reports */
2140f70da745SMarco Elver 	kasan_record_aux_stack_noalloc(work);
2141e89a85d6SWalter Wu 
21424690c4abSTejun Heo 	/* we own @work, set data and link */
2143112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
21441a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
21458864b4e5STejun Heo 	get_pwq(pwq);
2146b89deed3SOleg Nesterov }
2147b89deed3SOleg Nesterov 
2148c8efcc25STejun Heo /*
2149c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
21508d03ecfeSTejun Heo  * same workqueue.
2151c8efcc25STejun Heo  */
2152c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
2153c8efcc25STejun Heo {
2154c8efcc25STejun Heo 	struct worker *worker;
2155c8efcc25STejun Heo 
21568d03ecfeSTejun Heo 	worker = current_wq_worker();
2157c8efcc25STejun Heo 	/*
2158bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
21598d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
2160c8efcc25STejun Heo 	 */
2161112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
2162c8efcc25STejun Heo }
2163c8efcc25STejun Heo 
2164ef557180SMike Galbraith /*
2165ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
2166ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
2167ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
2168ef557180SMike Galbraith  */
2169ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
2170ef557180SMike Galbraith {
2171ef557180SMike Galbraith 	int new_cpu;
2172ef557180SMike Galbraith 
2173f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
2174ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
2175ef557180SMike Galbraith 			return cpu;
2176a8ec5880SAmmar Faizi 	} else {
2177a8ec5880SAmmar Faizi 		pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n");
2178f303fccbSTejun Heo 	}
2179f303fccbSTejun Heo 
2180ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
2181ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
2182ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
2183ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
2184ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
2185ef557180SMike Galbraith 			return cpu;
2186ef557180SMike Galbraith 	}
2187ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
2188ef557180SMike Galbraith 
2189ef557180SMike Galbraith 	return new_cpu;
2190ef557180SMike Galbraith }
2191ef557180SMike Galbraith 
2192d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
21931da177e4SLinus Torvalds 			 struct work_struct *work)
21941da177e4SLinus Torvalds {
2195112202d9STejun Heo 	struct pool_workqueue *pwq;
2196fe089f87STejun Heo 	struct worker_pool *last_pool, *pool;
21978a2e8e5dSTejun Heo 	unsigned int work_flags;
2198b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
21998930cabaSTejun Heo 
22008930cabaSTejun Heo 	/*
22018930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
22028930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
22038930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
22048930cabaSTejun Heo 	 * happen with IRQ disabled.
22058930cabaSTejun Heo 	 */
22068e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
22071da177e4SLinus Torvalds 
22081e19ffc6STejun Heo 
220933e3f0a3SRichard Clark 	/*
221033e3f0a3SRichard Clark 	 * For a draining wq, only works from the same workqueue are
221133e3f0a3SRichard Clark 	 * allowed. The __WQ_DESTROYING helps to spot the issue that
221233e3f0a3SRichard Clark 	 * queues a new work item to a wq after destroy_workqueue(wq).
221333e3f0a3SRichard Clark 	 */
221433e3f0a3SRichard Clark 	if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) &&
221533e3f0a3SRichard Clark 		     WARN_ON_ONCE(!is_chained_work(wq))))
2216e41e704bSTejun Heo 		return;
221724acfb71SThomas Gleixner 	rcu_read_lock();
22189e8cd2f5STejun Heo retry:
2219aa202f1fSHillf Danton 	/* pwq which will be used unless @work is executing elsewhere */
2220636b927eSTejun Heo 	if (req_cpu == WORK_CPU_UNBOUND) {
2221636b927eSTejun Heo 		if (wq->flags & WQ_UNBOUND)
2222ef557180SMike Galbraith 			cpu = wq_select_unbound_cpu(raw_smp_processor_id());
2223636b927eSTejun Heo 		else
2224aa202f1fSHillf Danton 			cpu = raw_smp_processor_id();
2225aa202f1fSHillf Danton 	}
2226f3421797STejun Heo 
2227636b927eSTejun Heo 	pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu));
2228fe089f87STejun Heo 	pool = pwq->pool;
2229fe089f87STejun Heo 
223018aa9effSTejun Heo 	/*
2231c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
2232c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
2233c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
223418aa9effSTejun Heo 	 */
2235c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
2236fe089f87STejun Heo 	if (last_pool && last_pool != pool) {
223718aa9effSTejun Heo 		struct worker *worker;
223818aa9effSTejun Heo 
2239a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&last_pool->lock);
224018aa9effSTejun Heo 
2241c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
224218aa9effSTejun Heo 
2243112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
2244c9178087STejun Heo 			pwq = worker->current_pwq;
2245fe089f87STejun Heo 			pool = pwq->pool;
2246fe089f87STejun Heo 			WARN_ON_ONCE(pool != last_pool);
22478594fadeSLai Jiangshan 		} else {
224818aa9effSTejun Heo 			/* meh... not running there, queue here */
2249a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&last_pool->lock);
2250fe089f87STejun Heo 			raw_spin_lock(&pool->lock);
225118aa9effSTejun Heo 		}
22528930cabaSTejun Heo 	} else {
2253fe089f87STejun Heo 		raw_spin_lock(&pool->lock);
22548930cabaSTejun Heo 	}
2255502ca9d8STejun Heo 
22569e8cd2f5STejun Heo 	/*
2257636b927eSTejun Heo 	 * pwq is determined and locked. For unbound pools, we could have raced
2258636b927eSTejun Heo 	 * with pwq release and it could already be dead. If its refcnt is zero,
2259636b927eSTejun Heo 	 * repeat pwq selection. Note that unbound pwqs never die without
2260636b927eSTejun Heo 	 * another pwq replacing it in cpu_pwq or while work items are executing
2261636b927eSTejun Heo 	 * on it, so the retrying is guaranteed to make forward-progress.
22629e8cd2f5STejun Heo 	 */
22639e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
22649e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
2265fe089f87STejun Heo 			raw_spin_unlock(&pool->lock);
22669e8cd2f5STejun Heo 			cpu_relax();
22679e8cd2f5STejun Heo 			goto retry;
22689e8cd2f5STejun Heo 		}
22699e8cd2f5STejun Heo 		/* oops */
22709e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
22719e8cd2f5STejun Heo 			  wq->name, cpu);
22729e8cd2f5STejun Heo 	}
22739e8cd2f5STejun Heo 
2274112202d9STejun Heo 	/* pwq determined, queue */
2275112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
2276502ca9d8STejun Heo 
227724acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
227824acfb71SThomas Gleixner 		goto out;
22791e19ffc6STejun Heo 
2280112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
2281112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
22821e19ffc6STejun Heo 
2283a045a272STejun Heo 	/*
2284a045a272STejun Heo 	 * Limit the number of concurrently active work items to max_active.
2285a045a272STejun Heo 	 * @work must also queue behind existing inactive work items to maintain
2286a045a272STejun Heo 	 * ordering when max_active changes. See wq_adjust_max_active().
2287a045a272STejun Heo 	 */
22885797b1c1STejun Heo 	if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq, false)) {
2289fe089f87STejun Heo 		if (list_empty(&pool->worklist))
2290fe089f87STejun Heo 			pool->watchdog_ts = jiffies;
2291fe089f87STejun Heo 
2292cdadf009STejun Heo 		trace_workqueue_activate_work(work);
2293fe089f87STejun Heo 		insert_work(pwq, work, &pool->worklist, work_flags);
22940219a352STejun Heo 		kick_pool(pool);
22958a2e8e5dSTejun Heo 	} else {
2296f97a4a1aSLai Jiangshan 		work_flags |= WORK_STRUCT_INACTIVE;
2297fe089f87STejun Heo 		insert_work(pwq, work, &pwq->inactive_works, work_flags);
22988a2e8e5dSTejun Heo 	}
22991e19ffc6STejun Heo 
230024acfb71SThomas Gleixner out:
2301fe089f87STejun Heo 	raw_spin_unlock(&pool->lock);
230224acfb71SThomas Gleixner 	rcu_read_unlock();
23031da177e4SLinus Torvalds }
23041da177e4SLinus Torvalds 
23050fcb78c2SRolf Eike Beer /**
2306c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
2307c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
2308c1a220e7SZhang Rui  * @wq: workqueue to use
2309c1a220e7SZhang Rui  * @work: work to queue
2310c1a220e7SZhang Rui  *
2311c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
2312443378f0SPaul E. McKenney  * can't go away.  Callers that fail to ensure that the specified
2313443378f0SPaul E. McKenney  * CPU cannot go away will execute on a randomly chosen CPU.
2314854f5cc5SPaul E. McKenney  * But note well that callers specifying a CPU that never has been
2315854f5cc5SPaul E. McKenney  * online will get a splat.
2316d185af30SYacine Belkadi  *
2317d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
2318c1a220e7SZhang Rui  */
2319d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
2320d4283e93STejun Heo 		   struct work_struct *work)
2321c1a220e7SZhang Rui {
2322d4283e93STejun Heo 	bool ret = false;
23238930cabaSTejun Heo 	unsigned long flags;
23248930cabaSTejun Heo 
23258930cabaSTejun Heo 	local_irq_save(flags);
2326c1a220e7SZhang Rui 
232722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
23284690c4abSTejun Heo 		__queue_work(cpu, wq, work);
2329d4283e93STejun Heo 		ret = true;
2330c1a220e7SZhang Rui 	}
23318930cabaSTejun Heo 
23328930cabaSTejun Heo 	local_irq_restore(flags);
2333c1a220e7SZhang Rui 	return ret;
2334c1a220e7SZhang Rui }
2335ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
2336c1a220e7SZhang Rui 
23378204e0c1SAlexander Duyck /**
2338fef59c9cSTejun Heo  * select_numa_node_cpu - Select a CPU based on NUMA node
23398204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
23408204e0c1SAlexander Duyck  *
23418204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
23428204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
23438204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
23448204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
23458204e0c1SAlexander Duyck  */
2346fef59c9cSTejun Heo static int select_numa_node_cpu(int node)
23478204e0c1SAlexander Duyck {
23488204e0c1SAlexander Duyck 	int cpu;
23498204e0c1SAlexander Duyck 
23508204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
23518204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
23528204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
23538204e0c1SAlexander Duyck 
23548204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
23558204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
23568204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
23578204e0c1SAlexander Duyck 		return cpu;
23588204e0c1SAlexander Duyck 
23598204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
23608204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
23618204e0c1SAlexander Duyck 
23628204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
23638204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
23648204e0c1SAlexander Duyck }
23658204e0c1SAlexander Duyck 
23668204e0c1SAlexander Duyck /**
23678204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
23688204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
23698204e0c1SAlexander Duyck  * @wq: workqueue to use
23708204e0c1SAlexander Duyck  * @work: work to queue
23718204e0c1SAlexander Duyck  *
23728204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
23738204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
23748204e0c1SAlexander Duyck  * NUMA node.
23758204e0c1SAlexander Duyck  *
23768204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
23778204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
23788204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
23798204e0c1SAlexander Duyck  *
23808204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
23818204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
23828204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
23838204e0c1SAlexander Duyck  *
23848204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
23858204e0c1SAlexander Duyck  */
23868204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
23878204e0c1SAlexander Duyck 		     struct work_struct *work)
23888204e0c1SAlexander Duyck {
23898204e0c1SAlexander Duyck 	unsigned long flags;
23908204e0c1SAlexander Duyck 	bool ret = false;
23918204e0c1SAlexander Duyck 
23928204e0c1SAlexander Duyck 	/*
23938204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
23948204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
23958204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
23968204e0c1SAlexander Duyck 	 *
23978204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
23988204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
23998204e0c1SAlexander Duyck 	 * some round robin type logic.
24008204e0c1SAlexander Duyck 	 */
24018204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
24028204e0c1SAlexander Duyck 
24038204e0c1SAlexander Duyck 	local_irq_save(flags);
24048204e0c1SAlexander Duyck 
24058204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
2406fef59c9cSTejun Heo 		int cpu = select_numa_node_cpu(node);
24078204e0c1SAlexander Duyck 
24088204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
24098204e0c1SAlexander Duyck 		ret = true;
24108204e0c1SAlexander Duyck 	}
24118204e0c1SAlexander Duyck 
24128204e0c1SAlexander Duyck 	local_irq_restore(flags);
24138204e0c1SAlexander Duyck 	return ret;
24148204e0c1SAlexander Duyck }
24158204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
24168204e0c1SAlexander Duyck 
24178c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
24181da177e4SLinus Torvalds {
24198c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
24201da177e4SLinus Torvalds 
2421e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
242260c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
24231da177e4SLinus Torvalds }
24241438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
24251da177e4SLinus Torvalds 
24267beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
242752bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
24281da177e4SLinus Torvalds {
24297beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
24307beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
24311da177e4SLinus Torvalds 
2432637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
24334b243563SSami Tolvanen 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
2434fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
2435fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
24367beb2edfSTejun Heo 
24378852aac2STejun Heo 	/*
24388852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
24398852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
24408852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
24418852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
24428852aac2STejun Heo 	 */
24438852aac2STejun Heo 	if (!delay) {
24448852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
24458852aac2STejun Heo 		return;
24468852aac2STejun Heo 	}
24478852aac2STejun Heo 
244860c057bcSLai Jiangshan 	dwork->wq = wq;
24491265057fSTejun Heo 	dwork->cpu = cpu;
24507beb2edfSTejun Heo 	timer->expires = jiffies + delay;
24517beb2edfSTejun Heo 
2452aae17ebbSLeonardo Bras 	if (housekeeping_enabled(HK_TYPE_TIMER)) {
2453aae17ebbSLeonardo Bras 		/* If the current cpu is a housekeeping cpu, use it. */
2454aae17ebbSLeonardo Bras 		cpu = smp_processor_id();
2455aae17ebbSLeonardo Bras 		if (!housekeeping_test_cpu(cpu, HK_TYPE_TIMER))
2456aae17ebbSLeonardo Bras 			cpu = housekeeping_any_cpu(HK_TYPE_TIMER);
24577beb2edfSTejun Heo 		add_timer_on(timer, cpu);
2458aae17ebbSLeonardo Bras 	} else {
2459aae17ebbSLeonardo Bras 		if (likely(cpu == WORK_CPU_UNBOUND))
2460041bd12eSTejun Heo 			add_timer(timer);
2461aae17ebbSLeonardo Bras 		else
2462aae17ebbSLeonardo Bras 			add_timer_on(timer, cpu);
2463aae17ebbSLeonardo Bras 	}
24647beb2edfSTejun Heo }
24651da177e4SLinus Torvalds 
24660fcb78c2SRolf Eike Beer /**
24670fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
24680fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
24690fcb78c2SRolf Eike Beer  * @wq: workqueue to use
2470af9997e4SRandy Dunlap  * @dwork: work to queue
24710fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
24720fcb78c2SRolf Eike Beer  *
2473d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
2474715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
2475715f1300STejun Heo  * execution.
24760fcb78c2SRolf Eike Beer  */
2477d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
247852bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
24797a6bc1cdSVenkatesh Pallipadi {
248052bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
2481d4283e93STejun Heo 	bool ret = false;
24828930cabaSTejun Heo 	unsigned long flags;
24838930cabaSTejun Heo 
24848930cabaSTejun Heo 	/* read the comment in __queue_work() */
24858930cabaSTejun Heo 	local_irq_save(flags);
24867a6bc1cdSVenkatesh Pallipadi 
248722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
24887beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
2489d4283e93STejun Heo 		ret = true;
24907a6bc1cdSVenkatesh Pallipadi 	}
24918930cabaSTejun Heo 
24928930cabaSTejun Heo 	local_irq_restore(flags);
24937a6bc1cdSVenkatesh Pallipadi 	return ret;
24947a6bc1cdSVenkatesh Pallipadi }
2495ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
24961da177e4SLinus Torvalds 
2497c8e55f36STejun Heo /**
24988376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
24998376fe22STejun Heo  * @cpu: CPU number to execute work on
25008376fe22STejun Heo  * @wq: workqueue to use
25018376fe22STejun Heo  * @dwork: work to queue
25028376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
25038376fe22STejun Heo  *
25048376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
25058376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
25068376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
25078376fe22STejun Heo  * current state.
25088376fe22STejun Heo  *
2509d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
25108376fe22STejun Heo  * pending and its timer was modified.
25118376fe22STejun Heo  *
2512e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
25138376fe22STejun Heo  * See try_to_grab_pending() for details.
25148376fe22STejun Heo  */
25158376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
25168376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
25178376fe22STejun Heo {
25188376fe22STejun Heo 	unsigned long flags;
25198376fe22STejun Heo 	int ret;
25208376fe22STejun Heo 
25218376fe22STejun Heo 	do {
25228376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
25238376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
25248376fe22STejun Heo 
25258376fe22STejun Heo 	if (likely(ret >= 0)) {
25268376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
25278376fe22STejun Heo 		local_irq_restore(flags);
25288376fe22STejun Heo 	}
25298376fe22STejun Heo 
25308376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
25318376fe22STejun Heo 	return ret;
25328376fe22STejun Heo }
25338376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
25348376fe22STejun Heo 
253505f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
253605f0fe6bSTejun Heo {
253705f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
253805f0fe6bSTejun Heo 
253905f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
254005f0fe6bSTejun Heo 	local_irq_disable();
254105f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
254205f0fe6bSTejun Heo 	local_irq_enable();
254305f0fe6bSTejun Heo }
254405f0fe6bSTejun Heo 
254505f0fe6bSTejun Heo /**
254605f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
254705f0fe6bSTejun Heo  * @wq: workqueue to use
254805f0fe6bSTejun Heo  * @rwork: work to queue
254905f0fe6bSTejun Heo  *
255005f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
255105f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
2552bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
255305f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
255405f0fe6bSTejun Heo  */
255505f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
255605f0fe6bSTejun Heo {
255705f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
255805f0fe6bSTejun Heo 
255905f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
256005f0fe6bSTejun Heo 		rwork->wq = wq;
2561a7e30c0eSUladzislau Rezki 		call_rcu_hurry(&rwork->rcu, rcu_work_rcufn);
256205f0fe6bSTejun Heo 		return true;
256305f0fe6bSTejun Heo 	}
256405f0fe6bSTejun Heo 
256505f0fe6bSTejun Heo 	return false;
256605f0fe6bSTejun Heo }
256705f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
256805f0fe6bSTejun Heo 
2569f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
2570c34056a3STejun Heo {
2571c34056a3STejun Heo 	struct worker *worker;
2572c34056a3STejun Heo 
2573f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
2574c8e55f36STejun Heo 	if (worker) {
2575c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
2576affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
2577da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
2578e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
2579e22bee78STejun Heo 		worker->flags = WORKER_PREP;
2580c8e55f36STejun Heo 	}
2581c34056a3STejun Heo 	return worker;
2582c34056a3STejun Heo }
2583c34056a3STejun Heo 
25849546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool)
25859546b29eSTejun Heo {
25868639ecebSTejun Heo 	if (pool->cpu < 0 && pool->attrs->affn_strict)
25879546b29eSTejun Heo 		return pool->attrs->__pod_cpumask;
25888639ecebSTejun Heo 	else
25898639ecebSTejun Heo 		return pool->attrs->cpumask;
25909546b29eSTejun Heo }
25919546b29eSTejun Heo 
2592c34056a3STejun Heo /**
25934736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
25944736cbf7SLai Jiangshan  * @worker: worker to be attached
25954736cbf7SLai Jiangshan  * @pool: the target pool
25964736cbf7SLai Jiangshan  *
25974736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
25984736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
25994736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
26004736cbf7SLai Jiangshan  */
26014736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
26024736cbf7SLai Jiangshan 				  struct worker_pool *pool)
26034736cbf7SLai Jiangshan {
26041258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
26054736cbf7SLai Jiangshan 
26064736cbf7SLai Jiangshan 	/*
26074cb1ef64STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains stable
26084cb1ef64STejun Heo 	 * across this function. See the comments above the flag definition for
26094cb1ef64STejun Heo 	 * details. BH workers are, while per-CPU, always DISASSOCIATED.
26104736cbf7SLai Jiangshan 	 */
26114cb1ef64STejun Heo 	if (pool->flags & POOL_DISASSOCIATED) {
26124736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
26134cb1ef64STejun Heo 	} else {
26144cb1ef64STejun Heo 		WARN_ON_ONCE(pool->flags & POOL_BH);
26155c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
26164cb1ef64STejun Heo 	}
26174736cbf7SLai Jiangshan 
2618640f17c8SPeter Zijlstra 	if (worker->rescue_wq)
26199546b29eSTejun Heo 		set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool));
2620640f17c8SPeter Zijlstra 
26214736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
2622a2d812a2STejun Heo 	worker->pool = pool;
26234736cbf7SLai Jiangshan 
26241258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
26254736cbf7SLai Jiangshan }
26264736cbf7SLai Jiangshan 
26274736cbf7SLai Jiangshan /**
262860f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
262960f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
263060f5a4bcSLai Jiangshan  *
26314736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
26324736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
26334736cbf7SLai Jiangshan  * other reference to the pool.
263460f5a4bcSLai Jiangshan  */
2635a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
263660f5a4bcSLai Jiangshan {
2637a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
263860f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
263960f5a4bcSLai Jiangshan 
26404cb1ef64STejun Heo 	/* there is one permanent BH worker per CPU which should never detach */
26414cb1ef64STejun Heo 	WARN_ON_ONCE(pool->flags & POOL_BH);
26424cb1ef64STejun Heo 
26431258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2644a2d812a2STejun Heo 
26455c25b5ffSPeter Zijlstra 	kthread_set_per_cpu(worker->task, -1);
2646da028469SLai Jiangshan 	list_del(&worker->node);
2647a2d812a2STejun Heo 	worker->pool = NULL;
2648a2d812a2STejun Heo 
2649e02b9312SValentin Schneider 	if (list_empty(&pool->workers) && list_empty(&pool->dying_workers))
265060f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
26511258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
265260f5a4bcSLai Jiangshan 
2653b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
2654b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
2655b62c0751SLai Jiangshan 
265660f5a4bcSLai Jiangshan 	if (detach_completion)
265760f5a4bcSLai Jiangshan 		complete(detach_completion);
265860f5a4bcSLai Jiangshan }
265960f5a4bcSLai Jiangshan 
266060f5a4bcSLai Jiangshan /**
2661c34056a3STejun Heo  * create_worker - create a new workqueue worker
266263d95a91STejun Heo  * @pool: pool the new worker will belong to
2663c34056a3STejun Heo  *
2664051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
2665c34056a3STejun Heo  *
2666c34056a3STejun Heo  * CONTEXT:
2667c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
2668c34056a3STejun Heo  *
2669d185af30SYacine Belkadi  * Return:
2670c34056a3STejun Heo  * Pointer to the newly created worker.
2671c34056a3STejun Heo  */
2672bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
2673c34056a3STejun Heo {
2674e441b56fSZhen Lei 	struct worker *worker;
2675e441b56fSZhen Lei 	int id;
26765d9c7a1eSLucy Mielke 	char id_buf[23];
2677c34056a3STejun Heo 
26787cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
2679e441b56fSZhen Lei 	id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
26803f0ea0b8SPetr Mladek 	if (id < 0) {
26813f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n",
26823f0ea0b8SPetr Mladek 			    ERR_PTR(id));
2683e441b56fSZhen Lei 		return NULL;
26843f0ea0b8SPetr Mladek 	}
2685c34056a3STejun Heo 
2686f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
26873f0ea0b8SPetr Mladek 	if (!worker) {
26883f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker\n");
2689c34056a3STejun Heo 		goto fail;
26903f0ea0b8SPetr Mladek 	}
2691c34056a3STejun Heo 
2692c34056a3STejun Heo 	worker->id = id;
2693c34056a3STejun Heo 
26944cb1ef64STejun Heo 	if (!(pool->flags & POOL_BH)) {
269529c91e99STejun Heo 		if (pool->cpu >= 0)
2696e3c916a4STejun Heo 			snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
2697e3c916a4STejun Heo 				 pool->attrs->nice < 0  ? "H" : "");
2698f3421797STejun Heo 		else
2699e3c916a4STejun Heo 			snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
2700e3c916a4STejun Heo 
27014cb1ef64STejun Heo 		worker->task = kthread_create_on_node(worker_thread, worker,
27024cb1ef64STejun Heo 					pool->node, "kworker/%s", id_buf);
27033f0ea0b8SPetr Mladek 		if (IS_ERR(worker->task)) {
270460f54038SPetr Mladek 			if (PTR_ERR(worker->task) == -EINTR) {
270560f54038SPetr Mladek 				pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n",
270660f54038SPetr Mladek 				       id_buf);
270760f54038SPetr Mladek 			} else {
27083f0ea0b8SPetr Mladek 				pr_err_once("workqueue: Failed to create a worker thread: %pe",
27093f0ea0b8SPetr Mladek 					    worker->task);
271060f54038SPetr Mladek 			}
2711c34056a3STejun Heo 			goto fail;
27123f0ea0b8SPetr Mladek 		}
2713c34056a3STejun Heo 
271491151228SOleg Nesterov 		set_user_nice(worker->task, pool->attrs->nice);
27159546b29eSTejun Heo 		kthread_bind_mask(worker->task, pool_allowed_cpus(pool));
27164cb1ef64STejun Heo 	}
271791151228SOleg Nesterov 
2718da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
27194736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
2720822d8405STejun Heo 
2721051e1850SLai Jiangshan 	/* start the newly created worker */
2722a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
27230219a352STejun Heo 
2724051e1850SLai Jiangshan 	worker->pool->nr_workers++;
2725051e1850SLai Jiangshan 	worker_enter_idle(worker);
27260219a352STejun Heo 
27270219a352STejun Heo 	/*
27280219a352STejun Heo 	 * @worker is waiting on a completion in kthread() and will trigger hung
27296a229b0eSTejun Heo 	 * check if not woken up soon. As kick_pool() is noop if @pool is empty,
27306a229b0eSTejun Heo 	 * wake it up explicitly.
27310219a352STejun Heo 	 */
27324cb1ef64STejun Heo 	if (worker->task)
2733051e1850SLai Jiangshan 		wake_up_process(worker->task);
27340219a352STejun Heo 
2735a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2736051e1850SLai Jiangshan 
2737c34056a3STejun Heo 	return worker;
2738822d8405STejun Heo 
2739c34056a3STejun Heo fail:
2740e441b56fSZhen Lei 	ida_free(&pool->worker_ida, id);
2741c34056a3STejun Heo 	kfree(worker);
2742c34056a3STejun Heo 	return NULL;
2743c34056a3STejun Heo }
2744c34056a3STejun Heo 
2745793777bcSValentin Schneider static void unbind_worker(struct worker *worker)
2746793777bcSValentin Schneider {
2747793777bcSValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2748793777bcSValentin Schneider 
2749793777bcSValentin Schneider 	kthread_set_per_cpu(worker->task, -1);
2750793777bcSValentin Schneider 	if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask))
2751793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0);
2752793777bcSValentin Schneider 	else
2753793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
2754793777bcSValentin Schneider }
2755793777bcSValentin Schneider 
2756e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list)
2757e02b9312SValentin Schneider {
2758e02b9312SValentin Schneider 	struct worker *worker, *tmp;
2759e02b9312SValentin Schneider 
2760e02b9312SValentin Schneider 	list_for_each_entry_safe(worker, tmp, cull_list, entry) {
2761e02b9312SValentin Schneider 		list_del_init(&worker->entry);
2762e02b9312SValentin Schneider 		unbind_worker(worker);
2763e02b9312SValentin Schneider 		/*
2764e02b9312SValentin Schneider 		 * If the worker was somehow already running, then it had to be
2765e02b9312SValentin Schneider 		 * in pool->idle_list when set_worker_dying() happened or we
2766e02b9312SValentin Schneider 		 * wouldn't have gotten here.
2767c34056a3STejun Heo 		 *
2768e02b9312SValentin Schneider 		 * Thus, the worker must either have observed the WORKER_DIE
2769e02b9312SValentin Schneider 		 * flag, or have set its state to TASK_IDLE. Either way, the
2770e02b9312SValentin Schneider 		 * below will be observed by the worker and is safe to do
2771e02b9312SValentin Schneider 		 * outside of pool->lock.
2772e02b9312SValentin Schneider 		 */
2773e02b9312SValentin Schneider 		wake_up_process(worker->task);
2774e02b9312SValentin Schneider 	}
2775e02b9312SValentin Schneider }
2776e02b9312SValentin Schneider 
2777e02b9312SValentin Schneider /**
2778e02b9312SValentin Schneider  * set_worker_dying - Tag a worker for destruction
2779e02b9312SValentin Schneider  * @worker: worker to be destroyed
2780e02b9312SValentin Schneider  * @list: transfer worker away from its pool->idle_list and into list
2781e02b9312SValentin Schneider  *
2782e02b9312SValentin Schneider  * Tag @worker for destruction and adjust @pool stats accordingly.  The worker
2783e02b9312SValentin Schneider  * should be idle.
2784c8e55f36STejun Heo  *
2785c8e55f36STejun Heo  * CONTEXT:
2786a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2787c34056a3STejun Heo  */
2788e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list)
2789c34056a3STejun Heo {
2790bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2791c34056a3STejun Heo 
2792cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
2793e02b9312SValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2794cd549687STejun Heo 
2795c34056a3STejun Heo 	/* sanity check frenzy */
27966183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
279773eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
279873eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
27996183c009STejun Heo 		return;
2800c34056a3STejun Heo 
2801bd7bdd43STejun Heo 	pool->nr_workers--;
2802bd7bdd43STejun Heo 	pool->nr_idle--;
2803c8e55f36STejun Heo 
2804cb444766STejun Heo 	worker->flags |= WORKER_DIE;
2805e02b9312SValentin Schneider 
2806e02b9312SValentin Schneider 	list_move(&worker->entry, list);
2807e02b9312SValentin Schneider 	list_move(&worker->node, &pool->dying_workers);
2808c34056a3STejun Heo }
2809c34056a3STejun Heo 
28103f959aa3SValentin Schneider /**
28113f959aa3SValentin Schneider  * idle_worker_timeout - check if some idle workers can now be deleted.
28123f959aa3SValentin Schneider  * @t: The pool's idle_timer that just expired
28133f959aa3SValentin Schneider  *
28143f959aa3SValentin Schneider  * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in
28153f959aa3SValentin Schneider  * worker_leave_idle(), as a worker flicking between idle and active while its
28163f959aa3SValentin Schneider  * pool is at the too_many_workers() tipping point would cause too much timer
28173f959aa3SValentin Schneider  * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let
28183f959aa3SValentin Schneider  * it expire and re-evaluate things from there.
28193f959aa3SValentin Schneider  */
282032a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
2821e22bee78STejun Heo {
282232a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
28233f959aa3SValentin Schneider 	bool do_cull = false;
28243f959aa3SValentin Schneider 
28253f959aa3SValentin Schneider 	if (work_pending(&pool->idle_cull_work))
28263f959aa3SValentin Schneider 		return;
28273f959aa3SValentin Schneider 
28283f959aa3SValentin Schneider 	raw_spin_lock_irq(&pool->lock);
28293f959aa3SValentin Schneider 
28303f959aa3SValentin Schneider 	if (too_many_workers(pool)) {
28313f959aa3SValentin Schneider 		struct worker *worker;
28323f959aa3SValentin Schneider 		unsigned long expires;
28333f959aa3SValentin Schneider 
28343f959aa3SValentin Schneider 		/* idle_list is kept in LIFO order, check the last one */
28353f959aa3SValentin Schneider 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
28363f959aa3SValentin Schneider 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
28373f959aa3SValentin Schneider 		do_cull = !time_before(jiffies, expires);
28383f959aa3SValentin Schneider 
28393f959aa3SValentin Schneider 		if (!do_cull)
28403f959aa3SValentin Schneider 			mod_timer(&pool->idle_timer, expires);
28413f959aa3SValentin Schneider 	}
28423f959aa3SValentin Schneider 	raw_spin_unlock_irq(&pool->lock);
28433f959aa3SValentin Schneider 
28443f959aa3SValentin Schneider 	if (do_cull)
28453f959aa3SValentin Schneider 		queue_work(system_unbound_wq, &pool->idle_cull_work);
28463f959aa3SValentin Schneider }
28473f959aa3SValentin Schneider 
28483f959aa3SValentin Schneider /**
28493f959aa3SValentin Schneider  * idle_cull_fn - cull workers that have been idle for too long.
28503f959aa3SValentin Schneider  * @work: the pool's work for handling these idle workers
28513f959aa3SValentin Schneider  *
28523f959aa3SValentin Schneider  * This goes through a pool's idle workers and gets rid of those that have been
28533f959aa3SValentin Schneider  * idle for at least IDLE_WORKER_TIMEOUT seconds.
2854e02b9312SValentin Schneider  *
2855e02b9312SValentin Schneider  * We don't want to disturb isolated CPUs because of a pcpu kworker being
2856e02b9312SValentin Schneider  * culled, so this also resets worker affinity. This requires a sleepable
2857e02b9312SValentin Schneider  * context, hence the split between timer callback and work item.
28583f959aa3SValentin Schneider  */
28593f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work)
28603f959aa3SValentin Schneider {
28613f959aa3SValentin Schneider 	struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work);
28629680540cSYang Yingliang 	LIST_HEAD(cull_list);
2863e22bee78STejun Heo 
2864e02b9312SValentin Schneider 	/*
2865e02b9312SValentin Schneider 	 * Grabbing wq_pool_attach_mutex here ensures an already-running worker
2866e02b9312SValentin Schneider 	 * cannot proceed beyong worker_detach_from_pool() in its self-destruct
2867e02b9312SValentin Schneider 	 * path. This is required as a previously-preempted worker could run after
2868e02b9312SValentin Schneider 	 * set_worker_dying() has happened but before wake_dying_workers() did.
2869e02b9312SValentin Schneider 	 */
2870e02b9312SValentin Schneider 	mutex_lock(&wq_pool_attach_mutex);
2871a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2872e22bee78STejun Heo 
28733347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
2874e22bee78STejun Heo 		struct worker *worker;
2875e22bee78STejun Heo 		unsigned long expires;
2876e22bee78STejun Heo 
287763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2878e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2879e22bee78STejun Heo 
28803347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
288163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
28823347fc9fSLai Jiangshan 			break;
2883e22bee78STejun Heo 		}
28843347fc9fSLai Jiangshan 
2885e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
2886e22bee78STejun Heo 	}
2887e22bee78STejun Heo 
2888a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2889e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
2890e02b9312SValentin Schneider 	mutex_unlock(&wq_pool_attach_mutex);
2891e22bee78STejun Heo }
2892e22bee78STejun Heo 
2893493a1724STejun Heo static void send_mayday(struct work_struct *work)
2894e22bee78STejun Heo {
2895112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2896112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2897493a1724STejun Heo 
28982e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2899e22bee78STejun Heo 
2900493008a8STejun Heo 	if (!wq->rescuer)
2901493a1724STejun Heo 		return;
2902e22bee78STejun Heo 
2903e22bee78STejun Heo 	/* mayday mayday mayday */
2904493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
290577668c8bSLai Jiangshan 		/*
290677668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
290777668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
290877668c8bSLai Jiangshan 		 * rescuer is done with it.
290977668c8bSLai Jiangshan 		 */
291077668c8bSLai Jiangshan 		get_pwq(pwq);
2911493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2912e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2913725e8ec5STejun Heo 		pwq->stats[PWQ_STAT_MAYDAY]++;
2914493a1724STejun Heo 	}
2915e22bee78STejun Heo }
2916e22bee78STejun Heo 
291732a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2918e22bee78STejun Heo {
291932a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2920e22bee78STejun Heo 	struct work_struct *work;
2921e22bee78STejun Heo 
2922a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2923a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2924e22bee78STejun Heo 
292563d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2926e22bee78STejun Heo 		/*
2927e22bee78STejun Heo 		 * We've been trying to create a new worker but
2928e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2929e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2930e22bee78STejun Heo 		 * rescuers.
2931e22bee78STejun Heo 		 */
293263d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2933e22bee78STejun Heo 			send_mayday(work);
2934e22bee78STejun Heo 	}
2935e22bee78STejun Heo 
2936a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&wq_mayday_lock);
2937a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2938e22bee78STejun Heo 
293963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2940e22bee78STejun Heo }
2941e22bee78STejun Heo 
2942e22bee78STejun Heo /**
2943e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
294463d95a91STejun Heo  * @pool: pool to create a new worker for
2945e22bee78STejun Heo  *
294663d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2947e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2948e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
294963d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2950e22bee78STejun Heo  * possible allocation deadlock.
2951e22bee78STejun Heo  *
2952c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2953c5aa87bbSTejun Heo  * may_start_working() %true.
2954e22bee78STejun Heo  *
2955e22bee78STejun Heo  * LOCKING:
2956a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2957e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2958e22bee78STejun Heo  * manager.
2959e22bee78STejun Heo  */
296029187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2961d565ed63STejun Heo __releases(&pool->lock)
2962d565ed63STejun Heo __acquires(&pool->lock)
2963e22bee78STejun Heo {
2964e22bee78STejun Heo restart:
2965a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
29669f9c2364STejun Heo 
2967e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
296863d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2969e22bee78STejun Heo 
2970e22bee78STejun Heo 	while (true) {
2971051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2972e22bee78STejun Heo 			break;
2973e22bee78STejun Heo 
2974e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
29759f9c2364STejun Heo 
297663d95a91STejun Heo 		if (!need_to_create_worker(pool))
2977e22bee78STejun Heo 			break;
2978e22bee78STejun Heo 	}
2979e22bee78STejun Heo 
298063d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2981a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2982051e1850SLai Jiangshan 	/*
2983051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
2984051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
2985051e1850SLai Jiangshan 	 * already become busy.
2986051e1850SLai Jiangshan 	 */
298763d95a91STejun Heo 	if (need_to_create_worker(pool))
2988e22bee78STejun Heo 		goto restart;
2989e22bee78STejun Heo }
2990e22bee78STejun Heo 
2991e22bee78STejun Heo /**
2992e22bee78STejun Heo  * manage_workers - manage worker pool
2993e22bee78STejun Heo  * @worker: self
2994e22bee78STejun Heo  *
2995706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2996e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2997706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2998e22bee78STejun Heo  *
2999e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
3000e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
3001e22bee78STejun Heo  * and may_start_working() is true.
3002e22bee78STejun Heo  *
3003e22bee78STejun Heo  * CONTEXT:
3004a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3005e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
3006e22bee78STejun Heo  *
3007d185af30SYacine Belkadi  * Return:
300829187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
300929187a9eSTejun Heo  * start processing works, %true if management function was performed and
301029187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
301129187a9eSTejun Heo  * no longer be true.
3012e22bee78STejun Heo  */
3013e22bee78STejun Heo static bool manage_workers(struct worker *worker)
3014e22bee78STejun Heo {
301563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
3016e22bee78STejun Heo 
3017692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
301829187a9eSTejun Heo 		return false;
3019692b4825STejun Heo 
3020692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
30212607d7a6STejun Heo 	pool->manager = worker;
3022e22bee78STejun Heo 
302329187a9eSTejun Heo 	maybe_create_worker(pool);
3024e22bee78STejun Heo 
30252607d7a6STejun Heo 	pool->manager = NULL;
3026692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
3027d8bb65abSSebastian Andrzej Siewior 	rcuwait_wake_up(&manager_wait);
302829187a9eSTejun Heo 	return true;
3029e22bee78STejun Heo }
3030e22bee78STejun Heo 
3031a62428c0STejun Heo /**
3032a62428c0STejun Heo  * process_one_work - process single work
3033c34056a3STejun Heo  * @worker: self
3034a62428c0STejun Heo  * @work: work to process
3035a62428c0STejun Heo  *
3036a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
3037a62428c0STejun Heo  * process a single work including synchronization against and
3038a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
3039a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
3040a62428c0STejun Heo  * call this function to process a work.
3041a62428c0STejun Heo  *
3042a62428c0STejun Heo  * CONTEXT:
3043a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
3044a62428c0STejun Heo  */
3045c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
3046d565ed63STejun Heo __releases(&pool->lock)
3047d565ed63STejun Heo __acquires(&pool->lock)
30481da177e4SLinus Torvalds {
3049112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
3050bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
3051c4560c2cSLai Jiangshan 	unsigned long work_data;
3052c35aea39STejun Heo 	int lockdep_start_depth, rcu_start_depth;
30534e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
30544e6045f1SJohannes Berg 	/*
3055a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
3056a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
3057a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
3058a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
3059a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
30604e6045f1SJohannes Berg 	 */
30614d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
30624d82a1deSPeter Zijlstra 
30634d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
30644e6045f1SJohannes Berg #endif
3065807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
306685327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
3067ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
306825511a47STejun Heo 
30698930cabaSTejun Heo 	/* claim and dequeue */
3070dc186ad7SThomas Gleixner 	debug_work_deactivate(work);
3071c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
3072c34056a3STejun Heo 	worker->current_work = work;
3073a2c1c57bSTejun Heo 	worker->current_func = work->func;
3074112202d9STejun Heo 	worker->current_pwq = pwq;
30754cb1ef64STejun Heo 	if (worker->task)
3076616db877STejun Heo 		worker->current_at = worker->task->se.sum_exec_runtime;
3077c4560c2cSLai Jiangshan 	work_data = *work_data_bits(work);
3078d812796eSLai Jiangshan 	worker->current_color = get_work_color(work_data);
30797a22ad75STejun Heo 
30808bf89593STejun Heo 	/*
30818bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
30828bf89593STejun Heo 	 * overridden through set_worker_desc().
30838bf89593STejun Heo 	 */
30848bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
30858bf89593STejun Heo 
3086a62428c0STejun Heo 	list_del_init(&work->entry);
3087a62428c0STejun Heo 
3088649027d7STejun Heo 	/*
3089228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
3090228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
3091228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
3092228f1d00SLai Jiangshan 	 * execution of the pending work items.
3093fb0e7bebSTejun Heo 	 */
3094616db877STejun Heo 	if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE))
3095228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
3096fb0e7bebSTejun Heo 
3097974271c4STejun Heo 	/*
30980219a352STejun Heo 	 * Kick @pool if necessary. It's always noop for per-cpu worker pools
30990219a352STejun Heo 	 * since nr_running would always be >= 1 at this point. This is used to
31000219a352STejun Heo 	 * chain execution of the pending work items for WORKER_NOT_RUNNING
31010219a352STejun Heo 	 * workers such as the UNBOUND and CPU_INTENSIVE ones.
3102974271c4STejun Heo 	 */
31030219a352STejun Heo 	kick_pool(pool);
3104974271c4STejun Heo 
31058930cabaSTejun Heo 	/*
31067c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
3107d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
310823657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
310923657bb1STejun Heo 	 * disabled.
31108930cabaSTejun Heo 	 */
31117c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
31121da177e4SLinus Torvalds 
3113fe48ba7dSMirsad Goran Todorovac 	pwq->stats[PWQ_STAT_STARTED]++;
3114a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3115365970a1SDavid Howells 
3116c35aea39STejun Heo 	rcu_start_depth = rcu_preempt_depth();
3117c35aea39STejun Heo 	lockdep_start_depth = lockdep_depth(current);
3118a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
31193295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
3120e6f3faa7SPeter Zijlstra 	/*
3121f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
3122f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
3123e6f3faa7SPeter Zijlstra 	 *
3124e6f3faa7SPeter Zijlstra 	 * However, that would result in:
3125e6f3faa7SPeter Zijlstra 	 *
3126e6f3faa7SPeter Zijlstra 	 *   A(W1)
3127e6f3faa7SPeter Zijlstra 	 *   WFC(C)
3128e6f3faa7SPeter Zijlstra 	 *		A(W1)
3129e6f3faa7SPeter Zijlstra 	 *		C(C)
3130e6f3faa7SPeter Zijlstra 	 *
3131e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
3132e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
3133e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
3134f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
3135e6f3faa7SPeter Zijlstra 	 * these locks.
3136e6f3faa7SPeter Zijlstra 	 *
3137e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
3138e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
3139e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
3140e6f3faa7SPeter Zijlstra 	 */
3141f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
3142e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
3143a2c1c57bSTejun Heo 	worker->current_func(work);
3144e36c886aSArjan van de Ven 	/*
3145e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
3146e36c886aSArjan van de Ven 	 * point will only record its address.
3147e36c886aSArjan van de Ven 	 */
31481c5da0ecSDaniel Jordan 	trace_workqueue_execute_end(work, worker->current_func);
3149725e8ec5STejun Heo 	pwq->stats[PWQ_STAT_COMPLETED]++;
31503295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
3151112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
31521da177e4SLinus Torvalds 
3153c35aea39STejun Heo 	if (unlikely((worker->task && in_atomic()) ||
3154c35aea39STejun Heo 		     lockdep_depth(current) != lockdep_start_depth ||
3155c35aea39STejun Heo 		     rcu_preempt_depth() != rcu_start_depth)) {
3156c35aea39STejun Heo 		pr_err("BUG: workqueue leaked atomic, lock or RCU: %s[%d]\n"
3157c35aea39STejun Heo 		       "     preempt=0x%08x lock=%d->%d RCU=%d->%d workfn=%ps\n",
3158c35aea39STejun Heo 		       current->comm, task_pid_nr(current), preempt_count(),
3159c35aea39STejun Heo 		       lockdep_start_depth, lockdep_depth(current),
3160c35aea39STejun Heo 		       rcu_start_depth, rcu_preempt_depth(),
3161c35aea39STejun Heo 		       worker->current_func);
3162d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
3163d5abe669SPeter Zijlstra 		dump_stack();
3164d5abe669SPeter Zijlstra 	}
3165d5abe669SPeter Zijlstra 
3166b22ce278STejun Heo 	/*
3167025f50f3SSebastian Andrzej Siewior 	 * The following prevents a kworker from hogging CPU on !PREEMPTION
3168b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
3169b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
3170b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
3171789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
3172789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
3173b22ce278STejun Heo 	 */
31744cb1ef64STejun Heo 	if (worker->task)
3175a7e6425eSPaul E. McKenney 		cond_resched();
3176b22ce278STejun Heo 
3177a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3178a62428c0STejun Heo 
3179616db877STejun Heo 	/*
3180616db877STejun Heo 	 * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked
3181616db877STejun Heo 	 * CPU intensive by wq_worker_tick() if @work hogged CPU longer than
3182616db877STejun Heo 	 * wq_cpu_intensive_thresh_us. Clear it.
3183616db877STejun Heo 	 */
3184fb0e7bebSTejun Heo 	worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
3185fb0e7bebSTejun Heo 
31861b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
31871b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
31881b69ac6bSJohannes Weiner 
3189a62428c0STejun Heo 	/* we're done with it, release */
319042f8570fSSasha Levin 	hash_del(&worker->hentry);
3191c34056a3STejun Heo 	worker->current_work = NULL;
3192a2c1c57bSTejun Heo 	worker->current_func = NULL;
3193112202d9STejun Heo 	worker->current_pwq = NULL;
3194d812796eSLai Jiangshan 	worker->current_color = INT_MAX;
3195dd6c3c54STejun Heo 
3196dd6c3c54STejun Heo 	/* must be the last step, see the function comment */
3197c4560c2cSLai Jiangshan 	pwq_dec_nr_in_flight(pwq, work_data);
31981da177e4SLinus Torvalds }
31991da177e4SLinus Torvalds 
3200affee4b2STejun Heo /**
3201affee4b2STejun Heo  * process_scheduled_works - process scheduled works
3202affee4b2STejun Heo  * @worker: self
3203affee4b2STejun Heo  *
3204affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
3205affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
3206affee4b2STejun Heo  * fetches a work from the top and executes it.
3207affee4b2STejun Heo  *
3208affee4b2STejun Heo  * CONTEXT:
3209a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3210affee4b2STejun Heo  * multiple times.
3211affee4b2STejun Heo  */
3212affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
32131da177e4SLinus Torvalds {
3214c0ab017dSTejun Heo 	struct work_struct *work;
3215c0ab017dSTejun Heo 	bool first = true;
3216c0ab017dSTejun Heo 
3217c0ab017dSTejun Heo 	while ((work = list_first_entry_or_null(&worker->scheduled,
3218c0ab017dSTejun Heo 						struct work_struct, entry))) {
3219c0ab017dSTejun Heo 		if (first) {
3220c0ab017dSTejun Heo 			worker->pool->watchdog_ts = jiffies;
3221c0ab017dSTejun Heo 			first = false;
3222c0ab017dSTejun Heo 		}
3223c34056a3STejun Heo 		process_one_work(worker, work);
3224a62428c0STejun Heo 	}
32251da177e4SLinus Torvalds }
32261da177e4SLinus Torvalds 
3227197f6accSTejun Heo static void set_pf_worker(bool val)
3228197f6accSTejun Heo {
3229197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3230197f6accSTejun Heo 	if (val)
3231197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
3232197f6accSTejun Heo 	else
3233197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
3234197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
3235197f6accSTejun Heo }
3236197f6accSTejun Heo 
32374690c4abSTejun Heo /**
32384690c4abSTejun Heo  * worker_thread - the worker thread function
3239c34056a3STejun Heo  * @__worker: self
32404690c4abSTejun Heo  *
3241c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
3242c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
3243c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
3244c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
3245c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
3246d185af30SYacine Belkadi  *
3247d185af30SYacine Belkadi  * Return: 0
32484690c4abSTejun Heo  */
3249c34056a3STejun Heo static int worker_thread(void *__worker)
32501da177e4SLinus Torvalds {
3251c34056a3STejun Heo 	struct worker *worker = __worker;
3252bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
32531da177e4SLinus Torvalds 
3254e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
3255197f6accSTejun Heo 	set_pf_worker(true);
3256c8e55f36STejun Heo woke_up:
3257a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3258affee4b2STejun Heo 
3259a9ab775bSTejun Heo 	/* am I supposed to die? */
3260a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
3261a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
3262197f6accSTejun Heo 		set_pf_worker(false);
326360f5a4bcSLai Jiangshan 
326460f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
3265e441b56fSZhen Lei 		ida_free(&pool->worker_ida, worker->id);
3266a2d812a2STejun Heo 		worker_detach_from_pool(worker);
3267e02b9312SValentin Schneider 		WARN_ON_ONCE(!list_empty(&worker->entry));
326860f5a4bcSLai Jiangshan 		kfree(worker);
3269c8e55f36STejun Heo 		return 0;
3270c8e55f36STejun Heo 	}
3271c8e55f36STejun Heo 
3272c8e55f36STejun Heo 	worker_leave_idle(worker);
3273db7bccf4STejun Heo recheck:
3274e22bee78STejun Heo 	/* no more worker necessary? */
327563d95a91STejun Heo 	if (!need_more_worker(pool))
3276e22bee78STejun Heo 		goto sleep;
3277e22bee78STejun Heo 
3278e22bee78STejun Heo 	/* do we need to manage? */
327963d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
3280e22bee78STejun Heo 		goto recheck;
3281e22bee78STejun Heo 
3282c8e55f36STejun Heo 	/*
3283c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
3284c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
3285c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
3286c8e55f36STejun Heo 	 */
32876183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
3288c8e55f36STejun Heo 
3289e22bee78STejun Heo 	/*
3290a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
3291a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
3292a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
3293a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
3294a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
3295e22bee78STejun Heo 	 */
3296a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
3297e22bee78STejun Heo 
3298e22bee78STejun Heo 	do {
3299affee4b2STejun Heo 		struct work_struct *work =
3300bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
3301affee4b2STejun Heo 					 struct work_struct, entry);
3302affee4b2STejun Heo 
3303873eaca6STejun Heo 		if (assign_work(work, worker, NULL))
3304affee4b2STejun Heo 			process_scheduled_works(worker);
330563d95a91STejun Heo 	} while (keep_working(pool));
3306affee4b2STejun Heo 
3307228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
3308d313dd85STejun Heo sleep:
3309c8e55f36STejun Heo 	/*
3310d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
3311d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
3312d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
3313d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
3314d565ed63STejun Heo 	 * event.
3315c8e55f36STejun Heo 	 */
3316c8e55f36STejun Heo 	worker_enter_idle(worker);
3317c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
3318a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
33191da177e4SLinus Torvalds 	schedule();
3320c8e55f36STejun Heo 	goto woke_up;
33211da177e4SLinus Torvalds }
33221da177e4SLinus Torvalds 
3323e22bee78STejun Heo /**
3324e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
3325111c225aSTejun Heo  * @__rescuer: self
3326e22bee78STejun Heo  *
3327e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
3328493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
3329e22bee78STejun Heo  *
3330706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
3331e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
3332e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
3333e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
3334e22bee78STejun Heo  * the problem rescuer solves.
3335e22bee78STejun Heo  *
3336706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
3337706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
3338e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
3339e22bee78STejun Heo  *
3340e22bee78STejun Heo  * This should happen rarely.
3341d185af30SYacine Belkadi  *
3342d185af30SYacine Belkadi  * Return: 0
3343e22bee78STejun Heo  */
3344111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
3345e22bee78STejun Heo {
3346111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
3347111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
33484d595b86SLai Jiangshan 	bool should_stop;
3349e22bee78STejun Heo 
3350e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
3351111c225aSTejun Heo 
3352111c225aSTejun Heo 	/*
3353111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
3354111c225aSTejun Heo 	 * doesn't participate in concurrency management.
3355111c225aSTejun Heo 	 */
3356197f6accSTejun Heo 	set_pf_worker(true);
3357e22bee78STejun Heo repeat:
3358c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
33591da177e4SLinus Torvalds 
33604d595b86SLai Jiangshan 	/*
33614d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
33624d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
33634d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
33644d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
33654d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
33664d595b86SLai Jiangshan 	 * list is always empty on exit.
33674d595b86SLai Jiangshan 	 */
33684d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
33691da177e4SLinus Torvalds 
3370493a1724STejun Heo 	/* see whether any pwq is asking for help */
3371a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq_mayday_lock);
3372493a1724STejun Heo 
3373493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
3374493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
3375493a1724STejun Heo 					struct pool_workqueue, mayday_node);
3376112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
3377e22bee78STejun Heo 		struct work_struct *work, *n;
3378e22bee78STejun Heo 
3379e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
3380493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
3381493a1724STejun Heo 
3382a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
3383e22bee78STejun Heo 
338451697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
338551697d39SLai Jiangshan 
3386a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
3387e22bee78STejun Heo 
3388e22bee78STejun Heo 		/*
3389e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
3390e22bee78STejun Heo 		 * process'em.
3391e22bee78STejun Heo 		 */
3392873eaca6STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
339382607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
3394873eaca6STejun Heo 			if (get_work_pwq(work) == pwq &&
3395873eaca6STejun Heo 			    assign_work(work, rescuer, &n))
3396725e8ec5STejun Heo 				pwq->stats[PWQ_STAT_RESCUED]++;
339782607adcSTejun Heo 		}
3398e22bee78STejun Heo 
3399873eaca6STejun Heo 		if (!list_empty(&rescuer->scheduled)) {
3400e22bee78STejun Heo 			process_scheduled_works(rescuer);
34017576958aSTejun Heo 
34027576958aSTejun Heo 			/*
3403008847f6SNeilBrown 			 * The above execution of rescued work items could
3404008847f6SNeilBrown 			 * have created more to rescue through
3405f97a4a1aSLai Jiangshan 			 * pwq_activate_first_inactive() or chained
3406008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
3407008847f6SNeilBrown 			 * that such back-to-back work items, which may be
3408008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
3409008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
3410008847f6SNeilBrown 			 */
34114f3f4cf3SLai Jiangshan 			if (pwq->nr_active && need_to_create_worker(pool)) {
3412a9b8a985SSebastian Andrzej Siewior 				raw_spin_lock(&wq_mayday_lock);
3413e66b39afSTejun Heo 				/*
3414e66b39afSTejun Heo 				 * Queue iff we aren't racing destruction
3415e66b39afSTejun Heo 				 * and somebody else hasn't queued it already.
3416e66b39afSTejun Heo 				 */
3417e66b39afSTejun Heo 				if (wq->rescuer && list_empty(&pwq->mayday_node)) {
3418008847f6SNeilBrown 					get_pwq(pwq);
3419e66b39afSTejun Heo 					list_add_tail(&pwq->mayday_node, &wq->maydays);
3420e66b39afSTejun Heo 				}
3421a9b8a985SSebastian Andrzej Siewior 				raw_spin_unlock(&wq_mayday_lock);
3422008847f6SNeilBrown 			}
3423008847f6SNeilBrown 		}
3424008847f6SNeilBrown 
3425008847f6SNeilBrown 		/*
342677668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
342713b1d625SLai Jiangshan 		 * go away while we're still attached to it.
342877668c8bSLai Jiangshan 		 */
342977668c8bSLai Jiangshan 		put_pwq(pwq);
343077668c8bSLai Jiangshan 
343177668c8bSLai Jiangshan 		/*
34320219a352STejun Heo 		 * Leave this pool. Notify regular workers; otherwise, we end up
34330219a352STejun Heo 		 * with 0 concurrency and stalling the execution.
34347576958aSTejun Heo 		 */
34350219a352STejun Heo 		kick_pool(pool);
34367576958aSTejun Heo 
3437a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
343813b1d625SLai Jiangshan 
3439a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
344013b1d625SLai Jiangshan 
3441a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
34421da177e4SLinus Torvalds 	}
34431da177e4SLinus Torvalds 
3444a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq_mayday_lock);
3445493a1724STejun Heo 
34464d595b86SLai Jiangshan 	if (should_stop) {
34474d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
3448197f6accSTejun Heo 		set_pf_worker(false);
34494d595b86SLai Jiangshan 		return 0;
34504d595b86SLai Jiangshan 	}
34514d595b86SLai Jiangshan 
3452111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
3453111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
3454e22bee78STejun Heo 	schedule();
3455e22bee78STejun Heo 	goto repeat;
34561da177e4SLinus Torvalds }
34571da177e4SLinus Torvalds 
34584cb1ef64STejun Heo static void bh_worker(struct worker *worker)
34594cb1ef64STejun Heo {
34604cb1ef64STejun Heo 	struct worker_pool *pool = worker->pool;
34614cb1ef64STejun Heo 	int nr_restarts = BH_WORKER_RESTARTS;
34624cb1ef64STejun Heo 	unsigned long end = jiffies + BH_WORKER_JIFFIES;
34634cb1ef64STejun Heo 
34644cb1ef64STejun Heo 	raw_spin_lock_irq(&pool->lock);
34654cb1ef64STejun Heo 	worker_leave_idle(worker);
34664cb1ef64STejun Heo 
34674cb1ef64STejun Heo 	/*
34684cb1ef64STejun Heo 	 * This function follows the structure of worker_thread(). See there for
34694cb1ef64STejun Heo 	 * explanations on each step.
34704cb1ef64STejun Heo 	 */
34714cb1ef64STejun Heo 	if (!need_more_worker(pool))
34724cb1ef64STejun Heo 		goto done;
34734cb1ef64STejun Heo 
34744cb1ef64STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
34754cb1ef64STejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
34764cb1ef64STejun Heo 
34774cb1ef64STejun Heo 	do {
34784cb1ef64STejun Heo 		struct work_struct *work =
34794cb1ef64STejun Heo 			list_first_entry(&pool->worklist,
34804cb1ef64STejun Heo 					 struct work_struct, entry);
34814cb1ef64STejun Heo 
34824cb1ef64STejun Heo 		if (assign_work(work, worker, NULL))
34834cb1ef64STejun Heo 			process_scheduled_works(worker);
34844cb1ef64STejun Heo 	} while (keep_working(pool) &&
34854cb1ef64STejun Heo 		 --nr_restarts && time_before(jiffies, end));
34864cb1ef64STejun Heo 
34874cb1ef64STejun Heo 	worker_set_flags(worker, WORKER_PREP);
34884cb1ef64STejun Heo done:
34894cb1ef64STejun Heo 	worker_enter_idle(worker);
34904cb1ef64STejun Heo 	kick_pool(pool);
34914cb1ef64STejun Heo 	raw_spin_unlock_irq(&pool->lock);
34924cb1ef64STejun Heo }
34934cb1ef64STejun Heo 
34944cb1ef64STejun Heo /*
34954cb1ef64STejun Heo  * TODO: Convert all tasklet users to workqueue and use softirq directly.
34964cb1ef64STejun Heo  *
34974cb1ef64STejun Heo  * This is currently called from tasklet[_hi]action() and thus is also called
34984cb1ef64STejun Heo  * whenever there are tasklets to run. Let's do an early exit if there's nothing
34994cb1ef64STejun Heo  * queued. Once conversion from tasklet is complete, the need_more_worker() test
35004cb1ef64STejun Heo  * can be dropped.
35014cb1ef64STejun Heo  *
35024cb1ef64STejun Heo  * After full conversion, we'll add worker->softirq_action, directly use the
35034cb1ef64STejun Heo  * softirq action and obtain the worker pointer from the softirq_action pointer.
35044cb1ef64STejun Heo  */
35054cb1ef64STejun Heo void workqueue_softirq_action(bool highpri)
35064cb1ef64STejun Heo {
35074cb1ef64STejun Heo 	struct worker_pool *pool =
35084cb1ef64STejun Heo 		&per_cpu(bh_worker_pools, smp_processor_id())[highpri];
35094cb1ef64STejun Heo 	if (need_more_worker(pool))
35104cb1ef64STejun Heo 		bh_worker(list_first_entry(&pool->workers, struct worker, node));
35114cb1ef64STejun Heo }
35124cb1ef64STejun Heo 
3513fca839c0STejun Heo /**
3514fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
3515fca839c0STejun Heo  * @target_wq: workqueue being flushed
3516fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
3517fca839c0STejun Heo  *
3518fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
3519fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
3520fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
3521fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
3522fca839c0STejun Heo  * a deadlock.
3523fca839c0STejun Heo  */
3524fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
3525fca839c0STejun Heo 				   struct work_struct *target_work)
3526fca839c0STejun Heo {
3527fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
3528fca839c0STejun Heo 	struct worker *worker;
3529fca839c0STejun Heo 
3530fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
3531fca839c0STejun Heo 		return;
3532fca839c0STejun Heo 
3533fca839c0STejun Heo 	worker = current_wq_worker();
3534fca839c0STejun Heo 
3535fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
3536d75f773cSSakari Ailus 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
3537fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
353823d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
353923d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
3540d75f773cSSakari Ailus 		  "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
3541fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
3542fca839c0STejun Heo 		  target_wq->name, target_func);
3543fca839c0STejun Heo }
3544fca839c0STejun Heo 
3545fc2e4d70SOleg Nesterov struct wq_barrier {
3546fc2e4d70SOleg Nesterov 	struct work_struct	work;
3547fc2e4d70SOleg Nesterov 	struct completion	done;
35482607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
3549fc2e4d70SOleg Nesterov };
3550fc2e4d70SOleg Nesterov 
3551fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
3552fc2e4d70SOleg Nesterov {
3553fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
3554fc2e4d70SOleg Nesterov 	complete(&barr->done);
3555fc2e4d70SOleg Nesterov }
3556fc2e4d70SOleg Nesterov 
35574690c4abSTejun Heo /**
35584690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
3559112202d9STejun Heo  * @pwq: pwq to insert barrier into
35604690c4abSTejun Heo  * @barr: wq_barrier to insert
3561affee4b2STejun Heo  * @target: target work to attach @barr to
3562affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
35634690c4abSTejun Heo  *
3564affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
3565affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
3566affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
3567affee4b2STejun Heo  * cpu.
3568affee4b2STejun Heo  *
3569affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
3570affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
3571affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
3572affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
3573affee4b2STejun Heo  * after a work with LINKED flag set.
3574affee4b2STejun Heo  *
3575affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
3576112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
35774690c4abSTejun Heo  *
35784690c4abSTejun Heo  * CONTEXT:
3579a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
35804690c4abSTejun Heo  */
3581112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
3582affee4b2STejun Heo 			      struct wq_barrier *barr,
3583affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
3584fc2e4d70SOleg Nesterov {
35854cb1ef64STejun Heo 	static __maybe_unused struct lock_class_key bh_key, thr_key;
3586d812796eSLai Jiangshan 	unsigned int work_flags = 0;
3587d812796eSLai Jiangshan 	unsigned int work_color;
3588affee4b2STejun Heo 	struct list_head *head;
3589affee4b2STejun Heo 
3590dc186ad7SThomas Gleixner 	/*
3591d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
3592dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
3593dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
3594dc186ad7SThomas Gleixner 	 * might deadlock.
35954cb1ef64STejun Heo 	 *
35964cb1ef64STejun Heo 	 * BH and threaded workqueues need separate lockdep keys to avoid
35974cb1ef64STejun Heo 	 * spuriously triggering "inconsistent {SOFTIRQ-ON-W} -> {IN-SOFTIRQ-W}
35984cb1ef64STejun Heo 	 * usage".
3599dc186ad7SThomas Gleixner 	 */
36004cb1ef64STejun Heo 	INIT_WORK_ONSTACK_KEY(&barr->work, wq_barrier_func,
36014cb1ef64STejun Heo 			      (pwq->wq->flags & WQ_BH) ? &bh_key : &thr_key);
360222df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
360352fa5bc5SBoqun Feng 
3604fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
3605fd1a5b04SByungchul Park 
36062607d7a6STejun Heo 	barr->task = current;
360783c22520SOleg Nesterov 
36085797b1c1STejun Heo 	/* The barrier work item does not participate in nr_active. */
3609018f3a13SLai Jiangshan 	work_flags |= WORK_STRUCT_INACTIVE;
3610018f3a13SLai Jiangshan 
3611affee4b2STejun Heo 	/*
3612affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
3613affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
3614affee4b2STejun Heo 	 */
3615d812796eSLai Jiangshan 	if (worker) {
3616affee4b2STejun Heo 		head = worker->scheduled.next;
3617d812796eSLai Jiangshan 		work_color = worker->current_color;
3618d812796eSLai Jiangshan 	} else {
3619affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
3620affee4b2STejun Heo 
3621affee4b2STejun Heo 		head = target->entry.next;
3622affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
3623d21cece0SLai Jiangshan 		work_flags |= *bits & WORK_STRUCT_LINKED;
3624d812796eSLai Jiangshan 		work_color = get_work_color(*bits);
3625affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
3626affee4b2STejun Heo 	}
3627affee4b2STejun Heo 
3628d812796eSLai Jiangshan 	pwq->nr_in_flight[work_color]++;
3629d812796eSLai Jiangshan 	work_flags |= work_color_to_flags(work_color);
3630d812796eSLai Jiangshan 
3631d21cece0SLai Jiangshan 	insert_work(pwq, &barr->work, head, work_flags);
3632fc2e4d70SOleg Nesterov }
3633fc2e4d70SOleg Nesterov 
363473f53c4aSTejun Heo /**
3635112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
363673f53c4aSTejun Heo  * @wq: workqueue being flushed
363773f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
363873f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
363973f53c4aSTejun Heo  *
3640112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
364173f53c4aSTejun Heo  *
3642112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
3643112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
3644112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
3645112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
3646112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
364773f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
364873f53c4aSTejun Heo  *
364973f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
365073f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
365173f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
365273f53c4aSTejun Heo  * is returned.
365373f53c4aSTejun Heo  *
3654112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
365573f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
365673f53c4aSTejun Heo  * advanced to @work_color.
365773f53c4aSTejun Heo  *
365873f53c4aSTejun Heo  * CONTEXT:
36593c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
366073f53c4aSTejun Heo  *
3661d185af30SYacine Belkadi  * Return:
366273f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
366373f53c4aSTejun Heo  * otherwise.
366473f53c4aSTejun Heo  */
3665112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
366673f53c4aSTejun Heo 				      int flush_color, int work_color)
36671da177e4SLinus Torvalds {
366873f53c4aSTejun Heo 	bool wait = false;
366949e3cf44STejun Heo 	struct pool_workqueue *pwq;
36701da177e4SLinus Torvalds 
367173f53c4aSTejun Heo 	if (flush_color >= 0) {
36726183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
3673112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
3674dc186ad7SThomas Gleixner 	}
367514441960SOleg Nesterov 
367649e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3677112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
36781da177e4SLinus Torvalds 
3679a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
368073f53c4aSTejun Heo 
368173f53c4aSTejun Heo 		if (flush_color >= 0) {
36826183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
368373f53c4aSTejun Heo 
3684112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
3685112202d9STejun Heo 				pwq->flush_color = flush_color;
3686112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
368773f53c4aSTejun Heo 				wait = true;
36881da177e4SLinus Torvalds 			}
368973f53c4aSTejun Heo 		}
369073f53c4aSTejun Heo 
369173f53c4aSTejun Heo 		if (work_color >= 0) {
36926183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
3693112202d9STejun Heo 			pwq->work_color = work_color;
369473f53c4aSTejun Heo 		}
369573f53c4aSTejun Heo 
3696a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
36971da177e4SLinus Torvalds 	}
36981da177e4SLinus Torvalds 
3699112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
370073f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
370173f53c4aSTejun Heo 
370273f53c4aSTejun Heo 	return wait;
370383c22520SOleg Nesterov }
37041da177e4SLinus Torvalds 
3705c35aea39STejun Heo static void touch_wq_lockdep_map(struct workqueue_struct *wq)
3706c35aea39STejun Heo {
37074cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP
37084cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37094cb1ef64STejun Heo 		local_bh_disable();
37104cb1ef64STejun Heo 
3711c35aea39STejun Heo 	lock_map_acquire(&wq->lockdep_map);
3712c35aea39STejun Heo 	lock_map_release(&wq->lockdep_map);
37134cb1ef64STejun Heo 
37144cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37154cb1ef64STejun Heo 		local_bh_enable();
37164cb1ef64STejun Heo #endif
3717c35aea39STejun Heo }
3718c35aea39STejun Heo 
3719c35aea39STejun Heo static void touch_work_lockdep_map(struct work_struct *work,
3720c35aea39STejun Heo 				   struct workqueue_struct *wq)
3721c35aea39STejun Heo {
37224cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP
37234cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37244cb1ef64STejun Heo 		local_bh_disable();
37254cb1ef64STejun Heo 
3726c35aea39STejun Heo 	lock_map_acquire(&work->lockdep_map);
3727c35aea39STejun Heo 	lock_map_release(&work->lockdep_map);
37284cb1ef64STejun Heo 
37294cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37304cb1ef64STejun Heo 		local_bh_enable();
37314cb1ef64STejun Heo #endif
3732c35aea39STejun Heo }
3733c35aea39STejun Heo 
37340fcb78c2SRolf Eike Beer /**
3735c4f135d6STetsuo Handa  * __flush_workqueue - ensure that any scheduled work has run to completion.
37360fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
37371da177e4SLinus Torvalds  *
3738c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
3739c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
37401da177e4SLinus Torvalds  */
3741c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq)
37421da177e4SLinus Torvalds {
374373f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
374473f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
374573f53c4aSTejun Heo 		.flush_color = -1,
3746fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
374773f53c4aSTejun Heo 	};
374873f53c4aSTejun Heo 	int next_color;
3749b1f4ec17SOleg Nesterov 
37503347fa09STejun Heo 	if (WARN_ON(!wq_online))
37513347fa09STejun Heo 		return;
37523347fa09STejun Heo 
3753c35aea39STejun Heo 	touch_wq_lockdep_map(wq);
375487915adcSJohannes Berg 
37553c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
375673f53c4aSTejun Heo 
375773f53c4aSTejun Heo 	/*
375873f53c4aSTejun Heo 	 * Start-to-wait phase
375973f53c4aSTejun Heo 	 */
376073f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
376173f53c4aSTejun Heo 
376273f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
376373f53c4aSTejun Heo 		/*
376473f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
376573f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
376673f53c4aSTejun Heo 		 * by one.
376773f53c4aSTejun Heo 		 */
37686183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
376973f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
377073f53c4aSTejun Heo 		wq->work_color = next_color;
377173f53c4aSTejun Heo 
377273f53c4aSTejun Heo 		if (!wq->first_flusher) {
377373f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
37746183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
377573f53c4aSTejun Heo 
377673f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
377773f53c4aSTejun Heo 
3778112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
377973f53c4aSTejun Heo 						       wq->work_color)) {
378073f53c4aSTejun Heo 				/* nothing to flush, done */
378173f53c4aSTejun Heo 				wq->flush_color = next_color;
378273f53c4aSTejun Heo 				wq->first_flusher = NULL;
378373f53c4aSTejun Heo 				goto out_unlock;
378473f53c4aSTejun Heo 			}
378573f53c4aSTejun Heo 		} else {
378673f53c4aSTejun Heo 			/* wait in queue */
37876183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
378873f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
3789112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
379073f53c4aSTejun Heo 		}
379173f53c4aSTejun Heo 	} else {
379273f53c4aSTejun Heo 		/*
379373f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
379473f53c4aSTejun Heo 		 * The next flush completion will assign us
379573f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
379673f53c4aSTejun Heo 		 */
379773f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
379873f53c4aSTejun Heo 	}
379973f53c4aSTejun Heo 
3800fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
3801fca839c0STejun Heo 
38023c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
380373f53c4aSTejun Heo 
380473f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
380573f53c4aSTejun Heo 
380673f53c4aSTejun Heo 	/*
380773f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
380873f53c4aSTejun Heo 	 *
380973f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
381073f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
381173f53c4aSTejun Heo 	 */
381200d5d15bSChris Wilson 	if (READ_ONCE(wq->first_flusher) != &this_flusher)
381373f53c4aSTejun Heo 		return;
381473f53c4aSTejun Heo 
38153c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
381673f53c4aSTejun Heo 
38174ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
38184ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
38194ce48b37STejun Heo 		goto out_unlock;
38204ce48b37STejun Heo 
382100d5d15bSChris Wilson 	WRITE_ONCE(wq->first_flusher, NULL);
382273f53c4aSTejun Heo 
38236183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
38246183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
382573f53c4aSTejun Heo 
382673f53c4aSTejun Heo 	while (true) {
382773f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
382873f53c4aSTejun Heo 
382973f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
383073f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
383173f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
383273f53c4aSTejun Heo 				break;
383373f53c4aSTejun Heo 			list_del_init(&next->list);
383473f53c4aSTejun Heo 			complete(&next->done);
383573f53c4aSTejun Heo 		}
383673f53c4aSTejun Heo 
38376183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
383873f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
383973f53c4aSTejun Heo 
384073f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
384173f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
384273f53c4aSTejun Heo 
384373f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
384473f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
384573f53c4aSTejun Heo 			/*
384673f53c4aSTejun Heo 			 * Assign the same color to all overflowed
384773f53c4aSTejun Heo 			 * flushers, advance work_color and append to
384873f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
384973f53c4aSTejun Heo 			 * phase for these overflowed flushers.
385073f53c4aSTejun Heo 			 */
385173f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
385273f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
385373f53c4aSTejun Heo 
385473f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
385573f53c4aSTejun Heo 
385673f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
385773f53c4aSTejun Heo 					      &wq->flusher_queue);
3858112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
385973f53c4aSTejun Heo 		}
386073f53c4aSTejun Heo 
386173f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
38626183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
386373f53c4aSTejun Heo 			break;
386473f53c4aSTejun Heo 		}
386573f53c4aSTejun Heo 
386673f53c4aSTejun Heo 		/*
386773f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
3868112202d9STejun Heo 		 * the new first flusher and arm pwqs.
386973f53c4aSTejun Heo 		 */
38706183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
38716183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
387273f53c4aSTejun Heo 
387373f53c4aSTejun Heo 		list_del_init(&next->list);
387473f53c4aSTejun Heo 		wq->first_flusher = next;
387573f53c4aSTejun Heo 
3876112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
387773f53c4aSTejun Heo 			break;
387873f53c4aSTejun Heo 
387973f53c4aSTejun Heo 		/*
388073f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
388173f53c4aSTejun Heo 		 * flusher and repeat cascading.
388273f53c4aSTejun Heo 		 */
388373f53c4aSTejun Heo 		wq->first_flusher = NULL;
388473f53c4aSTejun Heo 	}
388573f53c4aSTejun Heo 
388673f53c4aSTejun Heo out_unlock:
38873c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
38881da177e4SLinus Torvalds }
3889c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue);
38901da177e4SLinus Torvalds 
38919c5a2ba7STejun Heo /**
38929c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
38939c5a2ba7STejun Heo  * @wq: workqueue to drain
38949c5a2ba7STejun Heo  *
38959c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
38969c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
38979c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
3898b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
38999c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
39009c5a2ba7STejun Heo  * takes too long.
39019c5a2ba7STejun Heo  */
39029c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
39039c5a2ba7STejun Heo {
39049c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
390549e3cf44STejun Heo 	struct pool_workqueue *pwq;
39069c5a2ba7STejun Heo 
39079c5a2ba7STejun Heo 	/*
39089c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
39099c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
3910618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
39119c5a2ba7STejun Heo 	 */
391287fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
39139c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
3914618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
391587fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
39169c5a2ba7STejun Heo reflush:
3917c4f135d6STetsuo Handa 	__flush_workqueue(wq);
39189c5a2ba7STejun Heo 
3919b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
392076af4d93STejun Heo 
392149e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3922fa2563e4SThomas Tuttle 		bool drained;
39239c5a2ba7STejun Heo 
3924a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
3925afa87ce8STejun Heo 		drained = pwq_is_empty(pwq);
3926a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
3927fa2563e4SThomas Tuttle 
3928fa2563e4SThomas Tuttle 		if (drained)
39299c5a2ba7STejun Heo 			continue;
39309c5a2ba7STejun Heo 
39319c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
39329c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3933e9ad2eb3SStephen Zhang 			pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3934e9ad2eb3SStephen Zhang 				wq->name, __func__, flush_cnt);
393576af4d93STejun Heo 
3936b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
39379c5a2ba7STejun Heo 		goto reflush;
39389c5a2ba7STejun Heo 	}
39399c5a2ba7STejun Heo 
39409c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
3941618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
394287fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
39439c5a2ba7STejun Heo }
39449c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
39459c5a2ba7STejun Heo 
3946d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3947d6e89786SJohannes Berg 			     bool from_cancel)
3948baf59022STejun Heo {
3949baf59022STejun Heo 	struct worker *worker = NULL;
3950c9e7cf27STejun Heo 	struct worker_pool *pool;
3951112202d9STejun Heo 	struct pool_workqueue *pwq;
3952c35aea39STejun Heo 	struct workqueue_struct *wq;
3953baf59022STejun Heo 
3954baf59022STejun Heo 	might_sleep();
3955baf59022STejun Heo 
395624acfb71SThomas Gleixner 	rcu_read_lock();
3957fa1b54e6STejun Heo 	pool = get_work_pool(work);
3958fa1b54e6STejun Heo 	if (!pool) {
395924acfb71SThomas Gleixner 		rcu_read_unlock();
3960fa1b54e6STejun Heo 		return false;
3961fa1b54e6STejun Heo 	}
3962fa1b54e6STejun Heo 
3963a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
39640b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
3965112202d9STejun Heo 	pwq = get_work_pwq(work);
3966112202d9STejun Heo 	if (pwq) {
3967112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
3968baf59022STejun Heo 			goto already_gone;
3969606a5020STejun Heo 	} else {
3970c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
3971baf59022STejun Heo 		if (!worker)
3972baf59022STejun Heo 			goto already_gone;
3973112202d9STejun Heo 		pwq = worker->current_pwq;
3974606a5020STejun Heo 	}
3975baf59022STejun Heo 
3976c35aea39STejun Heo 	wq = pwq->wq;
3977c35aea39STejun Heo 	check_flush_dependency(wq, work);
3978fca839c0STejun Heo 
3979112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
3980a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3981baf59022STejun Heo 
3982c35aea39STejun Heo 	touch_work_lockdep_map(work, wq);
3983c35aea39STejun Heo 
3984e159489bSTejun Heo 	/*
3985a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
3986a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
3987a1d14934SPeter Zijlstra 	 *
3988a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
3989a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
3990a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
3991a1d14934SPeter Zijlstra 	 * forward progress.
3992e159489bSTejun Heo 	 */
3993c35aea39STejun Heo 	if (!from_cancel && (wq->saved_max_active == 1 || wq->rescuer))
3994c35aea39STejun Heo 		touch_wq_lockdep_map(wq);
3995c35aea39STejun Heo 
399624acfb71SThomas Gleixner 	rcu_read_unlock();
3997baf59022STejun Heo 	return true;
3998baf59022STejun Heo already_gone:
3999a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
400024acfb71SThomas Gleixner 	rcu_read_unlock();
4001baf59022STejun Heo 	return false;
4002baf59022STejun Heo }
4003baf59022STejun Heo 
4004d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
4005d6e89786SJohannes Berg {
4006d6e89786SJohannes Berg 	struct wq_barrier barr;
4007d6e89786SJohannes Berg 
4008d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
4009d6e89786SJohannes Berg 		return false;
4010d6e89786SJohannes Berg 
40114d43d395STetsuo Handa 	if (WARN_ON(!work->func))
40124d43d395STetsuo Handa 		return false;
40134d43d395STetsuo Handa 
4014d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
4015d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
4016d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
4017d6e89786SJohannes Berg 		return true;
4018d6e89786SJohannes Berg 	} else {
4019d6e89786SJohannes Berg 		return false;
4020d6e89786SJohannes Berg 	}
4021d6e89786SJohannes Berg }
4022d6e89786SJohannes Berg 
4023db700897SOleg Nesterov /**
4024401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
4025401a8d04STejun Heo  * @work: the work to flush
4026db700897SOleg Nesterov  *
4027606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
4028606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
4029401a8d04STejun Heo  *
4030d185af30SYacine Belkadi  * Return:
4031401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
4032401a8d04STejun Heo  * %false if it was already idle.
4033db700897SOleg Nesterov  */
4034401a8d04STejun Heo bool flush_work(struct work_struct *work)
4035db700897SOleg Nesterov {
4036d6e89786SJohannes Berg 	return __flush_work(work, false);
4037606a5020STejun Heo }
4038db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
4039db700897SOleg Nesterov 
40408603e1b3STejun Heo struct cwt_wait {
4041ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
40428603e1b3STejun Heo 	struct work_struct	*work;
40438603e1b3STejun Heo };
40448603e1b3STejun Heo 
4045ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
40468603e1b3STejun Heo {
40478603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
40488603e1b3STejun Heo 
40498603e1b3STejun Heo 	if (cwait->work != key)
40508603e1b3STejun Heo 		return 0;
40518603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
40528603e1b3STejun Heo }
40538603e1b3STejun Heo 
405436e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
4055401a8d04STejun Heo {
40568603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
4057bbb68dfaSTejun Heo 	unsigned long flags;
40581f1f642eSOleg Nesterov 	int ret;
40591f1f642eSOleg Nesterov 
40601f1f642eSOleg Nesterov 	do {
4061bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
4062bbb68dfaSTejun Heo 		/*
40638603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
40648603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
40658603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
40668603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
40678603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
40688603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
40698603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
40708603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
40718603e1b3STejun Heo 		 * we're hogging the CPU.
40728603e1b3STejun Heo 		 *
40738603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
40748603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
40758603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
40768603e1b3STejun Heo 		 * wait and wakeup.
4077bbb68dfaSTejun Heo 		 */
40788603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
40798603e1b3STejun Heo 			struct cwt_wait cwait;
40808603e1b3STejun Heo 
40818603e1b3STejun Heo 			init_wait(&cwait.wait);
40828603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
40838603e1b3STejun Heo 			cwait.work = work;
40848603e1b3STejun Heo 
40858603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
40868603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
40878603e1b3STejun Heo 			if (work_is_canceling(work))
40888603e1b3STejun Heo 				schedule();
40898603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
40908603e1b3STejun Heo 		}
40911f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
40921f1f642eSOleg Nesterov 
4093bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
4094bbb68dfaSTejun Heo 	mark_work_canceling(work);
4095bbb68dfaSTejun Heo 	local_irq_restore(flags);
4096bbb68dfaSTejun Heo 
40973347fa09STejun Heo 	/*
40983347fa09STejun Heo 	 * This allows canceling during early boot.  We know that @work
40993347fa09STejun Heo 	 * isn't executing.
41003347fa09STejun Heo 	 */
41013347fa09STejun Heo 	if (wq_online)
4102d6e89786SJohannes Berg 		__flush_work(work, true);
41033347fa09STejun Heo 
41047a22ad75STejun Heo 	clear_work_data(work);
41058603e1b3STejun Heo 
41068603e1b3STejun Heo 	/*
41078603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
41088603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
41098603e1b3STejun Heo 	 * visible there.
41108603e1b3STejun Heo 	 */
41118603e1b3STejun Heo 	smp_mb();
41128603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
41138603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
41148603e1b3STejun Heo 
41151f1f642eSOleg Nesterov 	return ret;
41161f1f642eSOleg Nesterov }
41171f1f642eSOleg Nesterov 
41186e84d644SOleg Nesterov /**
4119401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
4120401a8d04STejun Heo  * @work: the work to cancel
41216e84d644SOleg Nesterov  *
4122401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
4123401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
4124401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
4125401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
41261f1f642eSOleg Nesterov  *
4127401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
4128401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
41296e84d644SOleg Nesterov  *
4130401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
41316e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
4132401a8d04STejun Heo  *
4133d185af30SYacine Belkadi  * Return:
4134401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
41356e84d644SOleg Nesterov  */
4136401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
41376e84d644SOleg Nesterov {
413836e227d2STejun Heo 	return __cancel_work_timer(work, false);
4139b89deed3SOleg Nesterov }
414028e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
4141b89deed3SOleg Nesterov 
41426e84d644SOleg Nesterov /**
4143401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
4144401a8d04STejun Heo  * @dwork: the delayed work to flush
41456e84d644SOleg Nesterov  *
4146401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
4147401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
4148401a8d04STejun Heo  * considers the last queueing instance of @dwork.
41491f1f642eSOleg Nesterov  *
4150d185af30SYacine Belkadi  * Return:
4151401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
4152401a8d04STejun Heo  * %false if it was already idle.
41536e84d644SOleg Nesterov  */
4154401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
4155401a8d04STejun Heo {
41568930cabaSTejun Heo 	local_irq_disable();
4157401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
415860c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
41598930cabaSTejun Heo 	local_irq_enable();
4160401a8d04STejun Heo 	return flush_work(&dwork->work);
4161401a8d04STejun Heo }
4162401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
4163401a8d04STejun Heo 
416405f0fe6bSTejun Heo /**
416505f0fe6bSTejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
416605f0fe6bSTejun Heo  * @rwork: the rcu work to flush
416705f0fe6bSTejun Heo  *
416805f0fe6bSTejun Heo  * Return:
416905f0fe6bSTejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
417005f0fe6bSTejun Heo  * %false if it was already idle.
417105f0fe6bSTejun Heo  */
417205f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork)
417305f0fe6bSTejun Heo {
417405f0fe6bSTejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
417505f0fe6bSTejun Heo 		rcu_barrier();
417605f0fe6bSTejun Heo 		flush_work(&rwork->work);
417705f0fe6bSTejun Heo 		return true;
417805f0fe6bSTejun Heo 	} else {
417905f0fe6bSTejun Heo 		return flush_work(&rwork->work);
418005f0fe6bSTejun Heo 	}
418105f0fe6bSTejun Heo }
418205f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work);
418305f0fe6bSTejun Heo 
4184f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork)
4185f72b8792SJens Axboe {
4186f72b8792SJens Axboe 	unsigned long flags;
4187f72b8792SJens Axboe 	int ret;
4188f72b8792SJens Axboe 
4189f72b8792SJens Axboe 	do {
4190f72b8792SJens Axboe 		ret = try_to_grab_pending(work, is_dwork, &flags);
4191f72b8792SJens Axboe 	} while (unlikely(ret == -EAGAIN));
4192f72b8792SJens Axboe 
4193f72b8792SJens Axboe 	if (unlikely(ret < 0))
4194f72b8792SJens Axboe 		return false;
4195f72b8792SJens Axboe 
4196f72b8792SJens Axboe 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
4197f72b8792SJens Axboe 	local_irq_restore(flags);
4198f72b8792SJens Axboe 	return ret;
4199f72b8792SJens Axboe }
4200f72b8792SJens Axboe 
420173b4b532SAndrey Grodzovsky /*
420273b4b532SAndrey Grodzovsky  * See cancel_delayed_work()
420373b4b532SAndrey Grodzovsky  */
420473b4b532SAndrey Grodzovsky bool cancel_work(struct work_struct *work)
420573b4b532SAndrey Grodzovsky {
420673b4b532SAndrey Grodzovsky 	return __cancel_work(work, false);
420773b4b532SAndrey Grodzovsky }
420873b4b532SAndrey Grodzovsky EXPORT_SYMBOL(cancel_work);
420973b4b532SAndrey Grodzovsky 
4210401a8d04STejun Heo /**
421157b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
421257b30ae7STejun Heo  * @dwork: delayed_work to cancel
421309383498STejun Heo  *
4214d185af30SYacine Belkadi  * Kill off a pending delayed_work.
4215d185af30SYacine Belkadi  *
4216d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
4217d185af30SYacine Belkadi  * pending.
4218d185af30SYacine Belkadi  *
4219d185af30SYacine Belkadi  * Note:
4220d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
4221d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
4222d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
422309383498STejun Heo  *
422457b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
422509383498STejun Heo  */
422657b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
422709383498STejun Heo {
4228f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
422909383498STejun Heo }
423057b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
423109383498STejun Heo 
423209383498STejun Heo /**
4233401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
4234401a8d04STejun Heo  * @dwork: the delayed work cancel
4235401a8d04STejun Heo  *
4236401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
4237401a8d04STejun Heo  *
4238d185af30SYacine Belkadi  * Return:
4239401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
4240401a8d04STejun Heo  */
4241401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
42426e84d644SOleg Nesterov {
424336e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
42446e84d644SOleg Nesterov }
4245f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
42461da177e4SLinus Torvalds 
42470fcb78c2SRolf Eike Beer /**
424831ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
4249b6136773SAndrew Morton  * @func: the function to call
4250b6136773SAndrew Morton  *
425131ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
425231ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
4253b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
425431ddd871STejun Heo  *
4255d185af30SYacine Belkadi  * Return:
425631ddd871STejun Heo  * 0 on success, -errno on failure.
4257b6136773SAndrew Morton  */
425865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
425915316ba8SChristoph Lameter {
426015316ba8SChristoph Lameter 	int cpu;
426138f51568SNamhyung Kim 	struct work_struct __percpu *works;
426215316ba8SChristoph Lameter 
4263b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
4264b6136773SAndrew Morton 	if (!works)
426515316ba8SChristoph Lameter 		return -ENOMEM;
4266b6136773SAndrew Morton 
4267ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
426893981800STejun Heo 
426915316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
42709bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
42719bfb1839SIngo Molnar 
42729bfb1839SIngo Molnar 		INIT_WORK(work, func);
42738de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
427415316ba8SChristoph Lameter 	}
427593981800STejun Heo 
427693981800STejun Heo 	for_each_online_cpu(cpu)
42778616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
427893981800STejun Heo 
4279ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4280b6136773SAndrew Morton 	free_percpu(works);
428115316ba8SChristoph Lameter 	return 0;
428215316ba8SChristoph Lameter }
428315316ba8SChristoph Lameter 
4284eef6a7d5SAlan Stern /**
42851fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
42861fa44ecaSJames Bottomley  * @fn:		the function to execute
42871fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
42881fa44ecaSJames Bottomley  *		be available when the work executes)
42891fa44ecaSJames Bottomley  *
42901fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
42911fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
42921fa44ecaSJames Bottomley  *
4293d185af30SYacine Belkadi  * Return:	0 - function was executed
42941fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
42951fa44ecaSJames Bottomley  */
429665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
42971fa44ecaSJames Bottomley {
42981fa44ecaSJames Bottomley 	if (!in_interrupt()) {
429965f27f38SDavid Howells 		fn(&ew->work);
43001fa44ecaSJames Bottomley 		return 0;
43011fa44ecaSJames Bottomley 	}
43021fa44ecaSJames Bottomley 
430365f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
43041fa44ecaSJames Bottomley 	schedule_work(&ew->work);
43051fa44ecaSJames Bottomley 
43061fa44ecaSJames Bottomley 	return 1;
43071fa44ecaSJames Bottomley }
43081fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
43091fa44ecaSJames Bottomley 
43107a4e344cSTejun Heo /**
43117a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
43127a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
43137a4e344cSTejun Heo  *
43147a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
43157a4e344cSTejun Heo  */
4316513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs)
43177a4e344cSTejun Heo {
43187a4e344cSTejun Heo 	if (attrs) {
43197a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
43209546b29eSTejun Heo 		free_cpumask_var(attrs->__pod_cpumask);
43217a4e344cSTejun Heo 		kfree(attrs);
43227a4e344cSTejun Heo 	}
43237a4e344cSTejun Heo }
43247a4e344cSTejun Heo 
43257a4e344cSTejun Heo /**
43267a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
43277a4e344cSTejun Heo  *
43287a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
4329d185af30SYacine Belkadi  * return it.
4330d185af30SYacine Belkadi  *
4331d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
43327a4e344cSTejun Heo  */
4333513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void)
43347a4e344cSTejun Heo {
43357a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
43367a4e344cSTejun Heo 
4337be69d00dSThomas Gleixner 	attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
43387a4e344cSTejun Heo 	if (!attrs)
43397a4e344cSTejun Heo 		goto fail;
4340be69d00dSThomas Gleixner 	if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
43417a4e344cSTejun Heo 		goto fail;
43429546b29eSTejun Heo 	if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL))
43439546b29eSTejun Heo 		goto fail;
43447a4e344cSTejun Heo 
434513e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
4346523a301eSTejun Heo 	attrs->affn_scope = WQ_AFFN_DFL;
43477a4e344cSTejun Heo 	return attrs;
43487a4e344cSTejun Heo fail:
43497a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
43507a4e344cSTejun Heo 	return NULL;
43517a4e344cSTejun Heo }
43527a4e344cSTejun Heo 
435329c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
435429c91e99STejun Heo 				 const struct workqueue_attrs *from)
435529c91e99STejun Heo {
435629c91e99STejun Heo 	to->nice = from->nice;
435729c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
43589546b29eSTejun Heo 	cpumask_copy(to->__pod_cpumask, from->__pod_cpumask);
43598639ecebSTejun Heo 	to->affn_strict = from->affn_strict;
436084193c07STejun Heo 
43612865a8fbSShaohua Li 	/*
436284193c07STejun Heo 	 * Unlike hash and equality test, copying shouldn't ignore wq-only
436384193c07STejun Heo 	 * fields as copying is used for both pool and wq attrs. Instead,
436484193c07STejun Heo 	 * get_unbound_pool() explicitly clears the fields.
43652865a8fbSShaohua Li 	 */
436684193c07STejun Heo 	to->affn_scope = from->affn_scope;
4367af73f5c9STejun Heo 	to->ordered = from->ordered;
436829c91e99STejun Heo }
436929c91e99STejun Heo 
43705de7a03cSTejun Heo /*
43715de7a03cSTejun Heo  * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the
43725de7a03cSTejun Heo  * comments in 'struct workqueue_attrs' definition.
43735de7a03cSTejun Heo  */
43745de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs)
43755de7a03cSTejun Heo {
437684193c07STejun Heo 	attrs->affn_scope = WQ_AFFN_NR_TYPES;
43775de7a03cSTejun Heo 	attrs->ordered = false;
43785de7a03cSTejun Heo }
43795de7a03cSTejun Heo 
438029c91e99STejun Heo /* hash value of the content of @attr */
438129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
438229c91e99STejun Heo {
438329c91e99STejun Heo 	u32 hash = 0;
438429c91e99STejun Heo 
438529c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
438613e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
438713e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
43889546b29eSTejun Heo 	hash = jhash(cpumask_bits(attrs->__pod_cpumask),
43899546b29eSTejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
43908639ecebSTejun Heo 	hash = jhash_1word(attrs->affn_strict, hash);
439129c91e99STejun Heo 	return hash;
439229c91e99STejun Heo }
439329c91e99STejun Heo 
439429c91e99STejun Heo /* content equality test */
439529c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
439629c91e99STejun Heo 			  const struct workqueue_attrs *b)
439729c91e99STejun Heo {
439829c91e99STejun Heo 	if (a->nice != b->nice)
439929c91e99STejun Heo 		return false;
440029c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
440129c91e99STejun Heo 		return false;
44029546b29eSTejun Heo 	if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask))
44039546b29eSTejun Heo 		return false;
44048639ecebSTejun Heo 	if (a->affn_strict != b->affn_strict)
44058639ecebSTejun Heo 		return false;
440629c91e99STejun Heo 	return true;
440729c91e99STejun Heo }
440829c91e99STejun Heo 
44090f36ee24STejun Heo /* Update @attrs with actually available CPUs */
44100f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs,
44110f36ee24STejun Heo 				      const cpumask_t *unbound_cpumask)
44120f36ee24STejun Heo {
44130f36ee24STejun Heo 	/*
44140f36ee24STejun Heo 	 * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If
44150f36ee24STejun Heo 	 * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to
44160f36ee24STejun Heo 	 * @unbound_cpumask.
44170f36ee24STejun Heo 	 */
44180f36ee24STejun Heo 	cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask);
44190f36ee24STejun Heo 	if (unlikely(cpumask_empty(attrs->cpumask)))
44200f36ee24STejun Heo 		cpumask_copy(attrs->cpumask, unbound_cpumask);
44210f36ee24STejun Heo }
44220f36ee24STejun Heo 
442384193c07STejun Heo /* find wq_pod_type to use for @attrs */
442484193c07STejun Heo static const struct wq_pod_type *
442584193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs)
442684193c07STejun Heo {
4427523a301eSTejun Heo 	enum wq_affn_scope scope;
4428523a301eSTejun Heo 	struct wq_pod_type *pt;
4429523a301eSTejun Heo 
4430523a301eSTejun Heo 	/* to synchronize access to wq_affn_dfl */
4431523a301eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4432523a301eSTejun Heo 
4433523a301eSTejun Heo 	if (attrs->affn_scope == WQ_AFFN_DFL)
4434523a301eSTejun Heo 		scope = wq_affn_dfl;
4435523a301eSTejun Heo 	else
4436523a301eSTejun Heo 		scope = attrs->affn_scope;
4437523a301eSTejun Heo 
4438523a301eSTejun Heo 	pt = &wq_pod_types[scope];
443984193c07STejun Heo 
444084193c07STejun Heo 	if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) &&
444184193c07STejun Heo 	    likely(pt->nr_pods))
444284193c07STejun Heo 		return pt;
444384193c07STejun Heo 
444484193c07STejun Heo 	/*
444584193c07STejun Heo 	 * Before workqueue_init_topology(), only SYSTEM is available which is
444684193c07STejun Heo 	 * initialized in workqueue_init_early().
444784193c07STejun Heo 	 */
444884193c07STejun Heo 	pt = &wq_pod_types[WQ_AFFN_SYSTEM];
444984193c07STejun Heo 	BUG_ON(!pt->nr_pods);
445084193c07STejun Heo 	return pt;
445184193c07STejun Heo }
445284193c07STejun Heo 
44537a4e344cSTejun Heo /**
44547a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
44557a4e344cSTejun Heo  * @pool: worker_pool to initialize
44567a4e344cSTejun Heo  *
4457402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
4458d185af30SYacine Belkadi  *
4459d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
446029c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
446129c91e99STejun Heo  * on @pool safely to release it.
44627a4e344cSTejun Heo  */
44637a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
44644e1a1f9aSTejun Heo {
4465a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_init(&pool->lock);
446629c91e99STejun Heo 	pool->id = -1;
446729c91e99STejun Heo 	pool->cpu = -1;
4468f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
44694e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
447082607adcSTejun Heo 	pool->watchdog_ts = jiffies;
44714e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
44724e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
44734e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
44744e1a1f9aSTejun Heo 
447532a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
44763f959aa3SValentin Schneider 	INIT_WORK(&pool->idle_cull_work, idle_cull_fn);
44774e1a1f9aSTejun Heo 
447832a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
44794e1a1f9aSTejun Heo 
4480da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
4481e02b9312SValentin Schneider 	INIT_LIST_HEAD(&pool->dying_workers);
44827a4e344cSTejun Heo 
44837cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
448429c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
448529c91e99STejun Heo 	pool->refcnt = 1;
448629c91e99STejun Heo 
448729c91e99STejun Heo 	/* shouldn't fail above this point */
4488be69d00dSThomas Gleixner 	pool->attrs = alloc_workqueue_attrs();
44897a4e344cSTejun Heo 	if (!pool->attrs)
44907a4e344cSTejun Heo 		return -ENOMEM;
44915de7a03cSTejun Heo 
44925de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
44935de7a03cSTejun Heo 
44947a4e344cSTejun Heo 	return 0;
44954e1a1f9aSTejun Heo }
44964e1a1f9aSTejun Heo 
4497669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
4498669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4499669de8bdSBart Van Assche {
4500669de8bdSBart Van Assche 	char *lock_name;
4501669de8bdSBart Van Assche 
4502669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
4503669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
4504669de8bdSBart Van Assche 	if (!lock_name)
4505669de8bdSBart Van Assche 		lock_name = wq->name;
450669a106c0SQian Cai 
450769a106c0SQian Cai 	wq->lock_name = lock_name;
4508669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
4509669de8bdSBart Van Assche }
4510669de8bdSBart Van Assche 
4511669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4512669de8bdSBart Van Assche {
4513669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
4514669de8bdSBart Van Assche }
4515669de8bdSBart Van Assche 
4516669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4517669de8bdSBart Van Assche {
4518669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
4519669de8bdSBart Van Assche 		kfree(wq->lock_name);
4520669de8bdSBart Van Assche }
4521669de8bdSBart Van Assche #else
4522669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4523669de8bdSBart Van Assche {
4524669de8bdSBart Van Assche }
4525669de8bdSBart Van Assche 
4526669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4527669de8bdSBart Van Assche {
4528669de8bdSBart Van Assche }
4529669de8bdSBart Van Assche 
4530669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4531669de8bdSBart Van Assche {
4532669de8bdSBart Van Assche }
4533669de8bdSBart Van Assche #endif
4534669de8bdSBart Van Assche 
453591ccc6e7STejun Heo static void free_node_nr_active(struct wq_node_nr_active **nna_ar)
453691ccc6e7STejun Heo {
453791ccc6e7STejun Heo 	int node;
453891ccc6e7STejun Heo 
453991ccc6e7STejun Heo 	for_each_node(node) {
454091ccc6e7STejun Heo 		kfree(nna_ar[node]);
454191ccc6e7STejun Heo 		nna_ar[node] = NULL;
454291ccc6e7STejun Heo 	}
454391ccc6e7STejun Heo 
454491ccc6e7STejun Heo 	kfree(nna_ar[nr_node_ids]);
454591ccc6e7STejun Heo 	nna_ar[nr_node_ids] = NULL;
454691ccc6e7STejun Heo }
454791ccc6e7STejun Heo 
454891ccc6e7STejun Heo static void init_node_nr_active(struct wq_node_nr_active *nna)
454991ccc6e7STejun Heo {
4550c5f8cd6cSTejun Heo 	nna->max = WQ_DFL_MIN_ACTIVE;
455191ccc6e7STejun Heo 	atomic_set(&nna->nr, 0);
45525797b1c1STejun Heo 	raw_spin_lock_init(&nna->lock);
45535797b1c1STejun Heo 	INIT_LIST_HEAD(&nna->pending_pwqs);
455491ccc6e7STejun Heo }
455591ccc6e7STejun Heo 
455691ccc6e7STejun Heo /*
455791ccc6e7STejun Heo  * Each node's nr_active counter will be accessed mostly from its own node and
455891ccc6e7STejun Heo  * should be allocated in the node.
455991ccc6e7STejun Heo  */
456091ccc6e7STejun Heo static int alloc_node_nr_active(struct wq_node_nr_active **nna_ar)
456191ccc6e7STejun Heo {
456291ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
456391ccc6e7STejun Heo 	int node;
456491ccc6e7STejun Heo 
456591ccc6e7STejun Heo 	for_each_node(node) {
456691ccc6e7STejun Heo 		nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, node);
456791ccc6e7STejun Heo 		if (!nna)
456891ccc6e7STejun Heo 			goto err_free;
456991ccc6e7STejun Heo 		init_node_nr_active(nna);
457091ccc6e7STejun Heo 		nna_ar[node] = nna;
457191ccc6e7STejun Heo 	}
457291ccc6e7STejun Heo 
457391ccc6e7STejun Heo 	/* [nr_node_ids] is used as the fallback */
457491ccc6e7STejun Heo 	nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, NUMA_NO_NODE);
457591ccc6e7STejun Heo 	if (!nna)
457691ccc6e7STejun Heo 		goto err_free;
457791ccc6e7STejun Heo 	init_node_nr_active(nna);
457891ccc6e7STejun Heo 	nna_ar[nr_node_ids] = nna;
457991ccc6e7STejun Heo 
458091ccc6e7STejun Heo 	return 0;
458191ccc6e7STejun Heo 
458291ccc6e7STejun Heo err_free:
458391ccc6e7STejun Heo 	free_node_nr_active(nna_ar);
458491ccc6e7STejun Heo 	return -ENOMEM;
458591ccc6e7STejun Heo }
458691ccc6e7STejun Heo 
4587e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
4588e2dca7adSTejun Heo {
4589e2dca7adSTejun Heo 	struct workqueue_struct *wq =
4590e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
4591e2dca7adSTejun Heo 
459291ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
459391ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
459491ccc6e7STejun Heo 
4595669de8bdSBart Van Assche 	wq_free_lockdep(wq);
4596ee1ceef7STejun Heo 	free_percpu(wq->cpu_pwq);
4597e2dca7adSTejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
4598e2dca7adSTejun Heo 	kfree(wq);
4599e2dca7adSTejun Heo }
4600e2dca7adSTejun Heo 
460129c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
460229c91e99STejun Heo {
460329c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
460429c91e99STejun Heo 
46057cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
460629c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
460729c91e99STejun Heo 	kfree(pool);
460829c91e99STejun Heo }
460929c91e99STejun Heo 
461029c91e99STejun Heo /**
461129c91e99STejun Heo  * put_unbound_pool - put a worker_pool
461229c91e99STejun Heo  * @pool: worker_pool to put
461329c91e99STejun Heo  *
461424acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
4615c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
4616c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
4617c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
4618a892caccSTejun Heo  *
4619a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
462029c91e99STejun Heo  */
462129c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
462229c91e99STejun Heo {
462360f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
462429c91e99STejun Heo 	struct worker *worker;
46259680540cSYang Yingliang 	LIST_HEAD(cull_list);
4626e02b9312SValentin Schneider 
4627a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4628a892caccSTejun Heo 
4629a892caccSTejun Heo 	if (--pool->refcnt)
463029c91e99STejun Heo 		return;
463129c91e99STejun Heo 
463229c91e99STejun Heo 	/* sanity checks */
463361d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
4634a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
463529c91e99STejun Heo 		return;
463629c91e99STejun Heo 
463729c91e99STejun Heo 	/* release id and unhash */
463829c91e99STejun Heo 	if (pool->id >= 0)
463929c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
464029c91e99STejun Heo 	hash_del(&pool->hash_node);
464129c91e99STejun Heo 
4642c5aa87bbSTejun Heo 	/*
4643692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
4644692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
4645692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
46469ab03be4SValentin Schneider 	 *
46479ab03be4SValentin Schneider 	 * Having a concurrent manager is quite unlikely to happen as we can
46489ab03be4SValentin Schneider 	 * only get here with
46499ab03be4SValentin Schneider 	 *   pwq->refcnt == pool->refcnt == 0
46509ab03be4SValentin Schneider 	 * which implies no work queued to the pool, which implies no worker can
46519ab03be4SValentin Schneider 	 * become the manager. However a worker could have taken the role of
46529ab03be4SValentin Schneider 	 * manager before the refcnts dropped to 0, since maybe_create_worker()
46539ab03be4SValentin Schneider 	 * drops pool->lock
4654c5aa87bbSTejun Heo 	 */
46559ab03be4SValentin Schneider 	while (true) {
46569ab03be4SValentin Schneider 		rcuwait_wait_event(&manager_wait,
46579ab03be4SValentin Schneider 				   !(pool->flags & POOL_MANAGER_ACTIVE),
4658d8bb65abSSebastian Andrzej Siewior 				   TASK_UNINTERRUPTIBLE);
4659e02b9312SValentin Schneider 
4660e02b9312SValentin Schneider 		mutex_lock(&wq_pool_attach_mutex);
46619ab03be4SValentin Schneider 		raw_spin_lock_irq(&pool->lock);
46629ab03be4SValentin Schneider 		if (!(pool->flags & POOL_MANAGER_ACTIVE)) {
4663692b4825STejun Heo 			pool->flags |= POOL_MANAGER_ACTIVE;
46649ab03be4SValentin Schneider 			break;
46659ab03be4SValentin Schneider 		}
46669ab03be4SValentin Schneider 		raw_spin_unlock_irq(&pool->lock);
4667e02b9312SValentin Schneider 		mutex_unlock(&wq_pool_attach_mutex);
46689ab03be4SValentin Schneider 	}
4669692b4825STejun Heo 
46701037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
4671e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
467229c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
4673a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
467460f5a4bcSLai Jiangshan 
4675e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
4676e02b9312SValentin Schneider 
4677e02b9312SValentin Schneider 	if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers))
467860f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
46791258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
468060f5a4bcSLai Jiangshan 
468160f5a4bcSLai Jiangshan 	if (pool->detach_completion)
468260f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
468360f5a4bcSLai Jiangshan 
468429c91e99STejun Heo 	/* shut down the timers */
468529c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
46863f959aa3SValentin Schneider 	cancel_work_sync(&pool->idle_cull_work);
468729c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
468829c91e99STejun Heo 
468924acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
469025b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
469129c91e99STejun Heo }
469229c91e99STejun Heo 
469329c91e99STejun Heo /**
469429c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
469529c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
469629c91e99STejun Heo  *
469729c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
469829c91e99STejun Heo  * reference count and return it.  If there already is a matching
469929c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
4700d185af30SYacine Belkadi  * create a new one.
4701a892caccSTejun Heo  *
4702a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
4703d185af30SYacine Belkadi  *
4704d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
4705d185af30SYacine Belkadi  * On failure, %NULL.
470629c91e99STejun Heo  */
470729c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
470829c91e99STejun Heo {
470984193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA];
471029c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
471129c91e99STejun Heo 	struct worker_pool *pool;
471284193c07STejun Heo 	int pod, node = NUMA_NO_NODE;
471329c91e99STejun Heo 
4714a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
471529c91e99STejun Heo 
471629c91e99STejun Heo 	/* do we already have a matching pool? */
471729c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
471829c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
471929c91e99STejun Heo 			pool->refcnt++;
47203fb1823cSLai Jiangshan 			return pool;
472129c91e99STejun Heo 		}
472229c91e99STejun Heo 	}
472329c91e99STejun Heo 
47249546b29eSTejun Heo 	/* If __pod_cpumask is contained inside a NUMA pod, that's our node */
472584193c07STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++) {
47269546b29eSTejun Heo 		if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) {
472784193c07STejun Heo 			node = pt->pod_node[pod];
4728e2273584SXunlei Pang 			break;
4729e2273584SXunlei Pang 		}
4730e2273584SXunlei Pang 	}
4731e2273584SXunlei Pang 
473229c91e99STejun Heo 	/* nope, create a new one */
473384193c07STejun Heo 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node);
473429c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
473529c91e99STejun Heo 		goto fail;
473629c91e99STejun Heo 
473784193c07STejun Heo 	pool->node = node;
47385de7a03cSTejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
47395de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
47402865a8fbSShaohua Li 
474129c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
474229c91e99STejun Heo 		goto fail;
474329c91e99STejun Heo 
474429c91e99STejun Heo 	/* create and start the initial worker */
47453347fa09STejun Heo 	if (wq_online && !create_worker(pool))
474629c91e99STejun Heo 		goto fail;
474729c91e99STejun Heo 
474829c91e99STejun Heo 	/* install */
474929c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
47503fb1823cSLai Jiangshan 
475129c91e99STejun Heo 	return pool;
475229c91e99STejun Heo fail:
475329c91e99STejun Heo 	if (pool)
475429c91e99STejun Heo 		put_unbound_pool(pool);
475529c91e99STejun Heo 	return NULL;
475629c91e99STejun Heo }
475729c91e99STejun Heo 
47588864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
47598864b4e5STejun Heo {
47608864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
47618864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
47628864b4e5STejun Heo }
47638864b4e5STejun Heo 
47648864b4e5STejun Heo /*
4765967b494eSTejun Heo  * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero
4766967b494eSTejun Heo  * refcnt and needs to be destroyed.
47678864b4e5STejun Heo  */
4768687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work)
47698864b4e5STejun Heo {
47708864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
4771687a9aa5STejun Heo 						  release_work);
47728864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
47738864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
4774b42b0bddSYang Yingliang 	bool is_last = false;
47758864b4e5STejun Heo 
4776b42b0bddSYang Yingliang 	/*
4777687a9aa5STejun Heo 	 * When @pwq is not linked, it doesn't hold any reference to the
4778b42b0bddSYang Yingliang 	 * @wq, and @wq is invalid to access.
4779b42b0bddSYang Yingliang 	 */
4780b42b0bddSYang Yingliang 	if (!list_empty(&pwq->pwqs_node)) {
47813c25a55dSLai Jiangshan 		mutex_lock(&wq->mutex);
47828864b4e5STejun Heo 		list_del_rcu(&pwq->pwqs_node);
4783bc0caf09STejun Heo 		is_last = list_empty(&wq->pwqs);
47844c065dbcSWaiman Long 
47854c065dbcSWaiman Long 		/*
47864c065dbcSWaiman Long 		 * For ordered workqueue with a plugged dfl_pwq, restart it now.
47874c065dbcSWaiman Long 		 */
47884c065dbcSWaiman Long 		if (!is_last && (wq->flags & __WQ_ORDERED))
47894c065dbcSWaiman Long 			unplug_oldest_pwq(wq);
47904c065dbcSWaiman Long 
47913c25a55dSLai Jiangshan 		mutex_unlock(&wq->mutex);
4792b42b0bddSYang Yingliang 	}
47938864b4e5STejun Heo 
4794687a9aa5STejun Heo 	if (wq->flags & WQ_UNBOUND) {
4795a892caccSTejun Heo 		mutex_lock(&wq_pool_mutex);
47968864b4e5STejun Heo 		put_unbound_pool(pool);
4797a892caccSTejun Heo 		mutex_unlock(&wq_pool_mutex);
4798687a9aa5STejun Heo 	}
4799a892caccSTejun Heo 
48005797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node)) {
48015797b1c1STejun Heo 		struct wq_node_nr_active *nna =
48025797b1c1STejun Heo 			wq_node_nr_active(pwq->wq, pwq->pool->node);
48035797b1c1STejun Heo 
48045797b1c1STejun Heo 		raw_spin_lock_irq(&nna->lock);
48055797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
48065797b1c1STejun Heo 		raw_spin_unlock_irq(&nna->lock);
48075797b1c1STejun Heo 	}
48085797b1c1STejun Heo 
480925b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
48108864b4e5STejun Heo 
48118864b4e5STejun Heo 	/*
48128864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
4813e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
48148864b4e5STejun Heo 	 */
4815669de8bdSBart Van Assche 	if (is_last) {
4816669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
481725b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
48186029a918STejun Heo 	}
4819669de8bdSBart Van Assche }
48208864b4e5STejun Heo 
482167dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */
4822f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
4823f147f29eSTejun Heo 		     struct worker_pool *pool)
4824d2c1d404STejun Heo {
4825d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
4826d2c1d404STejun Heo 
4827e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
4828e50aba9aSTejun Heo 
4829d2c1d404STejun Heo 	pwq->pool = pool;
4830d2c1d404STejun Heo 	pwq->wq = wq;
4831d2c1d404STejun Heo 	pwq->flush_color = -1;
48328864b4e5STejun Heo 	pwq->refcnt = 1;
4833f97a4a1aSLai Jiangshan 	INIT_LIST_HEAD(&pwq->inactive_works);
48345797b1c1STejun Heo 	INIT_LIST_HEAD(&pwq->pending_node);
48351befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
4836d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
4837687a9aa5STejun Heo 	kthread_init_work(&pwq->release_work, pwq_release_workfn);
4838f147f29eSTejun Heo }
4839d2c1d404STejun Heo 
4840f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
48411befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
4842f147f29eSTejun Heo {
4843f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
4844f147f29eSTejun Heo 
4845f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
484675ccf595STejun Heo 
48471befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
48481befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
48491befcf30STejun Heo 		return;
48501befcf30STejun Heo 
485129b1cb41SLai Jiangshan 	/* set the matching work_color */
485275ccf595STejun Heo 	pwq->work_color = wq->work_color;
4853983ca25eSTejun Heo 
4854983ca25eSTejun Heo 	/* link in @pwq */
485526fb7e3dSWaiman Long 	list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
4856df2d5ae4STejun Heo }
48576029a918STejun Heo 
4858f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
4859f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
4860f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
4861f147f29eSTejun Heo {
4862f147f29eSTejun Heo 	struct worker_pool *pool;
4863f147f29eSTejun Heo 	struct pool_workqueue *pwq;
4864f147f29eSTejun Heo 
4865f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4866f147f29eSTejun Heo 
4867f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
4868f147f29eSTejun Heo 	if (!pool)
4869f147f29eSTejun Heo 		return NULL;
4870f147f29eSTejun Heo 
4871e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
4872f147f29eSTejun Heo 	if (!pwq) {
4873f147f29eSTejun Heo 		put_unbound_pool(pool);
4874f147f29eSTejun Heo 		return NULL;
4875f147f29eSTejun Heo 	}
4876f147f29eSTejun Heo 
4877f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
4878f147f29eSTejun Heo 	return pwq;
4879d2c1d404STejun Heo }
4880d2c1d404STejun Heo 
48814c16bd32STejun Heo /**
4882fef59c9cSTejun Heo  * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod
4883042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
488484193c07STejun Heo  * @cpu: the target CPU
48854c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
48864c16bd32STejun Heo  *
4887fef59c9cSTejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @pod. If
4888fef59c9cSTejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during calculation.
48899546b29eSTejun Heo  * The result is stored in @attrs->__pod_cpumask.
48904c16bd32STejun Heo  *
4891fef59c9cSTejun Heo  * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled
4892fef59c9cSTejun Heo  * and @pod has online CPUs requested by @attrs, the returned cpumask is the
4893fef59c9cSTejun Heo  * intersection of the possible CPUs of @pod and @attrs->cpumask.
48944c16bd32STejun Heo  *
4895fef59c9cSTejun Heo  * The caller is responsible for ensuring that the cpumask of @pod stays stable.
48964c16bd32STejun Heo  */
48979546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu,
48989546b29eSTejun Heo 				int cpu_going_down)
48994c16bd32STejun Heo {
490084193c07STejun Heo 	const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
490184193c07STejun Heo 	int pod = pt->cpu_pod[cpu];
49024c16bd32STejun Heo 
4903fef59c9cSTejun Heo 	/* does @pod have any online CPUs @attrs wants? */
49049546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask);
49059546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask);
49064c16bd32STejun Heo 	if (cpu_going_down >= 0)
49079546b29eSTejun Heo 		cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask);
49084c16bd32STejun Heo 
49099546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask)) {
49109546b29eSTejun Heo 		cpumask_copy(attrs->__pod_cpumask, attrs->cpumask);
491184193c07STejun Heo 		return;
491284193c07STejun Heo 	}
49134c16bd32STejun Heo 
4914fef59c9cSTejun Heo 	/* yeap, return possible CPUs in @pod that @attrs wants */
49159546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]);
49161ad0f0a7SMichael Bringmann 
49179546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask))
49181ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
49191ad0f0a7SMichael Bringmann 				"possible intersect\n");
49204c16bd32STejun Heo }
49214c16bd32STejun Heo 
49229f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */
4923636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq,
4924636b927eSTejun Heo 					int cpu, struct pool_workqueue *pwq)
49251befcf30STejun Heo {
49269f66cff2STejun Heo 	struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu);
49271befcf30STejun Heo 	struct pool_workqueue *old_pwq;
49281befcf30STejun Heo 
49295b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
49301befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
49311befcf30STejun Heo 
49321befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
49331befcf30STejun Heo 	link_pwq(pwq);
49341befcf30STejun Heo 
49359f66cff2STejun Heo 	old_pwq = rcu_access_pointer(*slot);
49369f66cff2STejun Heo 	rcu_assign_pointer(*slot, pwq);
49371befcf30STejun Heo 	return old_pwq;
49381befcf30STejun Heo }
49391befcf30STejun Heo 
49402d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
49412d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
49422d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
49432d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
4944042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
49452d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
49462d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
49472d5f0764SLai Jiangshan };
49482d5f0764SLai Jiangshan 
49492d5f0764SLai Jiangshan /* free the resources after success or abort */
49502d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
49512d5f0764SLai Jiangshan {
49522d5f0764SLai Jiangshan 	if (ctx) {
4953636b927eSTejun Heo 		int cpu;
49542d5f0764SLai Jiangshan 
4955636b927eSTejun Heo 		for_each_possible_cpu(cpu)
4956636b927eSTejun Heo 			put_pwq_unlocked(ctx->pwq_tbl[cpu]);
49572d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
49582d5f0764SLai Jiangshan 
49592d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
49602d5f0764SLai Jiangshan 
49612d5f0764SLai Jiangshan 		kfree(ctx);
49622d5f0764SLai Jiangshan 	}
49632d5f0764SLai Jiangshan }
49642d5f0764SLai Jiangshan 
49652d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
49662d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
49672d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
496899c621efSLai Jiangshan 		      const struct workqueue_attrs *attrs,
496999c621efSLai Jiangshan 		      const cpumask_var_t unbound_cpumask)
49702d5f0764SLai Jiangshan {
49712d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
49729546b29eSTejun Heo 	struct workqueue_attrs *new_attrs;
4973636b927eSTejun Heo 	int cpu;
49742d5f0764SLai Jiangshan 
49752d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
49762d5f0764SLai Jiangshan 
497784193c07STejun Heo 	if (WARN_ON(attrs->affn_scope < 0 ||
497884193c07STejun Heo 		    attrs->affn_scope >= WQ_AFFN_NR_TYPES))
497984193c07STejun Heo 		return ERR_PTR(-EINVAL);
498084193c07STejun Heo 
4981636b927eSTejun Heo 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL);
49822d5f0764SLai Jiangshan 
4983be69d00dSThomas Gleixner 	new_attrs = alloc_workqueue_attrs();
49849546b29eSTejun Heo 	if (!ctx || !new_attrs)
49852d5f0764SLai Jiangshan 		goto out_free;
49862d5f0764SLai Jiangshan 
4987042f7df1SLai Jiangshan 	/*
49882d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
49892d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
49902d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
49912d5f0764SLai Jiangshan 	 */
49920f36ee24STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
49930f36ee24STejun Heo 	wqattrs_actualize_cpumask(new_attrs, unbound_cpumask);
49949546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
49952d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
49962d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
49972d5f0764SLai Jiangshan 		goto out_free;
49982d5f0764SLai Jiangshan 
4999636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
5000af73f5c9STejun Heo 		if (new_attrs->ordered) {
50012d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
5002636b927eSTejun Heo 			ctx->pwq_tbl[cpu] = ctx->dfl_pwq;
5003636b927eSTejun Heo 		} else {
50049546b29eSTejun Heo 			wq_calc_pod_cpumask(new_attrs, cpu, -1);
50059546b29eSTejun Heo 			ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs);
5006636b927eSTejun Heo 			if (!ctx->pwq_tbl[cpu])
5007636b927eSTejun Heo 				goto out_free;
50082d5f0764SLai Jiangshan 		}
50092d5f0764SLai Jiangshan 	}
50102d5f0764SLai Jiangshan 
5011042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
5012042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
5013042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
50149546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
50152d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
5016042f7df1SLai Jiangshan 
50174c065dbcSWaiman Long 	/*
50184c065dbcSWaiman Long 	 * For initialized ordered workqueues, there should only be one pwq
50194c065dbcSWaiman Long 	 * (dfl_pwq). Set the plugged flag of ctx->dfl_pwq to suspend execution
50204c065dbcSWaiman Long 	 * of newly queued work items until execution of older work items in
50214c065dbcSWaiman Long 	 * the old pwq's have completed.
50224c065dbcSWaiman Long 	 */
50234c065dbcSWaiman Long 	if ((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))
50244c065dbcSWaiman Long 		ctx->dfl_pwq->plugged = true;
50254c065dbcSWaiman Long 
50262d5f0764SLai Jiangshan 	ctx->wq = wq;
50272d5f0764SLai Jiangshan 	return ctx;
50282d5f0764SLai Jiangshan 
50292d5f0764SLai Jiangshan out_free:
50302d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
50312d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
503284193c07STejun Heo 	return ERR_PTR(-ENOMEM);
50332d5f0764SLai Jiangshan }
50342d5f0764SLai Jiangshan 
50352d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
50362d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
50372d5f0764SLai Jiangshan {
5038636b927eSTejun Heo 	int cpu;
50392d5f0764SLai Jiangshan 
50402d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
50412d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
50422d5f0764SLai Jiangshan 
50432d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
50442d5f0764SLai Jiangshan 
50459f66cff2STejun Heo 	/* save the previous pwqs and install the new ones */
5046636b927eSTejun Heo 	for_each_possible_cpu(cpu)
5047636b927eSTejun Heo 		ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu,
5048636b927eSTejun Heo 							ctx->pwq_tbl[cpu]);
50499f66cff2STejun Heo 	ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq);
50502d5f0764SLai Jiangshan 
50515797b1c1STejun Heo 	/* update node_nr_active->max */
50525797b1c1STejun Heo 	wq_update_node_max_active(ctx->wq, -1);
50535797b1c1STejun Heo 
5054*d64f2fa0SJuri Lelli 	/* rescuer needs to respect wq cpumask changes */
5055*d64f2fa0SJuri Lelli 	if (ctx->wq->rescuer)
5056*d64f2fa0SJuri Lelli 		set_cpus_allowed_ptr(ctx->wq->rescuer->task,
5057*d64f2fa0SJuri Lelli 				     unbound_effective_cpumask(ctx->wq));
5058*d64f2fa0SJuri Lelli 
50592d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
50602d5f0764SLai Jiangshan }
50612d5f0764SLai Jiangshan 
5062a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
5063a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
5064a0111cf6SLai Jiangshan {
5065a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
5066a0111cf6SLai Jiangshan 
5067a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
5068a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
5069a0111cf6SLai Jiangshan 		return -EINVAL;
5070a0111cf6SLai Jiangshan 
507199c621efSLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask);
507284193c07STejun Heo 	if (IS_ERR(ctx))
507384193c07STejun Heo 		return PTR_ERR(ctx);
5074a0111cf6SLai Jiangshan 
5075a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
5076a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
5077a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
5078a0111cf6SLai Jiangshan 
50796201171eSwanghaibin 	return 0;
5080a0111cf6SLai Jiangshan }
5081a0111cf6SLai Jiangshan 
50829e8cd2f5STejun Heo /**
50839e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
50849e8cd2f5STejun Heo  * @wq: the target workqueue
50859e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
50869e8cd2f5STejun Heo  *
5087fef59c9cSTejun Heo  * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps
5088fef59c9cSTejun Heo  * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that
5089fef59c9cSTejun Heo  * work items are affine to the pod it was issued on. Older pwqs are released as
5090fef59c9cSTejun Heo  * in-flight work items finish. Note that a work item which repeatedly requeues
5091fef59c9cSTejun Heo  * itself back-to-back will stay on its current pwq.
50929e8cd2f5STejun Heo  *
5093d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
5094d185af30SYacine Belkadi  *
5095ffd8bea8SSebastian Andrzej Siewior  * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
5096509b3204SDaniel Jordan  *
5097d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
50989e8cd2f5STejun Heo  */
5099513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq,
51009e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
51019e8cd2f5STejun Heo {
5102a0111cf6SLai Jiangshan 	int ret;
51039e8cd2f5STejun Heo 
5104509b3204SDaniel Jordan 	lockdep_assert_cpus_held();
5105509b3204SDaniel Jordan 
5106509b3204SDaniel Jordan 	mutex_lock(&wq_pool_mutex);
5107a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
5108509b3204SDaniel Jordan 	mutex_unlock(&wq_pool_mutex);
51092d5f0764SLai Jiangshan 
51102d5f0764SLai Jiangshan 	return ret;
51119e8cd2f5STejun Heo }
51129e8cd2f5STejun Heo 
51134c16bd32STejun Heo /**
5114fef59c9cSTejun Heo  * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug
51154c16bd32STejun Heo  * @wq: the target workqueue
51164cbfd3deSTejun Heo  * @cpu: the CPU to update pool association for
51174cbfd3deSTejun Heo  * @hotplug_cpu: the CPU coming up or going down
51184c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
51194c16bd32STejun Heo  *
51204c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
5121fef59c9cSTejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update pod affinity of
51224c16bd32STejun Heo  * @wq accordingly.
51234c16bd32STejun Heo  *
51244c16bd32STejun Heo  *
5125fef59c9cSTejun Heo  * If pod affinity can't be adjusted due to memory allocation failure, it falls
5126fef59c9cSTejun Heo  * back to @wq->dfl_pwq which may not be optimal but is always correct.
5127fef59c9cSTejun Heo  *
5128fef59c9cSTejun Heo  * Note that when the last allowed CPU of a pod goes offline for a workqueue
5129fef59c9cSTejun Heo  * with a cpumask spanning multiple pods, the workers which were already
5130fef59c9cSTejun Heo  * executing the work items for the workqueue will lose their CPU affinity and
5131fef59c9cSTejun Heo  * may execute on any CPU. This is similar to how per-cpu workqueues behave on
5132fef59c9cSTejun Heo  * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's
5133fef59c9cSTejun Heo  * responsibility to flush the work item from CPU_DOWN_PREPARE.
51344c16bd32STejun Heo  */
5135fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu,
51364cbfd3deSTejun Heo 			  int hotplug_cpu, bool online)
51374c16bd32STejun Heo {
51384cbfd3deSTejun Heo 	int off_cpu = online ? -1 : hotplug_cpu;
51394c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
51404c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
51414c16bd32STejun Heo 
51424c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
51434c16bd32STejun Heo 
514484193c07STejun Heo 	if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered)
51454c16bd32STejun Heo 		return;
51464c16bd32STejun Heo 
51474c16bd32STejun Heo 	/*
51484c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
51494c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
51504c16bd32STejun Heo 	 * CPU hotplug exclusion.
51514c16bd32STejun Heo 	 */
5152fef59c9cSTejun Heo 	target_attrs = wq_update_pod_attrs_buf;
51534c16bd32STejun Heo 
51544c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
51550f36ee24STejun Heo 	wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask);
51564c16bd32STejun Heo 
5157636b927eSTejun Heo 	/* nothing to do if the target cpumask matches the current pwq */
51589546b29eSTejun Heo 	wq_calc_pod_cpumask(target_attrs, cpu, off_cpu);
51599f66cff2STejun Heo 	if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs))
5160f7142ed4SLai Jiangshan 		return;
51614c16bd32STejun Heo 
51624c16bd32STejun Heo 	/* create a new pwq */
51634c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
51644c16bd32STejun Heo 	if (!pwq) {
5165fef59c9cSTejun Heo 		pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n",
51664c16bd32STejun Heo 			wq->name);
516777f300b1SDaeseok Youn 		goto use_dfl_pwq;
51684c16bd32STejun Heo 	}
51694c16bd32STejun Heo 
5170f7142ed4SLai Jiangshan 	/* Install the new pwq. */
51714c16bd32STejun Heo 	mutex_lock(&wq->mutex);
5172636b927eSTejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
51734c16bd32STejun Heo 	goto out_unlock;
51744c16bd32STejun Heo 
51754c16bd32STejun Heo use_dfl_pwq:
5176f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
51779f66cff2STejun Heo 	pwq = unbound_pwq(wq, -1);
51789f66cff2STejun Heo 	raw_spin_lock_irq(&pwq->pool->lock);
51799f66cff2STejun Heo 	get_pwq(pwq);
51809f66cff2STejun Heo 	raw_spin_unlock_irq(&pwq->pool->lock);
51819f66cff2STejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
51824c16bd32STejun Heo out_unlock:
51834c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
51844c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
51854c16bd32STejun Heo }
51864c16bd32STejun Heo 
518730cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
51881da177e4SLinus Torvalds {
518949e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
51908a2b7538STejun Heo 	int cpu, ret;
5191e1d8aa9fSFrederic Weisbecker 
5192687a9aa5STejun Heo 	wq->cpu_pwq = alloc_percpu(struct pool_workqueue *);
5193ee1ceef7STejun Heo 	if (!wq->cpu_pwq)
5194687a9aa5STejun Heo 		goto enomem;
519530cdf249STejun Heo 
5196636b927eSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
519730cdf249STejun Heo 		for_each_possible_cpu(cpu) {
51984cb1ef64STejun Heo 			struct pool_workqueue **pwq_p;
51994cb1ef64STejun Heo 			struct worker_pool __percpu *pools;
52004cb1ef64STejun Heo 			struct worker_pool *pool;
52014cb1ef64STejun Heo 
52024cb1ef64STejun Heo 			if (wq->flags & WQ_BH)
52034cb1ef64STejun Heo 				pools = bh_worker_pools;
52044cb1ef64STejun Heo 			else
52054cb1ef64STejun Heo 				pools = cpu_worker_pools;
52064cb1ef64STejun Heo 
52074cb1ef64STejun Heo 			pool = &(per_cpu_ptr(pools, cpu)[highpri]);
52084cb1ef64STejun Heo 			pwq_p = per_cpu_ptr(wq->cpu_pwq, cpu);
520930cdf249STejun Heo 
5210687a9aa5STejun Heo 			*pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL,
5211687a9aa5STejun Heo 						       pool->node);
5212687a9aa5STejun Heo 			if (!*pwq_p)
5213687a9aa5STejun Heo 				goto enomem;
5214687a9aa5STejun Heo 
5215687a9aa5STejun Heo 			init_pwq(*pwq_p, wq, pool);
5216f147f29eSTejun Heo 
5217f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
5218687a9aa5STejun Heo 			link_pwq(*pwq_p);
5219f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
522030cdf249STejun Heo 		}
522130cdf249STejun Heo 		return 0;
5222509b3204SDaniel Jordan 	}
5223509b3204SDaniel Jordan 
5224ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
5225509b3204SDaniel Jordan 	if (wq->flags & __WQ_ORDERED) {
52269f66cff2STejun Heo 		struct pool_workqueue *dfl_pwq;
52279f66cff2STejun Heo 
52288a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
52298a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
52309f66cff2STejun Heo 		dfl_pwq = rcu_access_pointer(wq->dfl_pwq);
52319f66cff2STejun Heo 		WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node ||
52329f66cff2STejun Heo 			      wq->pwqs.prev != &dfl_pwq->pwqs_node),
52338a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
52349e8cd2f5STejun Heo 	} else {
5235509b3204SDaniel Jordan 		ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
52369e8cd2f5STejun Heo 	}
5237ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
5238509b3204SDaniel Jordan 
523964344553SZqiang 	/* for unbound pwq, flush the pwq_release_worker ensures that the
524064344553SZqiang 	 * pwq_release_workfn() completes before calling kfree(wq).
524164344553SZqiang 	 */
524264344553SZqiang 	if (ret)
524364344553SZqiang 		kthread_flush_worker(pwq_release_worker);
524464344553SZqiang 
5245509b3204SDaniel Jordan 	return ret;
5246687a9aa5STejun Heo 
5247687a9aa5STejun Heo enomem:
5248687a9aa5STejun Heo 	if (wq->cpu_pwq) {
52497b42f401SZqiang 		for_each_possible_cpu(cpu) {
52507b42f401SZqiang 			struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
52517b42f401SZqiang 
52527b42f401SZqiang 			if (pwq)
52537b42f401SZqiang 				kmem_cache_free(pwq_cache, pwq);
52547b42f401SZqiang 		}
5255687a9aa5STejun Heo 		free_percpu(wq->cpu_pwq);
5256687a9aa5STejun Heo 		wq->cpu_pwq = NULL;
5257687a9aa5STejun Heo 	}
5258687a9aa5STejun Heo 	return -ENOMEM;
52590f900049STejun Heo }
52600f900049STejun Heo 
5261f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
5262f3421797STejun Heo 			       const char *name)
5263b71ab8c2STejun Heo {
5264636b927eSTejun Heo 	if (max_active < 1 || max_active > WQ_MAX_ACTIVE)
5265044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
5266636b927eSTejun Heo 			max_active, name, 1, WQ_MAX_ACTIVE);
5267b71ab8c2STejun Heo 
5268636b927eSTejun Heo 	return clamp_val(max_active, 1, WQ_MAX_ACTIVE);
5269b71ab8c2STejun Heo }
5270b71ab8c2STejun Heo 
5271983c7515STejun Heo /*
5272983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
5273983c7515STejun Heo  * to guarantee forward progress.
5274983c7515STejun Heo  */
5275983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
5276983c7515STejun Heo {
5277983c7515STejun Heo 	struct worker *rescuer;
5278b92b36eaSDan Carpenter 	int ret;
5279983c7515STejun Heo 
5280983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
5281983c7515STejun Heo 		return 0;
5282983c7515STejun Heo 
5283983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
52844c0736a7SPetr Mladek 	if (!rescuer) {
52854c0736a7SPetr Mladek 		pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n",
52864c0736a7SPetr Mladek 		       wq->name);
5287983c7515STejun Heo 		return -ENOMEM;
52884c0736a7SPetr Mladek 	}
5289983c7515STejun Heo 
5290983c7515STejun Heo 	rescuer->rescue_wq = wq;
5291b6a46f72SAaron Tomlin 	rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name);
5292f187b697SSean Fu 	if (IS_ERR(rescuer->task)) {
5293b92b36eaSDan Carpenter 		ret = PTR_ERR(rescuer->task);
52944c0736a7SPetr Mladek 		pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe",
52954c0736a7SPetr Mladek 		       wq->name, ERR_PTR(ret));
5296983c7515STejun Heo 		kfree(rescuer);
5297b92b36eaSDan Carpenter 		return ret;
5298983c7515STejun Heo 	}
5299983c7515STejun Heo 
5300983c7515STejun Heo 	wq->rescuer = rescuer;
530185f0ab43SJuri Lelli 	if (wq->flags & WQ_UNBOUND)
530285f0ab43SJuri Lelli 		kthread_bind_mask(rescuer->task, wq->unbound_attrs->cpumask);
530385f0ab43SJuri Lelli 	else
5304983c7515STejun Heo 		kthread_bind_mask(rescuer->task, cpu_possible_mask);
5305983c7515STejun Heo 	wake_up_process(rescuer->task);
5306983c7515STejun Heo 
5307983c7515STejun Heo 	return 0;
5308983c7515STejun Heo }
5309983c7515STejun Heo 
5310a045a272STejun Heo /**
5311a045a272STejun Heo  * wq_adjust_max_active - update a wq's max_active to the current setting
5312a045a272STejun Heo  * @wq: target workqueue
5313a045a272STejun Heo  *
5314a045a272STejun Heo  * If @wq isn't freezing, set @wq->max_active to the saved_max_active and
5315a045a272STejun Heo  * activate inactive work items accordingly. If @wq is freezing, clear
5316a045a272STejun Heo  * @wq->max_active to zero.
5317a045a272STejun Heo  */
5318a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq)
5319a045a272STejun Heo {
5320c5404d4eSTejun Heo 	bool activated;
53215797b1c1STejun Heo 	int new_max, new_min;
5322a045a272STejun Heo 
5323a045a272STejun Heo 	lockdep_assert_held(&wq->mutex);
5324a045a272STejun Heo 
5325a045a272STejun Heo 	if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) {
53265797b1c1STejun Heo 		new_max = 0;
53275797b1c1STejun Heo 		new_min = 0;
53285797b1c1STejun Heo 	} else {
53295797b1c1STejun Heo 		new_max = wq->saved_max_active;
53305797b1c1STejun Heo 		new_min = wq->saved_min_active;
5331a045a272STejun Heo 	}
5332a045a272STejun Heo 
53335797b1c1STejun Heo 	if (wq->max_active == new_max && wq->min_active == new_min)
5334a045a272STejun Heo 		return;
5335a045a272STejun Heo 
5336a045a272STejun Heo 	/*
53375797b1c1STejun Heo 	 * Update @wq->max/min_active and then kick inactive work items if more
5338a045a272STejun Heo 	 * active work items are allowed. This doesn't break work item ordering
5339a045a272STejun Heo 	 * because new work items are always queued behind existing inactive
5340a045a272STejun Heo 	 * work items if there are any.
5341a045a272STejun Heo 	 */
53425797b1c1STejun Heo 	WRITE_ONCE(wq->max_active, new_max);
53435797b1c1STejun Heo 	WRITE_ONCE(wq->min_active, new_min);
53445797b1c1STejun Heo 
53455797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
53465797b1c1STejun Heo 		wq_update_node_max_active(wq, -1);
53475797b1c1STejun Heo 
53485797b1c1STejun Heo 	if (new_max == 0)
53495797b1c1STejun Heo 		return;
5350a045a272STejun Heo 
5351c5404d4eSTejun Heo 	/*
5352c5404d4eSTejun Heo 	 * Round-robin through pwq's activating the first inactive work item
5353c5404d4eSTejun Heo 	 * until max_active is filled.
5354c5404d4eSTejun Heo 	 */
5355c5404d4eSTejun Heo 	do {
5356c5404d4eSTejun Heo 		struct pool_workqueue *pwq;
5357c5404d4eSTejun Heo 
5358c5404d4eSTejun Heo 		activated = false;
5359a045a272STejun Heo 		for_each_pwq(pwq, wq) {
5360a045a272STejun Heo 			unsigned long flags;
5361a045a272STejun Heo 
5362c5404d4eSTejun Heo 			/* can be called during early boot w/ irq disabled */
5363a045a272STejun Heo 			raw_spin_lock_irqsave(&pwq->pool->lock, flags);
53645797b1c1STejun Heo 			if (pwq_activate_first_inactive(pwq, true)) {
5365c5404d4eSTejun Heo 				activated = true;
5366a045a272STejun Heo 				kick_pool(pwq->pool);
5367c5404d4eSTejun Heo 			}
5368a045a272STejun Heo 			raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
5369a045a272STejun Heo 		}
5370c5404d4eSTejun Heo 	} while (activated);
5371a045a272STejun Heo }
5372a045a272STejun Heo 
5373a2775bbcSMathieu Malaterre __printf(1, 4)
5374669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
537597e37d7bSTejun Heo 					 unsigned int flags,
5376669de8bdSBart Van Assche 					 int max_active, ...)
53773af24433SOleg Nesterov {
5378ecf6881fSTejun Heo 	va_list args;
53793af24433SOleg Nesterov 	struct workqueue_struct *wq;
538091ccc6e7STejun Heo 	size_t wq_size;
538191ccc6e7STejun Heo 	int name_len;
5382b196be89STejun Heo 
53834cb1ef64STejun Heo 	if (flags & WQ_BH) {
53844cb1ef64STejun Heo 		if (WARN_ON_ONCE(flags & ~__WQ_BH_ALLOWS))
53854cb1ef64STejun Heo 			return NULL;
53864cb1ef64STejun Heo 		if (WARN_ON_ONCE(max_active))
53874cb1ef64STejun Heo 			return NULL;
53884cb1ef64STejun Heo 	}
53894cb1ef64STejun Heo 
5390cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
5391cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
5392cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
5393cee22a15SViresh Kumar 
5394ecf6881fSTejun Heo 	/* allocate wq and format name */
539591ccc6e7STejun Heo 	if (flags & WQ_UNBOUND)
539691ccc6e7STejun Heo 		wq_size = struct_size(wq, node_nr_active, nr_node_ids + 1);
539791ccc6e7STejun Heo 	else
539891ccc6e7STejun Heo 		wq_size = sizeof(*wq);
539991ccc6e7STejun Heo 
540091ccc6e7STejun Heo 	wq = kzalloc(wq_size, GFP_KERNEL);
5401b196be89STejun Heo 	if (!wq)
5402d2c1d404STejun Heo 		return NULL;
5403b196be89STejun Heo 
54046029a918STejun Heo 	if (flags & WQ_UNBOUND) {
5405be69d00dSThomas Gleixner 		wq->unbound_attrs = alloc_workqueue_attrs();
54066029a918STejun Heo 		if (!wq->unbound_attrs)
54076029a918STejun Heo 			goto err_free_wq;
54086029a918STejun Heo 	}
54096029a918STejun Heo 
5410669de8bdSBart Van Assche 	va_start(args, max_active);
541191ccc6e7STejun Heo 	name_len = vsnprintf(wq->name, sizeof(wq->name), fmt, args);
5412b196be89STejun Heo 	va_end(args);
54133af24433SOleg Nesterov 
541491ccc6e7STejun Heo 	if (name_len >= WQ_NAME_LEN)
541591ccc6e7STejun Heo 		pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n",
541691ccc6e7STejun Heo 			     wq->name);
541731c89007SAudra Mitchell 
54184cb1ef64STejun Heo 	if (flags & WQ_BH) {
54194cb1ef64STejun Heo 		/*
54204cb1ef64STejun Heo 		 * BH workqueues always share a single execution context per CPU
54214cb1ef64STejun Heo 		 * and don't impose any max_active limit.
54224cb1ef64STejun Heo 		 */
54234cb1ef64STejun Heo 		max_active = INT_MAX;
54244cb1ef64STejun Heo 	} else {
5425d320c038STejun Heo 		max_active = max_active ?: WQ_DFL_ACTIVE;
5426b196be89STejun Heo 		max_active = wq_clamp_max_active(max_active, flags, wq->name);
54274cb1ef64STejun Heo 	}
54283af24433SOleg Nesterov 
5429b196be89STejun Heo 	/* init wq */
543097e37d7bSTejun Heo 	wq->flags = flags;
5431a045a272STejun Heo 	wq->max_active = max_active;
54325797b1c1STejun Heo 	wq->min_active = min(max_active, WQ_DFL_MIN_ACTIVE);
54335797b1c1STejun Heo 	wq->saved_max_active = wq->max_active;
54345797b1c1STejun Heo 	wq->saved_min_active = wq->min_active;
54353c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
5436112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
543730cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
543873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
543973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
5440493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
54413af24433SOleg Nesterov 
5442669de8bdSBart Van Assche 	wq_init_lockdep(wq);
5443cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
54443af24433SOleg Nesterov 
544591ccc6e7STejun Heo 	if (flags & WQ_UNBOUND) {
544691ccc6e7STejun Heo 		if (alloc_node_nr_active(wq->node_nr_active) < 0)
544782efcab3SBart Van Assche 			goto err_unreg_lockdep;
544891ccc6e7STejun Heo 	}
544991ccc6e7STejun Heo 
545091ccc6e7STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
545191ccc6e7STejun Heo 		goto err_free_node_nr_active;
54521537663fSTejun Heo 
545340c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
5454d2c1d404STejun Heo 		goto err_destroy;
5455e22bee78STejun Heo 
5456226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
5457226223abSTejun Heo 		goto err_destroy;
5458226223abSTejun Heo 
54596af8bf3dSOleg Nesterov 	/*
546068e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
546168e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
546268e13a67SLai Jiangshan 	 * list.
54636af8bf3dSOleg Nesterov 	 */
546468e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5465a0a1a5fdSTejun Heo 
5466a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5467a045a272STejun Heo 	wq_adjust_max_active(wq);
5468a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5469a0a1a5fdSTejun Heo 
5470e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
5471a0a1a5fdSTejun Heo 
547268e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
54733af24433SOleg Nesterov 
54743af24433SOleg Nesterov 	return wq;
5475d2c1d404STejun Heo 
547691ccc6e7STejun Heo err_free_node_nr_active:
547791ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
547891ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
547982efcab3SBart Van Assche err_unreg_lockdep:
5480009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
5481009bb421SBart Van Assche 	wq_free_lockdep(wq);
548282efcab3SBart Van Assche err_free_wq:
54836029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
54844690c4abSTejun Heo 	kfree(wq);
5485d2c1d404STejun Heo 	return NULL;
5486d2c1d404STejun Heo err_destroy:
5487d2c1d404STejun Heo 	destroy_workqueue(wq);
54884690c4abSTejun Heo 	return NULL;
54891da177e4SLinus Torvalds }
5490669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
54911da177e4SLinus Torvalds 
5492c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq)
5493c29eb853STejun Heo {
5494c29eb853STejun Heo 	int i;
5495c29eb853STejun Heo 
5496c29eb853STejun Heo 	for (i = 0; i < WORK_NR_COLORS; i++)
5497c29eb853STejun Heo 		if (pwq->nr_in_flight[i])
5498c29eb853STejun Heo 			return true;
5499c29eb853STejun Heo 
55009f66cff2STejun Heo 	if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1))
5501c29eb853STejun Heo 		return true;
5502afa87ce8STejun Heo 	if (!pwq_is_empty(pwq))
5503c29eb853STejun Heo 		return true;
5504c29eb853STejun Heo 
5505c29eb853STejun Heo 	return false;
5506c29eb853STejun Heo }
5507c29eb853STejun Heo 
55083af24433SOleg Nesterov /**
55093af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
55103af24433SOleg Nesterov  * @wq: target workqueue
55113af24433SOleg Nesterov  *
55123af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
55133af24433SOleg Nesterov  */
55143af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
55153af24433SOleg Nesterov {
551649e3cf44STejun Heo 	struct pool_workqueue *pwq;
5517636b927eSTejun Heo 	int cpu;
55183af24433SOleg Nesterov 
5519def98c84STejun Heo 	/*
5520def98c84STejun Heo 	 * Remove it from sysfs first so that sanity check failure doesn't
5521def98c84STejun Heo 	 * lead to sysfs name conflicts.
5522def98c84STejun Heo 	 */
5523def98c84STejun Heo 	workqueue_sysfs_unregister(wq);
5524def98c84STejun Heo 
552533e3f0a3SRichard Clark 	/* mark the workqueue destruction is in progress */
552633e3f0a3SRichard Clark 	mutex_lock(&wq->mutex);
552733e3f0a3SRichard Clark 	wq->flags |= __WQ_DESTROYING;
552833e3f0a3SRichard Clark 	mutex_unlock(&wq->mutex);
552933e3f0a3SRichard Clark 
55309c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
55319c5a2ba7STejun Heo 	drain_workqueue(wq);
5532c8efcc25STejun Heo 
5533def98c84STejun Heo 	/* kill rescuer, if sanity checks fail, leave it w/o rescuer */
5534def98c84STejun Heo 	if (wq->rescuer) {
5535def98c84STejun Heo 		struct worker *rescuer = wq->rescuer;
5536def98c84STejun Heo 
5537def98c84STejun Heo 		/* this prevents new queueing */
5538a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
5539def98c84STejun Heo 		wq->rescuer = NULL;
5540a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
5541def98c84STejun Heo 
5542def98c84STejun Heo 		/* rescuer will empty maydays list before exiting */
5543def98c84STejun Heo 		kthread_stop(rescuer->task);
55448efe1223STejun Heo 		kfree(rescuer);
5545def98c84STejun Heo 	}
5546def98c84STejun Heo 
5547c29eb853STejun Heo 	/*
5548c29eb853STejun Heo 	 * Sanity checks - grab all the locks so that we wait for all
5549c29eb853STejun Heo 	 * in-flight operations which may do put_pwq().
5550c29eb853STejun Heo 	 */
5551c29eb853STejun Heo 	mutex_lock(&wq_pool_mutex);
5552b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
555349e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
5554a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
5555c29eb853STejun Heo 		if (WARN_ON(pwq_busy(pwq))) {
55561d9a6159SKefeng Wang 			pr_warn("%s: %s has the following busy pwq\n",
5557e66b39afSTejun Heo 				__func__, wq->name);
5558c29eb853STejun Heo 			show_pwq(pwq);
5559a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pwq->pool->lock);
5560b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
5561c29eb853STejun Heo 			mutex_unlock(&wq_pool_mutex);
556255df0933SImran Khan 			show_one_workqueue(wq);
55636183c009STejun Heo 			return;
556476af4d93STejun Heo 		}
5565a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
556676af4d93STejun Heo 	}
5567b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
55686183c009STejun Heo 
5569a0a1a5fdSTejun Heo 	/*
5570a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
5571a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
5572a0a1a5fdSTejun Heo 	 */
5573e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
557468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
55753af24433SOleg Nesterov 
55768864b4e5STejun Heo 	/*
5577636b927eSTejun Heo 	 * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq
5578636b927eSTejun Heo 	 * to put the base refs. @wq will be auto-destroyed from the last
5579636b927eSTejun Heo 	 * pwq_put. RCU read lock prevents @wq from going away from under us.
55808864b4e5STejun Heo 	 */
5581636b927eSTejun Heo 	rcu_read_lock();
5582636b927eSTejun Heo 
5583636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
55849f66cff2STejun Heo 		put_pwq_unlocked(unbound_pwq(wq, cpu));
55859f66cff2STejun Heo 		RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL);
55864c16bd32STejun Heo 	}
55874c16bd32STejun Heo 
55889f66cff2STejun Heo 	put_pwq_unlocked(unbound_pwq(wq, -1));
55899f66cff2STejun Heo 	RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL);
5590636b927eSTejun Heo 
5591636b927eSTejun Heo 	rcu_read_unlock();
55923af24433SOleg Nesterov }
55933af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
55943af24433SOleg Nesterov 
5595dcd989cbSTejun Heo /**
5596dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
5597dcd989cbSTejun Heo  * @wq: target workqueue
5598dcd989cbSTejun Heo  * @max_active: new max_active value.
5599dcd989cbSTejun Heo  *
56005797b1c1STejun Heo  * Set max_active of @wq to @max_active. See the alloc_workqueue() function
56015797b1c1STejun Heo  * comment.
5602dcd989cbSTejun Heo  *
5603dcd989cbSTejun Heo  * CONTEXT:
5604dcd989cbSTejun Heo  * Don't call from IRQ context.
5605dcd989cbSTejun Heo  */
5606dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
5607dcd989cbSTejun Heo {
56084cb1ef64STejun Heo 	/* max_active doesn't mean anything for BH workqueues */
56094cb1ef64STejun Heo 	if (WARN_ON(wq->flags & WQ_BH))
56104cb1ef64STejun Heo 		return;
56118719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
56123bc1e711STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
56138719dceaSTejun Heo 		return;
56148719dceaSTejun Heo 
5615f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
5616dcd989cbSTejun Heo 
5617a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5618dcd989cbSTejun Heo 
5619dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
56205797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
56215797b1c1STejun Heo 		wq->saved_min_active = min(wq->saved_min_active, max_active);
56225797b1c1STejun Heo 
5623a045a272STejun Heo 	wq_adjust_max_active(wq);
5624dcd989cbSTejun Heo 
5625a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5626dcd989cbSTejun Heo }
5627dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
5628dcd989cbSTejun Heo 
5629dcd989cbSTejun Heo /**
563027d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
563127d4ee03SLukas Wunner  *
563227d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
563327d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
563427d4ee03SLukas Wunner  *
563527d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
563627d4ee03SLukas Wunner  */
563727d4ee03SLukas Wunner struct work_struct *current_work(void)
563827d4ee03SLukas Wunner {
563927d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
564027d4ee03SLukas Wunner 
564127d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
564227d4ee03SLukas Wunner }
564327d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
564427d4ee03SLukas Wunner 
564527d4ee03SLukas Wunner /**
5646e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
5647e6267616STejun Heo  *
5648e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
5649e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
5650d185af30SYacine Belkadi  *
5651d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
5652e6267616STejun Heo  */
5653e6267616STejun Heo bool current_is_workqueue_rescuer(void)
5654e6267616STejun Heo {
5655e6267616STejun Heo 	struct worker *worker = current_wq_worker();
5656e6267616STejun Heo 
56576a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
5658e6267616STejun Heo }
5659e6267616STejun Heo 
5660e6267616STejun Heo /**
5661dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
5662dcd989cbSTejun Heo  * @cpu: CPU in question
5663dcd989cbSTejun Heo  * @wq: target workqueue
5664dcd989cbSTejun Heo  *
5665dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
5666dcd989cbSTejun Heo  * no synchronization around this function and the test result is
5667dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5668dcd989cbSTejun Heo  *
5669d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
5670636b927eSTejun Heo  *
5671636b927eSTejun Heo  * With the exception of ordered workqueues, all workqueues have per-cpu
5672636b927eSTejun Heo  * pool_workqueues, each with its own congested state. A workqueue being
5673636b927eSTejun Heo  * congested on one CPU doesn't mean that the workqueue is contested on any
5674636b927eSTejun Heo  * other CPUs.
5675d3251859STejun Heo  *
5676d185af30SYacine Belkadi  * Return:
5677dcd989cbSTejun Heo  * %true if congested, %false otherwise.
5678dcd989cbSTejun Heo  */
5679d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
5680dcd989cbSTejun Heo {
56817fb98ea7STejun Heo 	struct pool_workqueue *pwq;
568276af4d93STejun Heo 	bool ret;
568376af4d93STejun Heo 
568424acfb71SThomas Gleixner 	rcu_read_lock();
568524acfb71SThomas Gleixner 	preempt_disable();
56867fb98ea7STejun Heo 
5687d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
5688d3251859STejun Heo 		cpu = smp_processor_id();
5689d3251859STejun Heo 
5690687a9aa5STejun Heo 	pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
5691f97a4a1aSLai Jiangshan 	ret = !list_empty(&pwq->inactive_works);
5692636b927eSTejun Heo 
569324acfb71SThomas Gleixner 	preempt_enable();
569424acfb71SThomas Gleixner 	rcu_read_unlock();
569576af4d93STejun Heo 
569676af4d93STejun Heo 	return ret;
5697dcd989cbSTejun Heo }
5698dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
5699dcd989cbSTejun Heo 
5700dcd989cbSTejun Heo /**
5701dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
5702dcd989cbSTejun Heo  * @work: the work to be tested
5703dcd989cbSTejun Heo  *
5704dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
5705dcd989cbSTejun Heo  * synchronization around this function and the test result is
5706dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5707dcd989cbSTejun Heo  *
5708d185af30SYacine Belkadi  * Return:
5709dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
5710dcd989cbSTejun Heo  */
5711dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
5712dcd989cbSTejun Heo {
5713fa1b54e6STejun Heo 	struct worker_pool *pool;
5714dcd989cbSTejun Heo 	unsigned long flags;
5715dcd989cbSTejun Heo 	unsigned int ret = 0;
5716dcd989cbSTejun Heo 
5717dcd989cbSTejun Heo 	if (work_pending(work))
5718dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
5719038366c5SLai Jiangshan 
572024acfb71SThomas Gleixner 	rcu_read_lock();
5721fa1b54e6STejun Heo 	pool = get_work_pool(work);
5722038366c5SLai Jiangshan 	if (pool) {
5723a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pool->lock, flags);
5724c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
5725dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
5726a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pool->lock, flags);
5727038366c5SLai Jiangshan 	}
572824acfb71SThomas Gleixner 	rcu_read_unlock();
5729dcd989cbSTejun Heo 
5730dcd989cbSTejun Heo 	return ret;
5731dcd989cbSTejun Heo }
5732dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
5733dcd989cbSTejun Heo 
57343d1cb205STejun Heo /**
57353d1cb205STejun Heo  * set_worker_desc - set description for the current work item
57363d1cb205STejun Heo  * @fmt: printf-style format string
57373d1cb205STejun Heo  * @...: arguments for the format string
57383d1cb205STejun Heo  *
57393d1cb205STejun Heo  * This function can be called by a running work function to describe what
57403d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
57413d1cb205STejun Heo  * information will be printed out together to help debugging.  The
57423d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
57433d1cb205STejun Heo  */
57443d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
57453d1cb205STejun Heo {
57463d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
57473d1cb205STejun Heo 	va_list args;
57483d1cb205STejun Heo 
57493d1cb205STejun Heo 	if (worker) {
57503d1cb205STejun Heo 		va_start(args, fmt);
57513d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
57523d1cb205STejun Heo 		va_end(args);
57533d1cb205STejun Heo 	}
57543d1cb205STejun Heo }
57555c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
57563d1cb205STejun Heo 
57573d1cb205STejun Heo /**
57583d1cb205STejun Heo  * print_worker_info - print out worker information and description
57593d1cb205STejun Heo  * @log_lvl: the log level to use when printing
57603d1cb205STejun Heo  * @task: target task
57613d1cb205STejun Heo  *
57623d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
57633d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
57643d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
57653d1cb205STejun Heo  *
57663d1cb205STejun Heo  * This function can be safely called on any task as long as the
57673d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
57683d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
57693d1cb205STejun Heo  */
57703d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
57713d1cb205STejun Heo {
57723d1cb205STejun Heo 	work_func_t *fn = NULL;
57733d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
57743d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
57753d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
57763d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
57773d1cb205STejun Heo 	struct worker *worker;
57783d1cb205STejun Heo 
57793d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
57803d1cb205STejun Heo 		return;
57813d1cb205STejun Heo 
57823d1cb205STejun Heo 	/*
57833d1cb205STejun Heo 	 * This function is called without any synchronization and @task
57843d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
57853d1cb205STejun Heo 	 */
5786e700591aSPetr Mladek 	worker = kthread_probe_data(task);
57873d1cb205STejun Heo 
57883d1cb205STejun Heo 	/*
57898bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
57908bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
57913d1cb205STejun Heo 	 */
5792fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
5793fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
5794fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
5795fe557319SChristoph Hellwig 	copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
5796fe557319SChristoph Hellwig 	copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
57973d1cb205STejun Heo 
57983d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
5799d75f773cSSakari Ailus 		printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
58008bf89593STejun Heo 		if (strcmp(name, desc))
58013d1cb205STejun Heo 			pr_cont(" (%s)", desc);
58023d1cb205STejun Heo 		pr_cont("\n");
58033d1cb205STejun Heo 	}
58043d1cb205STejun Heo }
58053d1cb205STejun Heo 
58063494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
58073494fc30STejun Heo {
58083494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
58093494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
58103494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
58114cb1ef64STejun Heo 	pr_cont(" flags=0x%x", pool->flags);
58124cb1ef64STejun Heo 	if (pool->flags & POOL_BH)
58134cb1ef64STejun Heo 		pr_cont(" bh%s",
58144cb1ef64STejun Heo 			pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : "");
58154cb1ef64STejun Heo 	else
58164cb1ef64STejun Heo 		pr_cont(" nice=%d", pool->attrs->nice);
58174cb1ef64STejun Heo }
58184cb1ef64STejun Heo 
58194cb1ef64STejun Heo static void pr_cont_worker_id(struct worker *worker)
58204cb1ef64STejun Heo {
58214cb1ef64STejun Heo 	struct worker_pool *pool = worker->pool;
58224cb1ef64STejun Heo 
58234cb1ef64STejun Heo 	if (pool->flags & WQ_BH)
58244cb1ef64STejun Heo 		pr_cont("bh%s",
58254cb1ef64STejun Heo 			pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : "");
58264cb1ef64STejun Heo 	else
58274cb1ef64STejun Heo 		pr_cont("%d%s", task_pid_nr(worker->task),
58284cb1ef64STejun Heo 			worker->rescue_wq ? "(RESCUER)" : "");
58293494fc30STejun Heo }
58303494fc30STejun Heo 
5831c76feb0dSPaul E. McKenney struct pr_cont_work_struct {
5832c76feb0dSPaul E. McKenney 	bool comma;
5833c76feb0dSPaul E. McKenney 	work_func_t func;
5834c76feb0dSPaul E. McKenney 	long ctr;
5835c76feb0dSPaul E. McKenney };
5836c76feb0dSPaul E. McKenney 
5837c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp)
5838c76feb0dSPaul E. McKenney {
5839c76feb0dSPaul E. McKenney 	if (!pcwsp->ctr)
5840c76feb0dSPaul E. McKenney 		goto out_record;
5841c76feb0dSPaul E. McKenney 	if (func == pcwsp->func) {
5842c76feb0dSPaul E. McKenney 		pcwsp->ctr++;
5843c76feb0dSPaul E. McKenney 		return;
5844c76feb0dSPaul E. McKenney 	}
5845c76feb0dSPaul E. McKenney 	if (pcwsp->ctr == 1)
5846c76feb0dSPaul E. McKenney 		pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func);
5847c76feb0dSPaul E. McKenney 	else
5848c76feb0dSPaul E. McKenney 		pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func);
5849c76feb0dSPaul E. McKenney 	pcwsp->ctr = 0;
5850c76feb0dSPaul E. McKenney out_record:
5851c76feb0dSPaul E. McKenney 	if ((long)func == -1L)
5852c76feb0dSPaul E. McKenney 		return;
5853c76feb0dSPaul E. McKenney 	pcwsp->comma = comma;
5854c76feb0dSPaul E. McKenney 	pcwsp->func = func;
5855c76feb0dSPaul E. McKenney 	pcwsp->ctr = 1;
5856c76feb0dSPaul E. McKenney }
5857c76feb0dSPaul E. McKenney 
5858c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp)
58593494fc30STejun Heo {
58603494fc30STejun Heo 	if (work->func == wq_barrier_func) {
58613494fc30STejun Heo 		struct wq_barrier *barr;
58623494fc30STejun Heo 
58633494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
58643494fc30STejun Heo 
5865c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
58663494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
58673494fc30STejun Heo 			task_pid_nr(barr->task));
58683494fc30STejun Heo 	} else {
5869c76feb0dSPaul E. McKenney 		if (!comma)
5870c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
5871c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, work->func, pcwsp);
58723494fc30STejun Heo 	}
58733494fc30STejun Heo }
58743494fc30STejun Heo 
58753494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
58763494fc30STejun Heo {
5877c76feb0dSPaul E. McKenney 	struct pr_cont_work_struct pcws = { .ctr = 0, };
58783494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
58793494fc30STejun Heo 	struct work_struct *work;
58803494fc30STejun Heo 	struct worker *worker;
58813494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
58823494fc30STejun Heo 	int bkt;
58833494fc30STejun Heo 
58843494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
58853494fc30STejun Heo 	pr_cont_pool_info(pool);
58863494fc30STejun Heo 
5887a045a272STejun Heo 	pr_cont(" active=%d refcnt=%d%s\n",
5888a045a272STejun Heo 		pwq->nr_active, pwq->refcnt,
58893494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
58903494fc30STejun Heo 
58913494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
58923494fc30STejun Heo 		if (worker->current_pwq == pwq) {
58933494fc30STejun Heo 			has_in_flight = true;
58943494fc30STejun Heo 			break;
58953494fc30STejun Heo 		}
58963494fc30STejun Heo 	}
58973494fc30STejun Heo 	if (has_in_flight) {
58983494fc30STejun Heo 		bool comma = false;
58993494fc30STejun Heo 
59003494fc30STejun Heo 		pr_info("    in-flight:");
59013494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
59023494fc30STejun Heo 			if (worker->current_pwq != pwq)
59033494fc30STejun Heo 				continue;
59043494fc30STejun Heo 
59054cb1ef64STejun Heo 			pr_cont(" %s", comma ? "," : "");
59064cb1ef64STejun Heo 			pr_cont_worker_id(worker);
59074cb1ef64STejun Heo 			pr_cont(":%ps", worker->current_func);
59083494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
5909c76feb0dSPaul E. McKenney 				pr_cont_work(false, work, &pcws);
5910c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
59113494fc30STejun Heo 			comma = true;
59123494fc30STejun Heo 		}
59133494fc30STejun Heo 		pr_cont("\n");
59143494fc30STejun Heo 	}
59153494fc30STejun Heo 
59163494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
59173494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
59183494fc30STejun Heo 			has_pending = true;
59193494fc30STejun Heo 			break;
59203494fc30STejun Heo 		}
59213494fc30STejun Heo 	}
59223494fc30STejun Heo 	if (has_pending) {
59233494fc30STejun Heo 		bool comma = false;
59243494fc30STejun Heo 
59253494fc30STejun Heo 		pr_info("    pending:");
59263494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
59273494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
59283494fc30STejun Heo 				continue;
59293494fc30STejun Heo 
5930c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
59313494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
59323494fc30STejun Heo 		}
5933c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
59343494fc30STejun Heo 		pr_cont("\n");
59353494fc30STejun Heo 	}
59363494fc30STejun Heo 
5937f97a4a1aSLai Jiangshan 	if (!list_empty(&pwq->inactive_works)) {
59383494fc30STejun Heo 		bool comma = false;
59393494fc30STejun Heo 
5940f97a4a1aSLai Jiangshan 		pr_info("    inactive:");
5941f97a4a1aSLai Jiangshan 		list_for_each_entry(work, &pwq->inactive_works, entry) {
5942c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
59433494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
59443494fc30STejun Heo 		}
5945c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
59463494fc30STejun Heo 		pr_cont("\n");
59473494fc30STejun Heo 	}
59483494fc30STejun Heo }
59493494fc30STejun Heo 
59503494fc30STejun Heo /**
595155df0933SImran Khan  * show_one_workqueue - dump state of specified workqueue
595255df0933SImran Khan  * @wq: workqueue whose state will be printed
59533494fc30STejun Heo  */
595455df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq)
59553494fc30STejun Heo {
59563494fc30STejun Heo 	struct pool_workqueue *pwq;
59573494fc30STejun Heo 	bool idle = true;
595855df0933SImran Khan 	unsigned long flags;
59593494fc30STejun Heo 
59603494fc30STejun Heo 	for_each_pwq(pwq, wq) {
5961afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
59623494fc30STejun Heo 			idle = false;
59633494fc30STejun Heo 			break;
59643494fc30STejun Heo 		}
59653494fc30STejun Heo 	}
596655df0933SImran Khan 	if (idle) /* Nothing to print for idle workqueue */
596755df0933SImran Khan 		return;
59683494fc30STejun Heo 
59693494fc30STejun Heo 	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
59703494fc30STejun Heo 
59713494fc30STejun Heo 	for_each_pwq(pwq, wq) {
5972a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pwq->pool->lock, flags);
5973afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
597457116ce1SJohan Hovold 			/*
597557116ce1SJohan Hovold 			 * Defer printing to avoid deadlocks in console
597657116ce1SJohan Hovold 			 * drivers that queue work while holding locks
597757116ce1SJohan Hovold 			 * also taken in their write paths.
597857116ce1SJohan Hovold 			 */
597957116ce1SJohan Hovold 			printk_deferred_enter();
59803494fc30STejun Heo 			show_pwq(pwq);
598157116ce1SJohan Hovold 			printk_deferred_exit();
598257116ce1SJohan Hovold 		}
5983a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
598462635ea8SSergey Senozhatsky 		/*
598562635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
598655df0933SImran Khan 		 * sysrq-t -> show_all_workqueues(). Avoid triggering
598762635ea8SSergey Senozhatsky 		 * hard lockup.
598862635ea8SSergey Senozhatsky 		 */
598962635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
59903494fc30STejun Heo 	}
599155df0933SImran Khan 
59923494fc30STejun Heo }
59933494fc30STejun Heo 
599455df0933SImran Khan /**
599555df0933SImran Khan  * show_one_worker_pool - dump state of specified worker pool
599655df0933SImran Khan  * @pool: worker pool whose state will be printed
599755df0933SImran Khan  */
599855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool)
599955df0933SImran Khan {
60003494fc30STejun Heo 	struct worker *worker;
60013494fc30STejun Heo 	bool first = true;
600255df0933SImran Khan 	unsigned long flags;
6003335a42ebSPetr Mladek 	unsigned long hung = 0;
60043494fc30STejun Heo 
6005a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irqsave(&pool->lock, flags);
60063494fc30STejun Heo 	if (pool->nr_workers == pool->nr_idle)
60073494fc30STejun Heo 		goto next_pool;
6008335a42ebSPetr Mladek 
6009335a42ebSPetr Mladek 	/* How long the first pending work is waiting for a worker. */
6010335a42ebSPetr Mladek 	if (!list_empty(&pool->worklist))
6011335a42ebSPetr Mladek 		hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000;
6012335a42ebSPetr Mladek 
601357116ce1SJohan Hovold 	/*
601457116ce1SJohan Hovold 	 * Defer printing to avoid deadlocks in console drivers that
601557116ce1SJohan Hovold 	 * queue work while holding locks also taken in their write
601657116ce1SJohan Hovold 	 * paths.
601757116ce1SJohan Hovold 	 */
601857116ce1SJohan Hovold 	printk_deferred_enter();
60193494fc30STejun Heo 	pr_info("pool %d:", pool->id);
60203494fc30STejun Heo 	pr_cont_pool_info(pool);
6021335a42ebSPetr Mladek 	pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers);
60223494fc30STejun Heo 	if (pool->manager)
60233494fc30STejun Heo 		pr_cont(" manager: %d",
60243494fc30STejun Heo 			task_pid_nr(pool->manager->task));
60253494fc30STejun Heo 	list_for_each_entry(worker, &pool->idle_list, entry) {
60264cb1ef64STejun Heo 		pr_cont(" %s", first ? "idle: " : "");
60274cb1ef64STejun Heo 		pr_cont_worker_id(worker);
60283494fc30STejun Heo 		first = false;
60293494fc30STejun Heo 	}
60303494fc30STejun Heo 	pr_cont("\n");
603157116ce1SJohan Hovold 	printk_deferred_exit();
60323494fc30STejun Heo next_pool:
6033a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irqrestore(&pool->lock, flags);
603462635ea8SSergey Senozhatsky 	/*
603562635ea8SSergey Senozhatsky 	 * We could be printing a lot from atomic context, e.g.
603655df0933SImran Khan 	 * sysrq-t -> show_all_workqueues(). Avoid triggering
603762635ea8SSergey Senozhatsky 	 * hard lockup.
603862635ea8SSergey Senozhatsky 	 */
603962635ea8SSergey Senozhatsky 	touch_nmi_watchdog();
604055df0933SImran Khan 
60413494fc30STejun Heo }
60423494fc30STejun Heo 
604355df0933SImran Khan /**
604455df0933SImran Khan  * show_all_workqueues - dump workqueue state
604555df0933SImran Khan  *
6046704bc669SJungseung Lee  * Called from a sysrq handler and prints out all busy workqueues and pools.
604755df0933SImran Khan  */
604855df0933SImran Khan void show_all_workqueues(void)
604955df0933SImran Khan {
605055df0933SImran Khan 	struct workqueue_struct *wq;
605155df0933SImran Khan 	struct worker_pool *pool;
605255df0933SImran Khan 	int pi;
605355df0933SImran Khan 
605455df0933SImran Khan 	rcu_read_lock();
605555df0933SImran Khan 
605655df0933SImran Khan 	pr_info("Showing busy workqueues and worker pools:\n");
605755df0933SImran Khan 
605855df0933SImran Khan 	list_for_each_entry_rcu(wq, &workqueues, list)
605955df0933SImran Khan 		show_one_workqueue(wq);
606055df0933SImran Khan 
606155df0933SImran Khan 	for_each_pool(pool, pi)
606255df0933SImran Khan 		show_one_worker_pool(pool);
606355df0933SImran Khan 
606424acfb71SThomas Gleixner 	rcu_read_unlock();
60653494fc30STejun Heo }
60663494fc30STejun Heo 
6067704bc669SJungseung Lee /**
6068704bc669SJungseung Lee  * show_freezable_workqueues - dump freezable workqueue state
6069704bc669SJungseung Lee  *
6070704bc669SJungseung Lee  * Called from try_to_freeze_tasks() and prints out all freezable workqueues
6071704bc669SJungseung Lee  * still busy.
6072704bc669SJungseung Lee  */
6073704bc669SJungseung Lee void show_freezable_workqueues(void)
6074704bc669SJungseung Lee {
6075704bc669SJungseung Lee 	struct workqueue_struct *wq;
6076704bc669SJungseung Lee 
6077704bc669SJungseung Lee 	rcu_read_lock();
6078704bc669SJungseung Lee 
6079704bc669SJungseung Lee 	pr_info("Showing freezable workqueues that are still busy:\n");
6080704bc669SJungseung Lee 
6081704bc669SJungseung Lee 	list_for_each_entry_rcu(wq, &workqueues, list) {
6082704bc669SJungseung Lee 		if (!(wq->flags & WQ_FREEZABLE))
6083704bc669SJungseung Lee 			continue;
6084704bc669SJungseung Lee 		show_one_workqueue(wq);
6085704bc669SJungseung Lee 	}
6086704bc669SJungseung Lee 
6087704bc669SJungseung Lee 	rcu_read_unlock();
6088704bc669SJungseung Lee }
6089704bc669SJungseung Lee 
60906b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
60916b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
60926b59808bSTejun Heo {
60936b59808bSTejun Heo 	int off;
60946b59808bSTejun Heo 
60956b59808bSTejun Heo 	/* always show the actual comm */
60966b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
60976b59808bSTejun Heo 	if (off < 0)
60986b59808bSTejun Heo 		return;
60996b59808bSTejun Heo 
6100197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
61016b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
61026b59808bSTejun Heo 
6103197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
6104197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
6105197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
61066b59808bSTejun Heo 
61076b59808bSTejun Heo 		if (pool) {
6108a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock_irq(&pool->lock);
61096b59808bSTejun Heo 			/*
6110197f6accSTejun Heo 			 * ->desc tracks information (wq name or
6111197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
6112197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
61136b59808bSTejun Heo 			 */
61146b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
61156b59808bSTejun Heo 				if (worker->current_work)
61166b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
61176b59808bSTejun Heo 						  worker->desc);
61186b59808bSTejun Heo 				else
61196b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
61206b59808bSTejun Heo 						  worker->desc);
61216b59808bSTejun Heo 			}
6122a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pool->lock);
61236b59808bSTejun Heo 		}
6124197f6accSTejun Heo 	}
61256b59808bSTejun Heo 
61266b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
61276b59808bSTejun Heo }
61286b59808bSTejun Heo 
612966448bc2SMathieu Malaterre #ifdef CONFIG_SMP
613066448bc2SMathieu Malaterre 
6131db7bccf4STejun Heo /*
6132db7bccf4STejun Heo  * CPU hotplug.
6133db7bccf4STejun Heo  *
6134e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
6135112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
6136706026c2STejun Heo  * pool which make migrating pending and scheduled works very
6137e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
613894cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
6139e22bee78STejun Heo  * blocked draining impractical.
6140e22bee78STejun Heo  *
614124647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
6142628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
6143628c78e7STejun Heo  * cpu comes back online.
6144db7bccf4STejun Heo  */
6145db7bccf4STejun Heo 
6146e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
6147db7bccf4STejun Heo {
61484ce62e9eSTejun Heo 	struct worker_pool *pool;
6149db7bccf4STejun Heo 	struct worker *worker;
6150db7bccf4STejun Heo 
6151f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
61521258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
6153a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
6154e22bee78STejun Heo 
6155f2d5a0eeSTejun Heo 		/*
615692f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
615794cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
615811b45b0bSLai Jiangshan 		 * must be on the cpu.  After this, they may become diasporas.
6159b4ac9384SLai Jiangshan 		 * And the preemption disabled section in their sched callbacks
6160b4ac9384SLai Jiangshan 		 * are guaranteed to see WORKER_UNBOUND since the code here
6161b4ac9384SLai Jiangshan 		 * is on the same cpu.
6162f2d5a0eeSTejun Heo 		 */
6163da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
6164403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
6165db7bccf4STejun Heo 
616624647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
6167f2d5a0eeSTejun Heo 
6168e22bee78STejun Heo 		/*
6169989442d7SLai Jiangshan 		 * The handling of nr_running in sched callbacks are disabled
6170989442d7SLai Jiangshan 		 * now.  Zap nr_running.  After this, nr_running stays zero and
6171989442d7SLai Jiangshan 		 * need_more_worker() and keep_working() are always true as
6172989442d7SLai Jiangshan 		 * long as the worklist is not empty.  This pool now behaves as
6173989442d7SLai Jiangshan 		 * an unbound (in terms of concurrency management) pool which
6174eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
6175e22bee78STejun Heo 		 */
6176bc35f7efSLai Jiangshan 		pool->nr_running = 0;
6177eb283428SLai Jiangshan 
6178eb283428SLai Jiangshan 		/*
6179eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
6180eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
6181eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
6182eb283428SLai Jiangshan 		 */
61830219a352STejun Heo 		kick_pool(pool);
6184989442d7SLai Jiangshan 
6185a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
6186989442d7SLai Jiangshan 
6187793777bcSValentin Schneider 		for_each_pool_worker(worker, pool)
6188793777bcSValentin Schneider 			unbind_worker(worker);
6189989442d7SLai Jiangshan 
6190989442d7SLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
6191eb283428SLai Jiangshan 	}
6192db7bccf4STejun Heo }
6193db7bccf4STejun Heo 
6194bd7c089eSTejun Heo /**
6195bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
6196bd7c089eSTejun Heo  * @pool: pool of interest
6197bd7c089eSTejun Heo  *
6198a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
6199bd7c089eSTejun Heo  */
6200bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
6201bd7c089eSTejun Heo {
6202a9ab775bSTejun Heo 	struct worker *worker;
6203bd7c089eSTejun Heo 
62041258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
6205bd7c089eSTejun Heo 
6206bd7c089eSTejun Heo 	/*
6207a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
6208a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
6209402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
6210a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
6211a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
6212bd7c089eSTejun Heo 	 */
6213c63a2e52SValentin Schneider 	for_each_pool_worker(worker, pool) {
6214c63a2e52SValentin Schneider 		kthread_set_per_cpu(worker->task, pool->cpu);
6215c63a2e52SValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
62169546b29eSTejun Heo 						  pool_allowed_cpus(pool)) < 0);
6217c63a2e52SValentin Schneider 	}
6218a9ab775bSTejun Heo 
6219a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
6220f7c17d26SWanpeng Li 
62213de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
6222a9ab775bSTejun Heo 
6223da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
6224a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
6225a9ab775bSTejun Heo 
6226a9ab775bSTejun Heo 		/*
6227a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
6228a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
6229a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
6230a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
6231a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
6232a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
6233a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
6234a9ab775bSTejun Heo 		 *
6235c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
6236a9ab775bSTejun Heo 		 * tested without holding any lock in
62376d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
6238a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
6239a9ab775bSTejun Heo 		 * management operations.
6240bd7c089eSTejun Heo 		 */
6241a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
6242a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
6243a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
6244c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
6245bd7c089eSTejun Heo 	}
6246a9ab775bSTejun Heo 
6247a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
6248bd7c089eSTejun Heo }
6249bd7c089eSTejun Heo 
62507dbc725eSTejun Heo /**
62517dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
62527dbc725eSTejun Heo  * @pool: unbound pool of interest
62537dbc725eSTejun Heo  * @cpu: the CPU which is coming up
62547dbc725eSTejun Heo  *
62557dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
62567dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
62577dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
62587dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
62597dbc725eSTejun Heo  */
62607dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
62617dbc725eSTejun Heo {
62627dbc725eSTejun Heo 	static cpumask_t cpumask;
62637dbc725eSTejun Heo 	struct worker *worker;
62647dbc725eSTejun Heo 
62651258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
62667dbc725eSTejun Heo 
62677dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
62687dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
62697dbc725eSTejun Heo 		return;
62707dbc725eSTejun Heo 
62717dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
62727dbc725eSTejun Heo 
62737dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
6274da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
6275d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
62767dbc725eSTejun Heo }
62777dbc725eSTejun Heo 
62787ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
62791da177e4SLinus Torvalds {
62804ce62e9eSTejun Heo 	struct worker_pool *pool;
62811da177e4SLinus Torvalds 
6282f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
62833ce63377STejun Heo 		if (pool->nr_workers)
62843ce63377STejun Heo 			continue;
6285051e1850SLai Jiangshan 		if (!create_worker(pool))
62867ee681b2SThomas Gleixner 			return -ENOMEM;
62873af24433SOleg Nesterov 	}
62887ee681b2SThomas Gleixner 	return 0;
62897ee681b2SThomas Gleixner }
62901da177e4SLinus Torvalds 
62917ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
62927ee681b2SThomas Gleixner {
62937ee681b2SThomas Gleixner 	struct worker_pool *pool;
62947ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
62957ee681b2SThomas Gleixner 	int pi;
62967ee681b2SThomas Gleixner 
629768e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
62987dbc725eSTejun Heo 
62997dbc725eSTejun Heo 	for_each_pool(pool, pi) {
63004cb1ef64STejun Heo 		/* BH pools aren't affected by hotplug */
63014cb1ef64STejun Heo 		if (pool->flags & POOL_BH)
63024cb1ef64STejun Heo 			continue;
630394cf58bbSTejun Heo 
63044cb1ef64STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
6305f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
630694cf58bbSTejun Heo 			rebind_workers(pool);
6307f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
63087dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
63091258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
631094cf58bbSTejun Heo 	}
63117dbc725eSTejun Heo 
6312fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
63134cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
631484193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
631584193c07STejun Heo 
631684193c07STejun Heo 		if (attrs) {
631784193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
63184cbfd3deSTejun Heo 			int tcpu;
63194cbfd3deSTejun Heo 
632084193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6321fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, true);
63225797b1c1STejun Heo 
63235797b1c1STejun Heo 			mutex_lock(&wq->mutex);
63245797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
63255797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
63264cbfd3deSTejun Heo 		}
63274cbfd3deSTejun Heo 	}
63284c16bd32STejun Heo 
632968e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
63307ee681b2SThomas Gleixner 	return 0;
633165758202STejun Heo }
633265758202STejun Heo 
63337ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
633465758202STejun Heo {
63354c16bd32STejun Heo 	struct workqueue_struct *wq;
63368db25e78STejun Heo 
63374c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
6338e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
6339e8b3f8dbSLai Jiangshan 		return -1;
6340e8b3f8dbSLai Jiangshan 
6341e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
63424c16bd32STejun Heo 
6343fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
63444c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
63454cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
634684193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
634784193c07STejun Heo 
634884193c07STejun Heo 		if (attrs) {
634984193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
63504cbfd3deSTejun Heo 			int tcpu;
63514cbfd3deSTejun Heo 
635284193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6353fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, false);
63545797b1c1STejun Heo 
63555797b1c1STejun Heo 			mutex_lock(&wq->mutex);
63565797b1c1STejun Heo 			wq_update_node_max_active(wq, cpu);
63575797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
63584cbfd3deSTejun Heo 		}
63594cbfd3deSTejun Heo 	}
63604c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
63614c16bd32STejun Heo 
63627ee681b2SThomas Gleixner 	return 0;
636365758202STejun Heo }
636465758202STejun Heo 
63652d3854a3SRusty Russell struct work_for_cpu {
6366ed48ece2STejun Heo 	struct work_struct work;
63672d3854a3SRusty Russell 	long (*fn)(void *);
63682d3854a3SRusty Russell 	void *arg;
63692d3854a3SRusty Russell 	long ret;
63702d3854a3SRusty Russell };
63712d3854a3SRusty Russell 
6372ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
63732d3854a3SRusty Russell {
6374ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
6375ed48ece2STejun Heo 
63762d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
63772d3854a3SRusty Russell }
63782d3854a3SRusty Russell 
63792d3854a3SRusty Russell /**
6380265f3ed0SFrederic Weisbecker  * work_on_cpu_key - run a function in thread context on a particular cpu
63812d3854a3SRusty Russell  * @cpu: the cpu to run on
63822d3854a3SRusty Russell  * @fn: the function to run
63832d3854a3SRusty Russell  * @arg: the function arg
6384265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
63852d3854a3SRusty Russell  *
638631ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
63876b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
6388d185af30SYacine Belkadi  *
6389d185af30SYacine Belkadi  * Return: The value @fn returns.
63902d3854a3SRusty Russell  */
6391265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *),
6392265f3ed0SFrederic Weisbecker 		     void *arg, struct lock_class_key *key)
63932d3854a3SRusty Russell {
6394ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
63952d3854a3SRusty Russell 
6396265f3ed0SFrederic Weisbecker 	INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key);
6397ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
639812997d1aSBjorn Helgaas 	flush_work(&wfc.work);
6399440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
64002d3854a3SRusty Russell 	return wfc.ret;
64012d3854a3SRusty Russell }
6402265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key);
64030e8d6a93SThomas Gleixner 
64040e8d6a93SThomas Gleixner /**
6405265f3ed0SFrederic Weisbecker  * work_on_cpu_safe_key - run a function in thread context on a particular cpu
64060e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
64070e8d6a93SThomas Gleixner  * @fn:  the function to run
64080e8d6a93SThomas Gleixner  * @arg: the function argument
6409265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
64100e8d6a93SThomas Gleixner  *
64110e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
64120e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
64130e8d6a93SThomas Gleixner  *
64140e8d6a93SThomas Gleixner  * Return: The value @fn returns.
64150e8d6a93SThomas Gleixner  */
6416265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *),
6417265f3ed0SFrederic Weisbecker 			  void *arg, struct lock_class_key *key)
64180e8d6a93SThomas Gleixner {
64190e8d6a93SThomas Gleixner 	long ret = -ENODEV;
64200e8d6a93SThomas Gleixner 
6421ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
64220e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
6423265f3ed0SFrederic Weisbecker 		ret = work_on_cpu_key(cpu, fn, arg, key);
6424ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
64250e8d6a93SThomas Gleixner 	return ret;
64260e8d6a93SThomas Gleixner }
6427265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key);
64282d3854a3SRusty Russell #endif /* CONFIG_SMP */
64292d3854a3SRusty Russell 
6430a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
6431e7577c50SRusty Russell 
6432a0a1a5fdSTejun Heo /**
6433a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
6434a0a1a5fdSTejun Heo  *
643558a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
6436f97a4a1aSLai Jiangshan  * workqueues will queue new works to their inactive_works list instead of
6437706026c2STejun Heo  * pool->worklist.
6438a0a1a5fdSTejun Heo  *
6439a0a1a5fdSTejun Heo  * CONTEXT:
6440a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6441a0a1a5fdSTejun Heo  */
6442a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
6443a0a1a5fdSTejun Heo {
644424b8a847STejun Heo 	struct workqueue_struct *wq;
6445a0a1a5fdSTejun Heo 
644668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6447a0a1a5fdSTejun Heo 
64486183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
6449a0a1a5fdSTejun Heo 	workqueue_freezing = true;
6450a0a1a5fdSTejun Heo 
645124b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6452a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6453a045a272STejun Heo 		wq_adjust_max_active(wq);
6454a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
6455a1056305STejun Heo 	}
64565bcab335STejun Heo 
645768e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6458a0a1a5fdSTejun Heo }
6459a0a1a5fdSTejun Heo 
6460a0a1a5fdSTejun Heo /**
646158a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
6462a0a1a5fdSTejun Heo  *
6463a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
6464a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
6465a0a1a5fdSTejun Heo  *
6466a0a1a5fdSTejun Heo  * CONTEXT:
646768e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
6468a0a1a5fdSTejun Heo  *
6469d185af30SYacine Belkadi  * Return:
647058a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
647158a69cb4STejun Heo  * is complete.
6472a0a1a5fdSTejun Heo  */
6473a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
6474a0a1a5fdSTejun Heo {
6475a0a1a5fdSTejun Heo 	bool busy = false;
647624b8a847STejun Heo 	struct workqueue_struct *wq;
647724b8a847STejun Heo 	struct pool_workqueue *pwq;
6478a0a1a5fdSTejun Heo 
647968e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6480a0a1a5fdSTejun Heo 
64816183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
6482a0a1a5fdSTejun Heo 
648324b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
648424b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
648524b8a847STejun Heo 			continue;
6486a0a1a5fdSTejun Heo 		/*
6487a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
6488a0a1a5fdSTejun Heo 		 * to peek without lock.
6489a0a1a5fdSTejun Heo 		 */
649024acfb71SThomas Gleixner 		rcu_read_lock();
649124b8a847STejun Heo 		for_each_pwq(pwq, wq) {
64926183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
6493112202d9STejun Heo 			if (pwq->nr_active) {
6494a0a1a5fdSTejun Heo 				busy = true;
649524acfb71SThomas Gleixner 				rcu_read_unlock();
6496a0a1a5fdSTejun Heo 				goto out_unlock;
6497a0a1a5fdSTejun Heo 			}
6498a0a1a5fdSTejun Heo 		}
649924acfb71SThomas Gleixner 		rcu_read_unlock();
6500a0a1a5fdSTejun Heo 	}
6501a0a1a5fdSTejun Heo out_unlock:
650268e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6503a0a1a5fdSTejun Heo 	return busy;
6504a0a1a5fdSTejun Heo }
6505a0a1a5fdSTejun Heo 
6506a0a1a5fdSTejun Heo /**
6507a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
6508a0a1a5fdSTejun Heo  *
6509a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
6510706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
6511a0a1a5fdSTejun Heo  *
6512a0a1a5fdSTejun Heo  * CONTEXT:
6513a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6514a0a1a5fdSTejun Heo  */
6515a0a1a5fdSTejun Heo void thaw_workqueues(void)
6516a0a1a5fdSTejun Heo {
651724b8a847STejun Heo 	struct workqueue_struct *wq;
6518a0a1a5fdSTejun Heo 
651968e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6520a0a1a5fdSTejun Heo 
6521a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
6522a0a1a5fdSTejun Heo 		goto out_unlock;
6523a0a1a5fdSTejun Heo 
652474b414eaSLai Jiangshan 	workqueue_freezing = false;
652524b8a847STejun Heo 
652624b8a847STejun Heo 	/* restore max_active and repopulate worklist */
652724b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6528a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6529a045a272STejun Heo 		wq_adjust_max_active(wq);
6530a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
653124b8a847STejun Heo 	}
653224b8a847STejun Heo 
6533a0a1a5fdSTejun Heo out_unlock:
653468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6535a0a1a5fdSTejun Heo }
6536a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
6537a0a1a5fdSTejun Heo 
653899c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask)
6539042f7df1SLai Jiangshan {
6540042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
6541042f7df1SLai Jiangshan 	int ret = 0;
6542042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
6543042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
6544042f7df1SLai Jiangshan 
6545042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6546042f7df1SLai Jiangshan 
6547042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
65488eb17dc1SWaiman Long 		if (!(wq->flags & WQ_UNBOUND) || (wq->flags & __WQ_DESTROYING))
6549042f7df1SLai Jiangshan 			continue;
6550042f7df1SLai Jiangshan 
655199c621efSLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask);
655284193c07STejun Heo 		if (IS_ERR(ctx)) {
655384193c07STejun Heo 			ret = PTR_ERR(ctx);
6554042f7df1SLai Jiangshan 			break;
6555042f7df1SLai Jiangshan 		}
6556042f7df1SLai Jiangshan 
6557042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
6558042f7df1SLai Jiangshan 	}
6559042f7df1SLai Jiangshan 
6560042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
6561042f7df1SLai Jiangshan 		if (!ret)
6562042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
6563042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
6564042f7df1SLai Jiangshan 	}
6565042f7df1SLai Jiangshan 
656699c621efSLai Jiangshan 	if (!ret) {
656799c621efSLai Jiangshan 		mutex_lock(&wq_pool_attach_mutex);
656899c621efSLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, unbound_cpumask);
656999c621efSLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
657099c621efSLai Jiangshan 	}
6571042f7df1SLai Jiangshan 	return ret;
6572042f7df1SLai Jiangshan }
6573042f7df1SLai Jiangshan 
6574042f7df1SLai Jiangshan /**
6575fe28f631SWaiman Long  * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask
6576fe28f631SWaiman Long  * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask
6577fe28f631SWaiman Long  *
6578fe28f631SWaiman Long  * This function can be called from cpuset code to provide a set of isolated
6579fe28f631SWaiman Long  * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold
6580fe28f631SWaiman Long  * either cpus_read_lock or cpus_write_lock.
6581fe28f631SWaiman Long  */
6582fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask)
6583fe28f631SWaiman Long {
6584fe28f631SWaiman Long 	cpumask_var_t cpumask;
6585fe28f631SWaiman Long 	int ret = 0;
6586fe28f631SWaiman Long 
6587fe28f631SWaiman Long 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6588fe28f631SWaiman Long 		return -ENOMEM;
6589fe28f631SWaiman Long 
6590fe28f631SWaiman Long 	lockdep_assert_cpus_held();
6591fe28f631SWaiman Long 	mutex_lock(&wq_pool_mutex);
6592fe28f631SWaiman Long 
6593fe28f631SWaiman Long 	/* Save the current isolated cpumask & export it via sysfs */
6594fe28f631SWaiman Long 	cpumask_copy(wq_isolated_cpumask, exclude_cpumask);
6595fe28f631SWaiman Long 
6596fe28f631SWaiman Long 	/*
6597fe28f631SWaiman Long 	 * If the operation fails, it will fall back to
6598fe28f631SWaiman Long 	 * wq_requested_unbound_cpumask which is initially set to
6599fe28f631SWaiman Long 	 * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten
6600fe28f631SWaiman Long 	 * by any subsequent write to workqueue/cpumask sysfs file.
6601fe28f631SWaiman Long 	 */
6602fe28f631SWaiman Long 	if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask))
6603fe28f631SWaiman Long 		cpumask_copy(cpumask, wq_requested_unbound_cpumask);
6604fe28f631SWaiman Long 	if (!cpumask_equal(cpumask, wq_unbound_cpumask))
6605fe28f631SWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
6606fe28f631SWaiman Long 
6607fe28f631SWaiman Long 	mutex_unlock(&wq_pool_mutex);
6608fe28f631SWaiman Long 	free_cpumask_var(cpumask);
6609fe28f631SWaiman Long 	return ret;
6610fe28f631SWaiman Long }
6611fe28f631SWaiman Long 
661263c5484eSTejun Heo static int parse_affn_scope(const char *val)
661363c5484eSTejun Heo {
661463c5484eSTejun Heo 	int i;
661563c5484eSTejun Heo 
661663c5484eSTejun Heo 	for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) {
661763c5484eSTejun Heo 		if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i])))
661863c5484eSTejun Heo 			return i;
661963c5484eSTejun Heo 	}
662063c5484eSTejun Heo 	return -EINVAL;
662163c5484eSTejun Heo }
662263c5484eSTejun Heo 
662363c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp)
662463c5484eSTejun Heo {
6625523a301eSTejun Heo 	struct workqueue_struct *wq;
6626523a301eSTejun Heo 	int affn, cpu;
662763c5484eSTejun Heo 
662863c5484eSTejun Heo 	affn = parse_affn_scope(val);
662963c5484eSTejun Heo 	if (affn < 0)
663063c5484eSTejun Heo 		return affn;
6631523a301eSTejun Heo 	if (affn == WQ_AFFN_DFL)
6632523a301eSTejun Heo 		return -EINVAL;
6633523a301eSTejun Heo 
6634523a301eSTejun Heo 	cpus_read_lock();
6635523a301eSTejun Heo 	mutex_lock(&wq_pool_mutex);
663663c5484eSTejun Heo 
663763c5484eSTejun Heo 	wq_affn_dfl = affn;
6638523a301eSTejun Heo 
6639523a301eSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6640523a301eSTejun Heo 		for_each_online_cpu(cpu) {
6641523a301eSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
6642523a301eSTejun Heo 		}
6643523a301eSTejun Heo 	}
6644523a301eSTejun Heo 
6645523a301eSTejun Heo 	mutex_unlock(&wq_pool_mutex);
6646523a301eSTejun Heo 	cpus_read_unlock();
6647523a301eSTejun Heo 
664863c5484eSTejun Heo 	return 0;
664963c5484eSTejun Heo }
665063c5484eSTejun Heo 
665163c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp)
665263c5484eSTejun Heo {
665363c5484eSTejun Heo 	return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]);
665463c5484eSTejun Heo }
665563c5484eSTejun Heo 
665663c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = {
665763c5484eSTejun Heo 	.set	= wq_affn_dfl_set,
665863c5484eSTejun Heo 	.get	= wq_affn_dfl_get,
665963c5484eSTejun Heo };
666063c5484eSTejun Heo 
666163c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644);
666263c5484eSTejun Heo 
66636ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
66646ba94429SFrederic Weisbecker /*
66656ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
66666ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
66676ba94429SFrederic Weisbecker  * following attributes.
66686ba94429SFrederic Weisbecker  *
66696ba94429SFrederic Weisbecker  *  per_cpu		RO bool	: whether the workqueue is per-cpu or unbound
66706ba94429SFrederic Weisbecker  *  max_active		RW int	: maximum number of in-flight work items
66716ba94429SFrederic Weisbecker  *
66726ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
66736ba94429SFrederic Weisbecker  *
66746ba94429SFrederic Weisbecker  *  nice		RW int	: nice value of the workers
66756ba94429SFrederic Weisbecker  *  cpumask		RW mask	: bitmask of allowed CPUs for the workers
667663c5484eSTejun Heo  *  affinity_scope	RW str  : worker CPU affinity scope (cache, numa, none)
66778639ecebSTejun Heo  *  affinity_strict	RW bool : worker CPU affinity is strict
66786ba94429SFrederic Weisbecker  */
66796ba94429SFrederic Weisbecker struct wq_device {
66806ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
66816ba94429SFrederic Weisbecker 	struct device			dev;
66826ba94429SFrederic Weisbecker };
66836ba94429SFrederic Weisbecker 
66846ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
66856ba94429SFrederic Weisbecker {
66866ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
66876ba94429SFrederic Weisbecker 
66886ba94429SFrederic Weisbecker 	return wq_dev->wq;
66896ba94429SFrederic Weisbecker }
66906ba94429SFrederic Weisbecker 
66916ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
66926ba94429SFrederic Weisbecker 			    char *buf)
66936ba94429SFrederic Weisbecker {
66946ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
66956ba94429SFrederic Weisbecker 
66966ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
66976ba94429SFrederic Weisbecker }
66986ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
66996ba94429SFrederic Weisbecker 
67006ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
67016ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
67026ba94429SFrederic Weisbecker {
67036ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67046ba94429SFrederic Weisbecker 
67056ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
67066ba94429SFrederic Weisbecker }
67076ba94429SFrederic Weisbecker 
67086ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
67096ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
67106ba94429SFrederic Weisbecker 				size_t count)
67116ba94429SFrederic Weisbecker {
67126ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67136ba94429SFrederic Weisbecker 	int val;
67146ba94429SFrederic Weisbecker 
67156ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
67166ba94429SFrederic Weisbecker 		return -EINVAL;
67176ba94429SFrederic Weisbecker 
67186ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
67196ba94429SFrederic Weisbecker 	return count;
67206ba94429SFrederic Weisbecker }
67216ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
67226ba94429SFrederic Weisbecker 
67236ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
67246ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
67256ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
67266ba94429SFrederic Weisbecker 	NULL,
67276ba94429SFrederic Weisbecker };
67286ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
67296ba94429SFrederic Weisbecker 
673049277a5bSWaiman Long static void apply_wqattrs_lock(void)
673149277a5bSWaiman Long {
673249277a5bSWaiman Long 	/* CPUs should stay stable across pwq creations and installations */
673349277a5bSWaiman Long 	cpus_read_lock();
673449277a5bSWaiman Long 	mutex_lock(&wq_pool_mutex);
673549277a5bSWaiman Long }
673649277a5bSWaiman Long 
673749277a5bSWaiman Long static void apply_wqattrs_unlock(void)
673849277a5bSWaiman Long {
673949277a5bSWaiman Long 	mutex_unlock(&wq_pool_mutex);
674049277a5bSWaiman Long 	cpus_read_unlock();
674149277a5bSWaiman Long }
674249277a5bSWaiman Long 
67436ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
67446ba94429SFrederic Weisbecker 			    char *buf)
67456ba94429SFrederic Weisbecker {
67466ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67476ba94429SFrederic Weisbecker 	int written;
67486ba94429SFrederic Weisbecker 
67496ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
67506ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
67516ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
67526ba94429SFrederic Weisbecker 
67536ba94429SFrederic Weisbecker 	return written;
67546ba94429SFrederic Weisbecker }
67556ba94429SFrederic Weisbecker 
67566ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
67576ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
67586ba94429SFrederic Weisbecker {
67596ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
67606ba94429SFrederic Weisbecker 
6761899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6762899a94feSLai Jiangshan 
6763be69d00dSThomas Gleixner 	attrs = alloc_workqueue_attrs();
67646ba94429SFrederic Weisbecker 	if (!attrs)
67656ba94429SFrederic Weisbecker 		return NULL;
67666ba94429SFrederic Weisbecker 
67676ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
67686ba94429SFrederic Weisbecker 	return attrs;
67696ba94429SFrederic Weisbecker }
67706ba94429SFrederic Weisbecker 
67716ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
67726ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
67736ba94429SFrederic Weisbecker {
67746ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67756ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6776d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6777d4d3e257SLai Jiangshan 
6778d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
67796ba94429SFrederic Weisbecker 
67806ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
67816ba94429SFrederic Weisbecker 	if (!attrs)
6782d4d3e257SLai Jiangshan 		goto out_unlock;
67836ba94429SFrederic Weisbecker 
67846ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
67856ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
6786d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
67876ba94429SFrederic Weisbecker 	else
67886ba94429SFrederic Weisbecker 		ret = -EINVAL;
67896ba94429SFrederic Weisbecker 
6790d4d3e257SLai Jiangshan out_unlock:
6791d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
67926ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
67936ba94429SFrederic Weisbecker 	return ret ?: count;
67946ba94429SFrederic Weisbecker }
67956ba94429SFrederic Weisbecker 
67966ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
67976ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
67986ba94429SFrederic Weisbecker {
67996ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68006ba94429SFrederic Weisbecker 	int written;
68016ba94429SFrederic Weisbecker 
68026ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
68036ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
68046ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
68056ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
68066ba94429SFrederic Weisbecker 	return written;
68076ba94429SFrederic Weisbecker }
68086ba94429SFrederic Weisbecker 
68096ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
68106ba94429SFrederic Weisbecker 				struct device_attribute *attr,
68116ba94429SFrederic Weisbecker 				const char *buf, size_t count)
68126ba94429SFrederic Weisbecker {
68136ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68146ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6815d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6816d4d3e257SLai Jiangshan 
6817d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
68186ba94429SFrederic Weisbecker 
68196ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
68206ba94429SFrederic Weisbecker 	if (!attrs)
6821d4d3e257SLai Jiangshan 		goto out_unlock;
68226ba94429SFrederic Weisbecker 
68236ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
68246ba94429SFrederic Weisbecker 	if (!ret)
6825d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
68266ba94429SFrederic Weisbecker 
6827d4d3e257SLai Jiangshan out_unlock:
6828d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
68296ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
68306ba94429SFrederic Weisbecker 	return ret ?: count;
68316ba94429SFrederic Weisbecker }
68326ba94429SFrederic Weisbecker 
683363c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev,
683463c5484eSTejun Heo 				  struct device_attribute *attr, char *buf)
683563c5484eSTejun Heo {
683663c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
683763c5484eSTejun Heo 	int written;
683863c5484eSTejun Heo 
683963c5484eSTejun Heo 	mutex_lock(&wq->mutex);
6840523a301eSTejun Heo 	if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL)
6841523a301eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n",
6842523a301eSTejun Heo 				    wq_affn_names[WQ_AFFN_DFL],
6843523a301eSTejun Heo 				    wq_affn_names[wq_affn_dfl]);
6844523a301eSTejun Heo 	else
684563c5484eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s\n",
684663c5484eSTejun Heo 				    wq_affn_names[wq->unbound_attrs->affn_scope]);
684763c5484eSTejun Heo 	mutex_unlock(&wq->mutex);
684863c5484eSTejun Heo 
684963c5484eSTejun Heo 	return written;
685063c5484eSTejun Heo }
685163c5484eSTejun Heo 
685263c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev,
685363c5484eSTejun Heo 				   struct device_attribute *attr,
685463c5484eSTejun Heo 				   const char *buf, size_t count)
685563c5484eSTejun Heo {
685663c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
685763c5484eSTejun Heo 	struct workqueue_attrs *attrs;
685863c5484eSTejun Heo 	int affn, ret = -ENOMEM;
685963c5484eSTejun Heo 
686063c5484eSTejun Heo 	affn = parse_affn_scope(buf);
686163c5484eSTejun Heo 	if (affn < 0)
686263c5484eSTejun Heo 		return affn;
686363c5484eSTejun Heo 
686463c5484eSTejun Heo 	apply_wqattrs_lock();
686563c5484eSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
686663c5484eSTejun Heo 	if (attrs) {
686763c5484eSTejun Heo 		attrs->affn_scope = affn;
686863c5484eSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
686963c5484eSTejun Heo 	}
687063c5484eSTejun Heo 	apply_wqattrs_unlock();
687163c5484eSTejun Heo 	free_workqueue_attrs(attrs);
687263c5484eSTejun Heo 	return ret ?: count;
687363c5484eSTejun Heo }
687463c5484eSTejun Heo 
68758639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev,
68768639ecebSTejun Heo 				       struct device_attribute *attr, char *buf)
68778639ecebSTejun Heo {
68788639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
68798639ecebSTejun Heo 
68808639ecebSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n",
68818639ecebSTejun Heo 			 wq->unbound_attrs->affn_strict);
68828639ecebSTejun Heo }
68838639ecebSTejun Heo 
68848639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev,
68858639ecebSTejun Heo 					struct device_attribute *attr,
68868639ecebSTejun Heo 					const char *buf, size_t count)
68878639ecebSTejun Heo {
68888639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
68898639ecebSTejun Heo 	struct workqueue_attrs *attrs;
68908639ecebSTejun Heo 	int v, ret = -ENOMEM;
68918639ecebSTejun Heo 
68928639ecebSTejun Heo 	if (sscanf(buf, "%d", &v) != 1)
68938639ecebSTejun Heo 		return -EINVAL;
68948639ecebSTejun Heo 
68958639ecebSTejun Heo 	apply_wqattrs_lock();
68968639ecebSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
68978639ecebSTejun Heo 	if (attrs) {
68988639ecebSTejun Heo 		attrs->affn_strict = (bool)v;
68998639ecebSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
69008639ecebSTejun Heo 	}
69018639ecebSTejun Heo 	apply_wqattrs_unlock();
69028639ecebSTejun Heo 	free_workqueue_attrs(attrs);
69038639ecebSTejun Heo 	return ret ?: count;
69048639ecebSTejun Heo }
69058639ecebSTejun Heo 
69066ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
69076ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
69086ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
690963c5484eSTejun Heo 	__ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store),
69108639ecebSTejun Heo 	__ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store),
69116ba94429SFrederic Weisbecker 	__ATTR_NULL,
69126ba94429SFrederic Weisbecker };
69136ba94429SFrederic Weisbecker 
69144f19b8e0STejun Heo static struct bus_type wq_subsys = {
69156ba94429SFrederic Weisbecker 	.name				= "workqueue",
69166ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
69176ba94429SFrederic Weisbecker };
69186ba94429SFrederic Weisbecker 
691949277a5bSWaiman Long /**
692049277a5bSWaiman Long  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
692149277a5bSWaiman Long  *  @cpumask: the cpumask to set
692249277a5bSWaiman Long  *
692349277a5bSWaiman Long  *  The low-level workqueues cpumask is a global cpumask that limits
692449277a5bSWaiman Long  *  the affinity of all unbound workqueues.  This function check the @cpumask
692549277a5bSWaiman Long  *  and apply it to all unbound workqueues and updates all pwqs of them.
692649277a5bSWaiman Long  *
692749277a5bSWaiman Long  *  Return:	0	- Success
692849277a5bSWaiman Long  *		-EINVAL	- Invalid @cpumask
692949277a5bSWaiman Long  *		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
693049277a5bSWaiman Long  */
693149277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
693249277a5bSWaiman Long {
693349277a5bSWaiman Long 	int ret = -EINVAL;
693449277a5bSWaiman Long 
693549277a5bSWaiman Long 	/*
693649277a5bSWaiman Long 	 * Not excluding isolated cpus on purpose.
693749277a5bSWaiman Long 	 * If the user wishes to include them, we allow that.
693849277a5bSWaiman Long 	 */
693949277a5bSWaiman Long 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
694049277a5bSWaiman Long 	if (!cpumask_empty(cpumask)) {
694149277a5bSWaiman Long 		apply_wqattrs_lock();
694249277a5bSWaiman Long 		cpumask_copy(wq_requested_unbound_cpumask, cpumask);
694349277a5bSWaiman Long 		if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
694449277a5bSWaiman Long 			ret = 0;
694549277a5bSWaiman Long 			goto out_unlock;
694649277a5bSWaiman Long 		}
694749277a5bSWaiman Long 
694849277a5bSWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
694949277a5bSWaiman Long 
695049277a5bSWaiman Long out_unlock:
695149277a5bSWaiman Long 		apply_wqattrs_unlock();
695249277a5bSWaiman Long 	}
695349277a5bSWaiman Long 
695449277a5bSWaiman Long 	return ret;
695549277a5bSWaiman Long }
695649277a5bSWaiman Long 
6957fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev,
6958fe28f631SWaiman Long 		struct device_attribute *attr, char *buf, cpumask_var_t mask)
6959b05a7928SFrederic Weisbecker {
6960b05a7928SFrederic Weisbecker 	int written;
6961b05a7928SFrederic Weisbecker 
6962042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6963fe28f631SWaiman Long 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
6964042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6965b05a7928SFrederic Weisbecker 
6966b05a7928SFrederic Weisbecker 	return written;
6967b05a7928SFrederic Weisbecker }
6968b05a7928SFrederic Weisbecker 
6969fe28f631SWaiman Long static ssize_t wq_unbound_cpumask_show(struct device *dev,
6970fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
6971fe28f631SWaiman Long {
6972fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask);
6973fe28f631SWaiman Long }
6974fe28f631SWaiman Long 
6975fe28f631SWaiman Long static ssize_t wq_requested_cpumask_show(struct device *dev,
6976fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
6977fe28f631SWaiman Long {
6978fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask);
6979fe28f631SWaiman Long }
6980fe28f631SWaiman Long 
6981fe28f631SWaiman Long static ssize_t wq_isolated_cpumask_show(struct device *dev,
6982fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
6983fe28f631SWaiman Long {
6984fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask);
6985fe28f631SWaiman Long }
6986fe28f631SWaiman Long 
6987042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
6988042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
6989042f7df1SLai Jiangshan {
6990042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
6991042f7df1SLai Jiangshan 	int ret;
6992042f7df1SLai Jiangshan 
6993042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6994042f7df1SLai Jiangshan 		return -ENOMEM;
6995042f7df1SLai Jiangshan 
6996042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
6997042f7df1SLai Jiangshan 	if (!ret)
6998042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
6999042f7df1SLai Jiangshan 
7000042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
7001042f7df1SLai Jiangshan 	return ret ? ret : count;
7002042f7df1SLai Jiangshan }
7003042f7df1SLai Jiangshan 
7004fe28f631SWaiman Long static struct device_attribute wq_sysfs_cpumask_attrs[] = {
7005042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
7006fe28f631SWaiman Long 	       wq_unbound_cpumask_store),
7007fe28f631SWaiman Long 	__ATTR(cpumask_requested, 0444, wq_requested_cpumask_show, NULL),
7008fe28f631SWaiman Long 	__ATTR(cpumask_isolated, 0444, wq_isolated_cpumask_show, NULL),
7009fe28f631SWaiman Long 	__ATTR_NULL,
7010fe28f631SWaiman Long };
7011b05a7928SFrederic Weisbecker 
70126ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
70136ba94429SFrederic Weisbecker {
7014686f6697SGreg Kroah-Hartman 	struct device *dev_root;
7015b05a7928SFrederic Weisbecker 	int err;
7016b05a7928SFrederic Weisbecker 
7017b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
7018b05a7928SFrederic Weisbecker 	if (err)
7019b05a7928SFrederic Weisbecker 		return err;
7020b05a7928SFrederic Weisbecker 
7021686f6697SGreg Kroah-Hartman 	dev_root = bus_get_dev_root(&wq_subsys);
7022686f6697SGreg Kroah-Hartman 	if (dev_root) {
7023fe28f631SWaiman Long 		struct device_attribute *attr;
7024fe28f631SWaiman Long 
7025fe28f631SWaiman Long 		for (attr = wq_sysfs_cpumask_attrs; attr->attr.name; attr++) {
7026fe28f631SWaiman Long 			err = device_create_file(dev_root, attr);
7027fe28f631SWaiman Long 			if (err)
7028fe28f631SWaiman Long 				break;
7029fe28f631SWaiman Long 		}
7030686f6697SGreg Kroah-Hartman 		put_device(dev_root);
7031686f6697SGreg Kroah-Hartman 	}
7032686f6697SGreg Kroah-Hartman 	return err;
70336ba94429SFrederic Weisbecker }
70346ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
70356ba94429SFrederic Weisbecker 
70366ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
70376ba94429SFrederic Weisbecker {
70386ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
70396ba94429SFrederic Weisbecker 
70406ba94429SFrederic Weisbecker 	kfree(wq_dev);
70416ba94429SFrederic Weisbecker }
70426ba94429SFrederic Weisbecker 
70436ba94429SFrederic Weisbecker /**
70446ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
70456ba94429SFrederic Weisbecker  * @wq: the workqueue to register
70466ba94429SFrederic Weisbecker  *
70476ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
70486ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
70496ba94429SFrederic Weisbecker  * which is the preferred method.
70506ba94429SFrederic Weisbecker  *
70516ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
70526ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
70536ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
70546ba94429SFrederic Weisbecker  * attributes.
70556ba94429SFrederic Weisbecker  *
70566ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
70576ba94429SFrederic Weisbecker  */
70586ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
70596ba94429SFrederic Weisbecker {
70606ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
70616ba94429SFrederic Weisbecker 	int ret;
70626ba94429SFrederic Weisbecker 
70636ba94429SFrederic Weisbecker 	/*
70644c065dbcSWaiman Long 	 * Adjusting max_active breaks ordering guarantee.  Disallow exposing
70654c065dbcSWaiman Long 	 * ordered workqueues.
70666ba94429SFrederic Weisbecker 	 */
70673bc1e711STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
70686ba94429SFrederic Weisbecker 		return -EINVAL;
70696ba94429SFrederic Weisbecker 
70706ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
70716ba94429SFrederic Weisbecker 	if (!wq_dev)
70726ba94429SFrederic Weisbecker 		return -ENOMEM;
70736ba94429SFrederic Weisbecker 
70746ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
70756ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
70766ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
707723217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
70786ba94429SFrederic Weisbecker 
70796ba94429SFrederic Weisbecker 	/*
70806ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
70816ba94429SFrederic Weisbecker 	 * everything is ready.
70826ba94429SFrederic Weisbecker 	 */
70836ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
70846ba94429SFrederic Weisbecker 
70856ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
70866ba94429SFrederic Weisbecker 	if (ret) {
7087537f4146SArvind Yadav 		put_device(&wq_dev->dev);
70886ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
70896ba94429SFrederic Weisbecker 		return ret;
70906ba94429SFrederic Weisbecker 	}
70916ba94429SFrederic Weisbecker 
70926ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
70936ba94429SFrederic Weisbecker 		struct device_attribute *attr;
70946ba94429SFrederic Weisbecker 
70956ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
70966ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
70976ba94429SFrederic Weisbecker 			if (ret) {
70986ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
70996ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
71006ba94429SFrederic Weisbecker 				return ret;
71016ba94429SFrederic Weisbecker 			}
71026ba94429SFrederic Weisbecker 		}
71036ba94429SFrederic Weisbecker 	}
71046ba94429SFrederic Weisbecker 
71056ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
71066ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
71076ba94429SFrederic Weisbecker 	return 0;
71086ba94429SFrederic Weisbecker }
71096ba94429SFrederic Weisbecker 
71106ba94429SFrederic Weisbecker /**
71116ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
71126ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
71136ba94429SFrederic Weisbecker  *
71146ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
71156ba94429SFrederic Weisbecker  */
71166ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
71176ba94429SFrederic Weisbecker {
71186ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
71196ba94429SFrederic Weisbecker 
71206ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
71216ba94429SFrederic Weisbecker 		return;
71226ba94429SFrederic Weisbecker 
71236ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
71246ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
71256ba94429SFrederic Weisbecker }
71266ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
71276ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
71286ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
71296ba94429SFrederic Weisbecker 
713082607adcSTejun Heo /*
713182607adcSTejun Heo  * Workqueue watchdog.
713282607adcSTejun Heo  *
713382607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
713482607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
713582607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
713682607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
713782607adcSTejun Heo  * largely opaque.
713882607adcSTejun Heo  *
713982607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
714082607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
714182607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
714282607adcSTejun Heo  *
714382607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
714482607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
714582607adcSTejun Heo  * corresponding sysfs parameter file.
714682607adcSTejun Heo  */
714782607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
714882607adcSTejun Heo 
714982607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
71505cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
715182607adcSTejun Heo 
715282607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
715382607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
715482607adcSTejun Heo 
7155cd2440d6SPetr Mladek /*
7156cd2440d6SPetr Mladek  * Show workers that might prevent the processing of pending work items.
7157cd2440d6SPetr Mladek  * The only candidates are CPU-bound workers in the running state.
7158cd2440d6SPetr Mladek  * Pending work items should be handled by another idle worker
7159cd2440d6SPetr Mladek  * in all other situations.
7160cd2440d6SPetr Mladek  */
7161cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool)
7162cd2440d6SPetr Mladek {
7163cd2440d6SPetr Mladek 	struct worker *worker;
7164cd2440d6SPetr Mladek 	unsigned long flags;
7165cd2440d6SPetr Mladek 	int bkt;
7166cd2440d6SPetr Mladek 
7167cd2440d6SPetr Mladek 	raw_spin_lock_irqsave(&pool->lock, flags);
7168cd2440d6SPetr Mladek 
7169cd2440d6SPetr Mladek 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
7170cd2440d6SPetr Mladek 		if (task_is_running(worker->task)) {
7171cd2440d6SPetr Mladek 			/*
7172cd2440d6SPetr Mladek 			 * Defer printing to avoid deadlocks in console
7173cd2440d6SPetr Mladek 			 * drivers that queue work while holding locks
7174cd2440d6SPetr Mladek 			 * also taken in their write paths.
7175cd2440d6SPetr Mladek 			 */
7176cd2440d6SPetr Mladek 			printk_deferred_enter();
7177cd2440d6SPetr Mladek 
7178cd2440d6SPetr Mladek 			pr_info("pool %d:\n", pool->id);
7179cd2440d6SPetr Mladek 			sched_show_task(worker->task);
7180cd2440d6SPetr Mladek 
7181cd2440d6SPetr Mladek 			printk_deferred_exit();
7182cd2440d6SPetr Mladek 		}
7183cd2440d6SPetr Mladek 	}
7184cd2440d6SPetr Mladek 
7185cd2440d6SPetr Mladek 	raw_spin_unlock_irqrestore(&pool->lock, flags);
7186cd2440d6SPetr Mladek }
7187cd2440d6SPetr Mladek 
7188cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void)
7189cd2440d6SPetr Mladek {
7190cd2440d6SPetr Mladek 	struct worker_pool *pool;
7191cd2440d6SPetr Mladek 	int pi;
7192cd2440d6SPetr Mladek 
7193cd2440d6SPetr Mladek 	pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n");
7194cd2440d6SPetr Mladek 
7195cd2440d6SPetr Mladek 	rcu_read_lock();
7196cd2440d6SPetr Mladek 
7197cd2440d6SPetr Mladek 	for_each_pool(pool, pi) {
7198cd2440d6SPetr Mladek 		if (pool->cpu_stall)
7199cd2440d6SPetr Mladek 			show_cpu_pool_hog(pool);
7200cd2440d6SPetr Mladek 
7201cd2440d6SPetr Mladek 	}
7202cd2440d6SPetr Mladek 
7203cd2440d6SPetr Mladek 	rcu_read_unlock();
7204cd2440d6SPetr Mladek }
7205cd2440d6SPetr Mladek 
720682607adcSTejun Heo static void wq_watchdog_reset_touched(void)
720782607adcSTejun Heo {
720882607adcSTejun Heo 	int cpu;
720982607adcSTejun Heo 
721082607adcSTejun Heo 	wq_watchdog_touched = jiffies;
721182607adcSTejun Heo 	for_each_possible_cpu(cpu)
721282607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
721382607adcSTejun Heo }
721482607adcSTejun Heo 
72155cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
721682607adcSTejun Heo {
721782607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
721882607adcSTejun Heo 	bool lockup_detected = false;
7219cd2440d6SPetr Mladek 	bool cpu_pool_stall = false;
7220940d71c6SSergey Senozhatsky 	unsigned long now = jiffies;
722182607adcSTejun Heo 	struct worker_pool *pool;
722282607adcSTejun Heo 	int pi;
722382607adcSTejun Heo 
722482607adcSTejun Heo 	if (!thresh)
722582607adcSTejun Heo 		return;
722682607adcSTejun Heo 
722782607adcSTejun Heo 	rcu_read_lock();
722882607adcSTejun Heo 
722982607adcSTejun Heo 	for_each_pool(pool, pi) {
723082607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
723182607adcSTejun Heo 
7232cd2440d6SPetr Mladek 		pool->cpu_stall = false;
723382607adcSTejun Heo 		if (list_empty(&pool->worklist))
723482607adcSTejun Heo 			continue;
723582607adcSTejun Heo 
7236940d71c6SSergey Senozhatsky 		/*
7237940d71c6SSergey Senozhatsky 		 * If a virtual machine is stopped by the host it can look to
7238940d71c6SSergey Senozhatsky 		 * the watchdog like a stall.
7239940d71c6SSergey Senozhatsky 		 */
7240940d71c6SSergey Senozhatsky 		kvm_check_and_clear_guest_paused();
7241940d71c6SSergey Senozhatsky 
724282607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
724389e28ce6SWang Qing 		if (pool->cpu >= 0)
724489e28ce6SWang Qing 			touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
724589e28ce6SWang Qing 		else
724682607adcSTejun Heo 			touched = READ_ONCE(wq_watchdog_touched);
724789e28ce6SWang Qing 		pool_ts = READ_ONCE(pool->watchdog_ts);
724882607adcSTejun Heo 
724982607adcSTejun Heo 		if (time_after(pool_ts, touched))
725082607adcSTejun Heo 			ts = pool_ts;
725182607adcSTejun Heo 		else
725282607adcSTejun Heo 			ts = touched;
725382607adcSTejun Heo 
725482607adcSTejun Heo 		/* did we stall? */
7255940d71c6SSergey Senozhatsky 		if (time_after(now, ts + thresh)) {
725682607adcSTejun Heo 			lockup_detected = true;
72574cb1ef64STejun Heo 			if (pool->cpu >= 0 && !(pool->flags & POOL_BH)) {
7258cd2440d6SPetr Mladek 				pool->cpu_stall = true;
7259cd2440d6SPetr Mladek 				cpu_pool_stall = true;
7260cd2440d6SPetr Mladek 			}
726182607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
726282607adcSTejun Heo 			pr_cont_pool_info(pool);
726382607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
7264940d71c6SSergey Senozhatsky 				jiffies_to_msecs(now - pool_ts) / 1000);
726582607adcSTejun Heo 		}
7266cd2440d6SPetr Mladek 
7267cd2440d6SPetr Mladek 
726882607adcSTejun Heo 	}
726982607adcSTejun Heo 
727082607adcSTejun Heo 	rcu_read_unlock();
727182607adcSTejun Heo 
727282607adcSTejun Heo 	if (lockup_detected)
727355df0933SImran Khan 		show_all_workqueues();
727482607adcSTejun Heo 
7275cd2440d6SPetr Mladek 	if (cpu_pool_stall)
7276cd2440d6SPetr Mladek 		show_cpu_pools_hogs();
7277cd2440d6SPetr Mladek 
727882607adcSTejun Heo 	wq_watchdog_reset_touched();
727982607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
728082607adcSTejun Heo }
728182607adcSTejun Heo 
7282cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
728382607adcSTejun Heo {
728482607adcSTejun Heo 	if (cpu >= 0)
728582607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
728689e28ce6SWang Qing 
728782607adcSTejun Heo 	wq_watchdog_touched = jiffies;
728882607adcSTejun Heo }
728982607adcSTejun Heo 
729082607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
729182607adcSTejun Heo {
729282607adcSTejun Heo 	wq_watchdog_thresh = 0;
729382607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
729482607adcSTejun Heo 
729582607adcSTejun Heo 	if (thresh) {
729682607adcSTejun Heo 		wq_watchdog_thresh = thresh;
729782607adcSTejun Heo 		wq_watchdog_reset_touched();
729882607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
729982607adcSTejun Heo 	}
730082607adcSTejun Heo }
730182607adcSTejun Heo 
730282607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
730382607adcSTejun Heo 					const struct kernel_param *kp)
730482607adcSTejun Heo {
730582607adcSTejun Heo 	unsigned long thresh;
730682607adcSTejun Heo 	int ret;
730782607adcSTejun Heo 
730882607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
730982607adcSTejun Heo 	if (ret)
731082607adcSTejun Heo 		return ret;
731182607adcSTejun Heo 
731282607adcSTejun Heo 	if (system_wq)
731382607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
731482607adcSTejun Heo 	else
731582607adcSTejun Heo 		wq_watchdog_thresh = thresh;
731682607adcSTejun Heo 
731782607adcSTejun Heo 	return 0;
731882607adcSTejun Heo }
731982607adcSTejun Heo 
732082607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
732182607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
732282607adcSTejun Heo 	.get	= param_get_ulong,
732382607adcSTejun Heo };
732482607adcSTejun Heo 
732582607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
732682607adcSTejun Heo 		0644);
732782607adcSTejun Heo 
732882607adcSTejun Heo static void wq_watchdog_init(void)
732982607adcSTejun Heo {
73305cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
733182607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
733282607adcSTejun Heo }
733382607adcSTejun Heo 
733482607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
733582607adcSTejun Heo 
733682607adcSTejun Heo static inline void wq_watchdog_init(void) { }
733782607adcSTejun Heo 
733882607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
733982607adcSTejun Heo 
73404a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask)
73414a6c5607STejun Heo {
73424a6c5607STejun Heo 	if (!cpumask_intersects(wq_unbound_cpumask, mask)) {
73434a6c5607STejun Heo 		pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n",
73444a6c5607STejun Heo 			cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask));
73454a6c5607STejun Heo 		return;
73464a6c5607STejun Heo 	}
73474a6c5607STejun Heo 
73484a6c5607STejun Heo 	cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask);
73494a6c5607STejun Heo }
73504a6c5607STejun Heo 
73512fcdb1b4STejun Heo static void __init init_cpu_worker_pool(struct worker_pool *pool, int cpu, int nice)
73522fcdb1b4STejun Heo {
73532fcdb1b4STejun Heo 	BUG_ON(init_worker_pool(pool));
73542fcdb1b4STejun Heo 	pool->cpu = cpu;
73552fcdb1b4STejun Heo 	cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
73562fcdb1b4STejun Heo 	cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu));
73572fcdb1b4STejun Heo 	pool->attrs->nice = nice;
73582fcdb1b4STejun Heo 	pool->attrs->affn_strict = true;
73592fcdb1b4STejun Heo 	pool->node = cpu_to_node(cpu);
73602fcdb1b4STejun Heo 
73612fcdb1b4STejun Heo 	/* alloc pool ID */
73622fcdb1b4STejun Heo 	mutex_lock(&wq_pool_mutex);
73632fcdb1b4STejun Heo 	BUG_ON(worker_pool_assign_id(pool));
73642fcdb1b4STejun Heo 	mutex_unlock(&wq_pool_mutex);
73652fcdb1b4STejun Heo }
73662fcdb1b4STejun Heo 
73673347fa09STejun Heo /**
73683347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
73693347fa09STejun Heo  *
73702930155bSTejun Heo  * This is the first step of three-staged workqueue subsystem initialization and
73712930155bSTejun Heo  * invoked as soon as the bare basics - memory allocation, cpumasks and idr are
73722930155bSTejun Heo  * up. It sets up all the data structures and system workqueues and allows early
73732930155bSTejun Heo  * boot code to create workqueues and queue/cancel work items. Actual work item
73742930155bSTejun Heo  * execution starts only after kthreads can be created and scheduled right
73752930155bSTejun Heo  * before early initcalls.
73763347fa09STejun Heo  */
73772333e829SYu Chen void __init workqueue_init_early(void)
73781da177e4SLinus Torvalds {
737984193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM];
73807a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
73817a4e344cSTejun Heo 	int i, cpu;
7382c34056a3STejun Heo 
738310cdb157SLai Jiangshan 	BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
7384e904e6c2STejun Heo 
7385b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
7386fe28f631SWaiman Long 	BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL));
7387fe28f631SWaiman Long 	BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL));
7388b05a7928SFrederic Weisbecker 
73894a6c5607STejun Heo 	cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
73904a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ));
73914a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN));
7392ace3c549Stiozhang 	if (!cpumask_empty(&wq_cmdline_cpumask))
73934a6c5607STejun Heo 		restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask);
7394ace3c549Stiozhang 
7395fe28f631SWaiman Long 	cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask);
73968b03ae3cSTejun Heo 
73978b03ae3cSTejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
7398e22bee78STejun Heo 
73992930155bSTejun Heo 	wq_update_pod_attrs_buf = alloc_workqueue_attrs();
74002930155bSTejun Heo 	BUG_ON(!wq_update_pod_attrs_buf);
74012930155bSTejun Heo 
74027bd20b6bSMarcelo Tosatti 	/*
74037bd20b6bSMarcelo Tosatti 	 * If nohz_full is enabled, set power efficient workqueue as unbound.
74047bd20b6bSMarcelo Tosatti 	 * This allows workqueue items to be moved to HK CPUs.
74057bd20b6bSMarcelo Tosatti 	 */
74067bd20b6bSMarcelo Tosatti 	if (housekeeping_enabled(HK_TYPE_TICK))
74077bd20b6bSMarcelo Tosatti 		wq_power_efficient = true;
74087bd20b6bSMarcelo Tosatti 
740984193c07STejun Heo 	/* initialize WQ_AFFN_SYSTEM pods */
741084193c07STejun Heo 	pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
741184193c07STejun Heo 	pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL);
741284193c07STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
741384193c07STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod);
741484193c07STejun Heo 
741584193c07STejun Heo 	BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE));
741684193c07STejun Heo 
741784193c07STejun Heo 	pt->nr_pods = 1;
741884193c07STejun Heo 	cpumask_copy(pt->pod_cpus[0], cpu_possible_mask);
741984193c07STejun Heo 	pt->pod_node[0] = NUMA_NO_NODE;
742084193c07STejun Heo 	pt->cpu_pod[0] = 0;
742184193c07STejun Heo 
74224cb1ef64STejun Heo 	/* initialize BH and CPU pools */
74231da177e4SLinus Torvalds 	for_each_possible_cpu(cpu) {
74241da177e4SLinus Torvalds 		struct worker_pool *pool;
74251da177e4SLinus Torvalds 
74261da177e4SLinus Torvalds 		i = 0;
74274cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu) {
74284cb1ef64STejun Heo 			init_cpu_worker_pool(pool, cpu, std_nice[i++]);
74294cb1ef64STejun Heo 			pool->flags |= POOL_BH;
74304cb1ef64STejun Heo 		}
74314cb1ef64STejun Heo 
74324cb1ef64STejun Heo 		i = 0;
74332fcdb1b4STejun Heo 		for_each_cpu_worker_pool(pool, cpu)
74342fcdb1b4STejun Heo 			init_cpu_worker_pool(pool, cpu, std_nice[i++]);
74351da177e4SLinus Torvalds 	}
74361da177e4SLinus Torvalds 
74378a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
743829c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
743929c91e99STejun Heo 		struct workqueue_attrs *attrs;
744029c91e99STejun Heo 
7441be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
744229c91e99STejun Heo 		attrs->nice = std_nice[i];
744329c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
74448a2b7538STejun Heo 
74458a2b7538STejun Heo 		/*
74468a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
74478a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
74488a2b7538STejun Heo 		 */
7449be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
74508a2b7538STejun Heo 		attrs->nice = std_nice[i];
7451af73f5c9STejun Heo 		attrs->ordered = true;
74528a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
745329c91e99STejun Heo 	}
745429c91e99STejun Heo 
7455d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
74561aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
7457d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
7458f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
7459636b927eSTejun Heo 					    WQ_MAX_ACTIVE);
746024d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
746124d51addSTejun Heo 					      WQ_FREEZABLE, 0);
74620668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
74630668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
74648318d6a6SAudra Mitchell 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient",
74650668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
74660668106cSViresh Kumar 					      0);
74674cb1ef64STejun Heo 	system_bh_wq = alloc_workqueue("events_bh", WQ_BH, 0);
74684cb1ef64STejun Heo 	system_bh_highpri_wq = alloc_workqueue("events_bh_highpri",
74694cb1ef64STejun Heo 					       WQ_BH | WQ_HIGHPRI, 0);
74701aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
74710668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
74720668106cSViresh Kumar 	       !system_power_efficient_wq ||
74734cb1ef64STejun Heo 	       !system_freezable_power_efficient_wq ||
74744cb1ef64STejun Heo 	       !system_bh_wq || !system_bh_highpri_wq);
74753347fa09STejun Heo }
74763347fa09STejun Heo 
7477aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void)
7478aa6fde93STejun Heo {
7479aa6fde93STejun Heo 	unsigned long thresh;
7480aa6fde93STejun Heo 	unsigned long bogo;
7481aa6fde93STejun Heo 
7482dd64c873SZqiang 	pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release");
7483dd64c873SZqiang 	BUG_ON(IS_ERR(pwq_release_worker));
7484dd64c873SZqiang 
7485aa6fde93STejun Heo 	/* if the user set it to a specific value, keep it */
7486aa6fde93STejun Heo 	if (wq_cpu_intensive_thresh_us != ULONG_MAX)
7487aa6fde93STejun Heo 		return;
7488aa6fde93STejun Heo 
7489aa6fde93STejun Heo 	/*
7490aa6fde93STejun Heo 	 * The default of 10ms is derived from the fact that most modern (as of
7491aa6fde93STejun Heo 	 * 2023) processors can do a lot in 10ms and that it's just below what
7492aa6fde93STejun Heo 	 * most consider human-perceivable. However, the kernel also runs on a
7493aa6fde93STejun Heo 	 * lot slower CPUs including microcontrollers where the threshold is way
7494aa6fde93STejun Heo 	 * too low.
7495aa6fde93STejun Heo 	 *
7496aa6fde93STejun Heo 	 * Let's scale up the threshold upto 1 second if BogoMips is below 4000.
7497aa6fde93STejun Heo 	 * This is by no means accurate but it doesn't have to be. The mechanism
7498aa6fde93STejun Heo 	 * is still useful even when the threshold is fully scaled up. Also, as
7499aa6fde93STejun Heo 	 * the reports would usually be applicable to everyone, some machines
7500aa6fde93STejun Heo 	 * operating on longer thresholds won't significantly diminish their
7501aa6fde93STejun Heo 	 * usefulness.
7502aa6fde93STejun Heo 	 */
7503aa6fde93STejun Heo 	thresh = 10 * USEC_PER_MSEC;
7504aa6fde93STejun Heo 
7505aa6fde93STejun Heo 	/* see init/calibrate.c for lpj -> BogoMIPS calculation */
7506aa6fde93STejun Heo 	bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1);
7507aa6fde93STejun Heo 	if (bogo < 4000)
7508aa6fde93STejun Heo 		thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC);
7509aa6fde93STejun Heo 
7510aa6fde93STejun Heo 	pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n",
7511aa6fde93STejun Heo 		 loops_per_jiffy, bogo, thresh);
7512aa6fde93STejun Heo 
7513aa6fde93STejun Heo 	wq_cpu_intensive_thresh_us = thresh;
7514aa6fde93STejun Heo }
7515aa6fde93STejun Heo 
75163347fa09STejun Heo /**
75173347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
75183347fa09STejun Heo  *
75192930155bSTejun Heo  * This is the second step of three-staged workqueue subsystem initialization
75202930155bSTejun Heo  * and invoked as soon as kthreads can be created and scheduled. Workqueues have
75212930155bSTejun Heo  * been created and work items queued on them, but there are no kworkers
75222930155bSTejun Heo  * executing the work items yet. Populate the worker pools with the initial
75232930155bSTejun Heo  * workers and enable future kworker creations.
75243347fa09STejun Heo  */
75252333e829SYu Chen void __init workqueue_init(void)
75263347fa09STejun Heo {
75272186d9f9STejun Heo 	struct workqueue_struct *wq;
75283347fa09STejun Heo 	struct worker_pool *pool;
75293347fa09STejun Heo 	int cpu, bkt;
75303347fa09STejun Heo 
7531aa6fde93STejun Heo 	wq_cpu_intensive_thresh_init();
7532aa6fde93STejun Heo 
75332186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
75342186d9f9STejun Heo 
75352930155bSTejun Heo 	/*
75362930155bSTejun Heo 	 * Per-cpu pools created earlier could be missing node hint. Fix them
75372930155bSTejun Heo 	 * up. Also, create a rescuer for workqueues that requested it.
75382930155bSTejun Heo 	 */
75392186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
75404cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu)
75412186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
75424cb1ef64STejun Heo 		for_each_cpu_worker_pool(pool, cpu)
75434cb1ef64STejun Heo 			pool->node = cpu_to_node(cpu);
75442186d9f9STejun Heo 	}
75452186d9f9STejun Heo 
754640c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
754740c17f75STejun Heo 		WARN(init_rescuer(wq),
754840c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
754940c17f75STejun Heo 		     wq->name);
755040c17f75STejun Heo 	}
75512186d9f9STejun Heo 
75522186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
75532186d9f9STejun Heo 
75544cb1ef64STejun Heo 	/*
75554cb1ef64STejun Heo 	 * Create the initial workers. A BH pool has one pseudo worker that
75564cb1ef64STejun Heo 	 * represents the shared BH execution context and thus doesn't get
75574cb1ef64STejun Heo 	 * affected by hotplug events. Create the BH pseudo workers for all
75584cb1ef64STejun Heo 	 * possible CPUs here.
75594cb1ef64STejun Heo 	 */
75604cb1ef64STejun Heo 	for_each_possible_cpu(cpu)
75614cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu)
75624cb1ef64STejun Heo 			BUG_ON(!create_worker(pool));
75634cb1ef64STejun Heo 
75643347fa09STejun Heo 	for_each_online_cpu(cpu) {
75653347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
75663347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
75673347fa09STejun Heo 			BUG_ON(!create_worker(pool));
75683347fa09STejun Heo 		}
75693347fa09STejun Heo 	}
75703347fa09STejun Heo 
75713347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
75723347fa09STejun Heo 		BUG_ON(!create_worker(pool));
75733347fa09STejun Heo 
75743347fa09STejun Heo 	wq_online = true;
757582607adcSTejun Heo 	wq_watchdog_init();
75761da177e4SLinus Torvalds }
7577c4f135d6STetsuo Handa 
7578025e1684STejun Heo /*
7579025e1684STejun Heo  * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to
7580025e1684STejun Heo  * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique
7581025e1684STejun Heo  * and consecutive pod ID. The rest of @pt is initialized accordingly.
7582025e1684STejun Heo  */
7583025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt,
7584025e1684STejun Heo 				 bool (*cpus_share_pod)(int, int))
7585025e1684STejun Heo {
7586025e1684STejun Heo 	int cur, pre, cpu, pod;
7587025e1684STejun Heo 
7588025e1684STejun Heo 	pt->nr_pods = 0;
7589025e1684STejun Heo 
7590025e1684STejun Heo 	/* init @pt->cpu_pod[] according to @cpus_share_pod() */
7591025e1684STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
7592025e1684STejun Heo 	BUG_ON(!pt->cpu_pod);
7593025e1684STejun Heo 
7594025e1684STejun Heo 	for_each_possible_cpu(cur) {
7595025e1684STejun Heo 		for_each_possible_cpu(pre) {
7596025e1684STejun Heo 			if (pre >= cur) {
7597025e1684STejun Heo 				pt->cpu_pod[cur] = pt->nr_pods++;
7598025e1684STejun Heo 				break;
7599025e1684STejun Heo 			}
7600025e1684STejun Heo 			if (cpus_share_pod(cur, pre)) {
7601025e1684STejun Heo 				pt->cpu_pod[cur] = pt->cpu_pod[pre];
7602025e1684STejun Heo 				break;
7603025e1684STejun Heo 			}
7604025e1684STejun Heo 		}
7605025e1684STejun Heo 	}
7606025e1684STejun Heo 
7607025e1684STejun Heo 	/* init the rest to match @pt->cpu_pod[] */
7608025e1684STejun Heo 	pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
7609025e1684STejun Heo 	pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL);
7610025e1684STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node);
7611025e1684STejun Heo 
7612025e1684STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++)
7613025e1684STejun Heo 		BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL));
7614025e1684STejun Heo 
7615025e1684STejun Heo 	for_each_possible_cpu(cpu) {
7616025e1684STejun Heo 		cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]);
7617025e1684STejun Heo 		pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu);
7618025e1684STejun Heo 	}
7619025e1684STejun Heo }
7620025e1684STejun Heo 
762163c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1)
762263c5484eSTejun Heo {
762363c5484eSTejun Heo 	return false;
762463c5484eSTejun Heo }
762563c5484eSTejun Heo 
762663c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1)
762763c5484eSTejun Heo {
762863c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT
762963c5484eSTejun Heo 	return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1));
763063c5484eSTejun Heo #else
763163c5484eSTejun Heo 	return false;
763263c5484eSTejun Heo #endif
763363c5484eSTejun Heo }
763463c5484eSTejun Heo 
7635025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1)
7636025e1684STejun Heo {
7637025e1684STejun Heo 	return cpu_to_node(cpu0) == cpu_to_node(cpu1);
7638025e1684STejun Heo }
7639025e1684STejun Heo 
76402930155bSTejun Heo /**
76412930155bSTejun Heo  * workqueue_init_topology - initialize CPU pods for unbound workqueues
76422930155bSTejun Heo  *
764396068b60SWang Jinchao  * This is the third step of three-staged workqueue subsystem initialization and
76442930155bSTejun Heo  * invoked after SMP and topology information are fully initialized. It
76452930155bSTejun Heo  * initializes the unbound CPU pods accordingly.
76462930155bSTejun Heo  */
76472930155bSTejun Heo void __init workqueue_init_topology(void)
7648a86feae6STejun Heo {
76492930155bSTejun Heo 	struct workqueue_struct *wq;
7650025e1684STejun Heo 	int cpu;
7651a86feae6STejun Heo 
765263c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share);
765363c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt);
765463c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache);
7655025e1684STejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa);
7656a86feae6STejun Heo 
7657c5f8cd6cSTejun Heo 	wq_topo_initialized = true;
7658c5f8cd6cSTejun Heo 
76592930155bSTejun Heo 	mutex_lock(&wq_pool_mutex);
7660a86feae6STejun Heo 
7661a86feae6STejun Heo 	/*
76622930155bSTejun Heo 	 * Workqueues allocated earlier would have all CPUs sharing the default
76632930155bSTejun Heo 	 * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU
76642930155bSTejun Heo 	 * combinations to apply per-pod sharing.
76652930155bSTejun Heo 	 */
76662930155bSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
76675797b1c1STejun Heo 		for_each_online_cpu(cpu)
76682930155bSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
76695797b1c1STejun Heo 		if (wq->flags & WQ_UNBOUND) {
76705797b1c1STejun Heo 			mutex_lock(&wq->mutex);
76715797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
76725797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
76732930155bSTejun Heo 		}
76742930155bSTejun Heo 	}
76752930155bSTejun Heo 
76762930155bSTejun Heo 	mutex_unlock(&wq_pool_mutex);
7677a86feae6STejun Heo }
7678a86feae6STejun Heo 
767920bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void)
768020bdedafSTetsuo Handa {
768120bdedafSTetsuo Handa 	pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n");
768220bdedafSTetsuo Handa 	dump_stack();
768320bdedafSTetsuo Handa }
7684c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq);
7685ace3c549Stiozhang 
7686ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str)
7687ace3c549Stiozhang {
7688ace3c549Stiozhang 	if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) {
7689ace3c549Stiozhang 		cpumask_clear(&wq_cmdline_cpumask);
7690ace3c549Stiozhang 		pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n");
7691ace3c549Stiozhang 	}
7692ace3c549Stiozhang 
7693ace3c549Stiozhang 	return 1;
7694ace3c549Stiozhang }
7695ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup);
7696