xref: /linux-6.15/kernel/workqueue.c (revision d412ace1)
1457c8996SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
21da177e4SLinus Torvalds /*
3c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
41da177e4SLinus Torvalds  *
5c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
81da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
9e1f8e874SFrancois Cami  *     Andrew Morton
101da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
111da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1289ada679SChristoph Lameter  *
13cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
14c54fce6eSTejun Heo  *
15c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
16c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
17c54fce6eSTejun Heo  *
18c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
19c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
20b11895c4SLibin  * automatically managed.  There are two worker pools for each CPU (one for
21b11895c4SLibin  * normal work items and the other for high priority ones) and some extra
22b11895c4SLibin  * pools for workqueues which are not bound to any specific CPU - the
23b11895c4SLibin  * number of these backing pools is dynamic.
24c54fce6eSTejun Heo  *
259a261491SBenjamin Peterson  * Please read Documentation/core-api/workqueue.rst for details.
261da177e4SLinus Torvalds  */
271da177e4SLinus Torvalds 
289984de1aSPaul Gortmaker #include <linux/export.h>
291da177e4SLinus Torvalds #include <linux/kernel.h>
301da177e4SLinus Torvalds #include <linux/sched.h>
311da177e4SLinus Torvalds #include <linux/init.h>
321da177e4SLinus Torvalds #include <linux/signal.h>
331da177e4SLinus Torvalds #include <linux/completion.h>
341da177e4SLinus Torvalds #include <linux/workqueue.h>
351da177e4SLinus Torvalds #include <linux/slab.h>
361da177e4SLinus Torvalds #include <linux/cpu.h>
371da177e4SLinus Torvalds #include <linux/notifier.h>
381da177e4SLinus Torvalds #include <linux/kthread.h>
391fa44ecaSJames Bottomley #include <linux/hardirq.h>
4046934023SChristoph Lameter #include <linux/mempolicy.h>
41341a5958SRafael J. Wysocki #include <linux/freezer.h>
42d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
434e6045f1SJohannes Berg #include <linux/lockdep.h>
44c34056a3STejun Heo #include <linux/idr.h>
4529c91e99STejun Heo #include <linux/jhash.h>
4642f8570fSSasha Levin #include <linux/hashtable.h>
4776af4d93STejun Heo #include <linux/rculist.h>
48bce90380STejun Heo #include <linux/nodemask.h>
494c16bd32STejun Heo #include <linux/moduleparam.h>
503d1cb205STejun Heo #include <linux/uaccess.h>
51c98a9805STal Shorer #include <linux/sched/isolation.h>
52cd2440d6SPetr Mladek #include <linux/sched/debug.h>
5362635ea8SSergey Senozhatsky #include <linux/nmi.h>
54940d71c6SSergey Senozhatsky #include <linux/kvm_para.h>
55aa6fde93STejun Heo #include <linux/delay.h>
56e22bee78STejun Heo 
57ea138446STejun Heo #include "workqueue_internal.h"
581da177e4SLinus Torvalds 
59e563d0a7STejun Heo enum worker_pool_flags {
60bc2ae0f5STejun Heo 	/*
6124647570STejun Heo 	 * worker_pool flags
62bc2ae0f5STejun Heo 	 *
6324647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
64bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
65bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
66bc2ae0f5STejun Heo 	 * is in effect.
67bc2ae0f5STejun Heo 	 *
68bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
69bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
7024647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
71bc2ae0f5STejun Heo 	 *
72bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
731258fae7STejun Heo 	 * wq_pool_attach_mutex to avoid changing binding state while
744736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
75bc2ae0f5STejun Heo 	 */
76692b4825STejun Heo 	POOL_MANAGER_ACTIVE	= 1 << 0,	/* being managed */
7724647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
78e563d0a7STejun Heo };
79db7bccf4STejun Heo 
80e563d0a7STejun Heo enum worker_flags {
81c8e55f36STejun Heo 	/* worker flags */
82c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
83c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
84e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
85fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
86f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
87a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
88e22bee78STejun Heo 
89a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
90a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
91e563d0a7STejun Heo };
92db7bccf4STejun Heo 
93e563d0a7STejun Heo enum wq_internal_consts {
94e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
954ce62e9eSTejun Heo 
9629c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
97c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
98db7bccf4STejun Heo 
99e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
100e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
101e22bee78STejun Heo 
1023233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
1033233cdbdSTejun Heo 						/* call for help after 10ms
1043233cdbdSTejun Heo 						   (min two ticks) */
105e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
106e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
1071da177e4SLinus Torvalds 
1081da177e4SLinus Torvalds 	/*
109e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1108698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
111e22bee78STejun Heo 	 */
1128698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1138698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
114ecf6881fSTejun Heo 
11531c89007SAudra Mitchell 	WQ_NAME_LEN		= 32,
116c8e55f36STejun Heo };
117c8e55f36STejun Heo 
1181da177e4SLinus Torvalds /*
1194690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1204690c4abSTejun Heo  *
121e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
122e41e704bSTejun Heo  *    everyone else.
1234690c4abSTejun Heo  *
124e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
125e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
126e22bee78STejun Heo  *
127d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1284690c4abSTejun Heo  *
1295797b1c1STejun Heo  * LN: pool->lock and wq_node_nr_active->lock protected for writes. Either for
1305797b1c1STejun Heo  *     reads.
1315797b1c1STejun Heo  *
132bdf8b9bfSTejun Heo  * K: Only modified by worker while holding pool->lock. Can be safely read by
133bdf8b9bfSTejun Heo  *    self, while holding pool->lock or from IRQ context if %current is the
134bdf8b9bfSTejun Heo  *    kworker.
135bdf8b9bfSTejun Heo  *
136bdf8b9bfSTejun Heo  * S: Only modified by worker self.
137bdf8b9bfSTejun Heo  *
1381258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
139822d8405STejun Heo  *
14068e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
14176af4d93STejun Heo  *
14224acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  RCU protected for reads.
1435bcab335STejun Heo  *
1445b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1455b95e1afSLai Jiangshan  *
1465b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
14724acfb71SThomas Gleixner  *      RCU for reads.
1485b95e1afSLai Jiangshan  *
1493c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1503c25a55dSLai Jiangshan  *
15124acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  RCU protected for reads.
1522e109a28STejun Heo  *
153a045a272STejun Heo  * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read
154a045a272STejun Heo  *     with READ_ONCE() without locking.
155a045a272STejun Heo  *
1562e109a28STejun Heo  * MD: wq_mayday_lock protected.
157cd2440d6SPetr Mladek  *
158cd2440d6SPetr Mladek  * WD: Used internally by the watchdog.
1594690c4abSTejun Heo  */
1604690c4abSTejun Heo 
1612eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
162c34056a3STejun Heo 
163bd7bdd43STejun Heo struct worker_pool {
164a9b8a985SSebastian Andrzej Siewior 	raw_spinlock_t		lock;		/* the pool lock */
165d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
166f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1679daf9e67STejun Heo 	int			id;		/* I: pool ID */
168bc8b50c2STejun Heo 	unsigned int		flags;		/* L: flags */
169bd7bdd43STejun Heo 
17082607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
171cd2440d6SPetr Mladek 	bool			cpu_stall;	/* WD: stalled cpu bound pool */
17282607adcSTejun Heo 
173bc35f7efSLai Jiangshan 	/*
174bc35f7efSLai Jiangshan 	 * The counter is incremented in a process context on the associated CPU
175bc35f7efSLai Jiangshan 	 * w/ preemption disabled, and decremented or reset in the same context
176bc35f7efSLai Jiangshan 	 * but w/ pool->lock held. The readers grab pool->lock and are
177bc35f7efSLai Jiangshan 	 * guaranteed to see if the counter reached zero.
178bc35f7efSLai Jiangshan 	 */
179bc35f7efSLai Jiangshan 	int			nr_running;
18084f91c62SLai Jiangshan 
181bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
182ea1abd61SLai Jiangshan 
1835826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
1845826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
185bd7bdd43STejun Heo 
1862c1f1a91SLai Jiangshan 	struct list_head	idle_list;	/* L: list of idle workers */
187bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
1883f959aa3SValentin Schneider 	struct work_struct      idle_cull_work; /* L: worker idle cleanup */
1893f959aa3SValentin Schneider 
190bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	  /* L: SOS timer for workers */
191bd7bdd43STejun Heo 
192c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
193c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
194c9e7cf27STejun Heo 						/* L: hash of busy workers */
195c9e7cf27STejun Heo 
1962607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
19792f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
198e02b9312SValentin Schneider 	struct list_head        dying_workers;  /* A: workers about to die */
19960f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
200e19e397aSTejun Heo 
2017cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
202e19e397aSTejun Heo 
2037a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
20468e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
20568e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
2067a4e344cSTejun Heo 
207e19e397aSTejun Heo 	/*
20824acfb71SThomas Gleixner 	 * Destruction of pool is RCU protected to allow dereferences
20929c91e99STejun Heo 	 * from get_work_pool().
21029c91e99STejun Heo 	 */
21129c91e99STejun Heo 	struct rcu_head		rcu;
21284f91c62SLai Jiangshan };
2138b03ae3cSTejun Heo 
2148b03ae3cSTejun Heo /*
215725e8ec5STejun Heo  * Per-pool_workqueue statistics. These can be monitored using
216725e8ec5STejun Heo  * tools/workqueue/wq_monitor.py.
217725e8ec5STejun Heo  */
218725e8ec5STejun Heo enum pool_workqueue_stats {
219725e8ec5STejun Heo 	PWQ_STAT_STARTED,	/* work items started execution */
220725e8ec5STejun Heo 	PWQ_STAT_COMPLETED,	/* work items completed execution */
2218a1dd1e5STejun Heo 	PWQ_STAT_CPU_TIME,	/* total CPU time consumed */
222616db877STejun Heo 	PWQ_STAT_CPU_INTENSIVE,	/* wq_cpu_intensive_thresh_us violations */
223725e8ec5STejun Heo 	PWQ_STAT_CM_WAKEUP,	/* concurrency-management worker wakeups */
2248639ecebSTejun Heo 	PWQ_STAT_REPATRIATED,	/* unbound workers brought back into scope */
225725e8ec5STejun Heo 	PWQ_STAT_MAYDAY,	/* maydays to rescuer */
226725e8ec5STejun Heo 	PWQ_STAT_RESCUED,	/* linked work items executed by rescuer */
227725e8ec5STejun Heo 
228725e8ec5STejun Heo 	PWQ_NR_STATS,
229725e8ec5STejun Heo };
230725e8ec5STejun Heo 
231725e8ec5STejun Heo /*
232112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
233112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
234112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
235112202d9STejun Heo  * number of flag bits.
2361da177e4SLinus Torvalds  */
237112202d9STejun Heo struct pool_workqueue {
238bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2394690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
24073f53c4aSTejun Heo 	int			work_color;	/* L: current color */
24173f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2428864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
24373f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
24473f53c4aSTejun Heo 						/* L: nr of in_flight works */
245018f3a13SLai Jiangshan 
246018f3a13SLai Jiangshan 	/*
247018f3a13SLai Jiangshan 	 * nr_active management and WORK_STRUCT_INACTIVE:
248018f3a13SLai Jiangshan 	 *
249018f3a13SLai Jiangshan 	 * When pwq->nr_active >= max_active, new work item is queued to
250018f3a13SLai Jiangshan 	 * pwq->inactive_works instead of pool->worklist and marked with
251018f3a13SLai Jiangshan 	 * WORK_STRUCT_INACTIVE.
252018f3a13SLai Jiangshan 	 *
2535797b1c1STejun Heo 	 * All work items marked with WORK_STRUCT_INACTIVE do not participate in
2545797b1c1STejun Heo 	 * nr_active and all work items in pwq->inactive_works are marked with
2555797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE work items are
2565797b1c1STejun Heo 	 * in pwq->inactive_works. Some of them are ready to run in
2575797b1c1STejun Heo 	 * pool->worklist or worker->scheduled. Those work itmes are only struct
2585797b1c1STejun Heo 	 * wq_barrier which is used for flush_work() and should not participate
2595797b1c1STejun Heo 	 * in nr_active. For non-barrier work item, it is marked with
2605797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
261018f3a13SLai Jiangshan 	 */
2621e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
263f97a4a1aSLai Jiangshan 	struct list_head	inactive_works;	/* L: inactive works */
2645797b1c1STejun Heo 	struct list_head	pending_node;	/* LN: node on wq_node_nr_active->pending_pwqs */
2653c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2662e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2678864b4e5STejun Heo 
268725e8ec5STejun Heo 	u64			stats[PWQ_NR_STATS];
269725e8ec5STejun Heo 
2708864b4e5STejun Heo 	/*
271967b494eSTejun Heo 	 * Release of unbound pwq is punted to a kthread_worker. See put_pwq()
272687a9aa5STejun Heo 	 * and pwq_release_workfn() for details. pool_workqueue itself is also
273687a9aa5STejun Heo 	 * RCU protected so that the first pwq can be determined without
274967b494eSTejun Heo 	 * grabbing wq->mutex.
2758864b4e5STejun Heo 	 */
276687a9aa5STejun Heo 	struct kthread_work	release_work;
2778864b4e5STejun Heo 	struct rcu_head		rcu;
278e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2791da177e4SLinus Torvalds 
2801da177e4SLinus Torvalds /*
28173f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
28273f53c4aSTejun Heo  */
28373f53c4aSTejun Heo struct wq_flusher {
2843c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2853c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
28673f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
28773f53c4aSTejun Heo };
2881da177e4SLinus Torvalds 
289226223abSTejun Heo struct wq_device;
290226223abSTejun Heo 
29173f53c4aSTejun Heo /*
29291ccc6e7STejun Heo  * Unlike in a per-cpu workqueue where max_active limits its concurrency level
29391ccc6e7STejun Heo  * on each CPU, in an unbound workqueue, max_active applies to the whole system.
29491ccc6e7STejun Heo  * As sharing a single nr_active across multiple sockets can be very expensive,
29591ccc6e7STejun Heo  * the counting and enforcement is per NUMA node.
2965797b1c1STejun Heo  *
2975797b1c1STejun Heo  * The following struct is used to enforce per-node max_active. When a pwq wants
2985797b1c1STejun Heo  * to start executing a work item, it should increment ->nr using
2995797b1c1STejun Heo  * tryinc_node_nr_active(). If acquisition fails due to ->nr already being over
3005797b1c1STejun Heo  * ->max, the pwq is queued on ->pending_pwqs. As in-flight work items finish
3015797b1c1STejun Heo  * and decrement ->nr, node_activate_pending_pwq() activates the pending pwqs in
3025797b1c1STejun Heo  * round-robin order.
30391ccc6e7STejun Heo  */
30491ccc6e7STejun Heo struct wq_node_nr_active {
3055797b1c1STejun Heo 	int			max;		/* per-node max_active */
3065797b1c1STejun Heo 	atomic_t		nr;		/* per-node nr_active */
3075797b1c1STejun Heo 	raw_spinlock_t		lock;		/* nests inside pool locks */
3085797b1c1STejun Heo 	struct list_head	pending_pwqs;	/* LN: pwqs with inactive works */
30991ccc6e7STejun Heo };
31091ccc6e7STejun Heo 
31191ccc6e7STejun Heo /*
312c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
313c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
3141da177e4SLinus Torvalds  */
3151da177e4SLinus Torvalds struct workqueue_struct {
3163c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
317e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
31873f53c4aSTejun Heo 
3193c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
3203c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
3213c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
322112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
3233c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
3243c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
3253c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
32673f53c4aSTejun Heo 
3272e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
32830ae2fc0STejun Heo 	struct worker		*rescuer;	/* MD: rescue worker */
329e22bee78STejun Heo 
33087fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
3315797b1c1STejun Heo 
3325797b1c1STejun Heo 	/* See alloc_workqueue() function comment for info on min/max_active */
333a045a272STejun Heo 	int			max_active;	/* WO: max active works */
3345797b1c1STejun Heo 	int			min_active;	/* WO: min active works */
335a045a272STejun Heo 	int			saved_max_active; /* WQ: saved max_active */
3365797b1c1STejun Heo 	int			saved_min_active; /* WQ: saved min_active */
337226223abSTejun Heo 
3385b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
3399f66cff2STejun Heo 	struct pool_workqueue __rcu *dfl_pwq;   /* PW: only for unbound wqs */
3406029a918STejun Heo 
341226223abSTejun Heo #ifdef CONFIG_SYSFS
342226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
343226223abSTejun Heo #endif
3444e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
345669de8bdSBart Van Assche 	char			*lock_name;
346669de8bdSBart Van Assche 	struct lock_class_key	key;
3474e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
3484e6045f1SJohannes Berg #endif
349ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
3502728fd2fSTejun Heo 
351e2dca7adSTejun Heo 	/*
35224acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
35324acfb71SThomas Gleixner 	 * the workqueues list without grabbing wq_pool_mutex.
354e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
355e2dca7adSTejun Heo 	 */
356e2dca7adSTejun Heo 	struct rcu_head		rcu;
357e2dca7adSTejun Heo 
3582728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
3592728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
360636b927eSTejun Heo 	struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */
36191ccc6e7STejun Heo 	struct wq_node_nr_active *node_nr_active[]; /* I: per-node nr_active */
3621da177e4SLinus Torvalds };
3631da177e4SLinus Torvalds 
364e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
365e904e6c2STejun Heo 
36684193c07STejun Heo /*
36784193c07STejun Heo  * Each pod type describes how CPUs should be grouped for unbound workqueues.
36884193c07STejun Heo  * See the comment above workqueue_attrs->affn_scope.
36984193c07STejun Heo  */
37084193c07STejun Heo struct wq_pod_type {
37184193c07STejun Heo 	int			nr_pods;	/* number of pods */
37284193c07STejun Heo 	cpumask_var_t		*pod_cpus;	/* pod -> cpus */
37384193c07STejun Heo 	int			*pod_node;	/* pod -> node */
37484193c07STejun Heo 	int			*cpu_pod;	/* cpu -> pod */
37584193c07STejun Heo };
37684193c07STejun Heo 
37784193c07STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES];
378523a301eSTejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE;
37963c5484eSTejun Heo 
38063c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = {
381523a301eSTejun Heo 	[WQ_AFFN_DFL]			= "default",
38263c5484eSTejun Heo 	[WQ_AFFN_CPU]			= "cpu",
38363c5484eSTejun Heo 	[WQ_AFFN_SMT]			= "smt",
38463c5484eSTejun Heo 	[WQ_AFFN_CACHE]			= "cache",
38563c5484eSTejun Heo 	[WQ_AFFN_NUMA]			= "numa",
38663c5484eSTejun Heo 	[WQ_AFFN_SYSTEM]		= "system",
38763c5484eSTejun Heo };
388bce90380STejun Heo 
389c5f8cd6cSTejun Heo static bool wq_topo_initialized __read_mostly = false;
390c5f8cd6cSTejun Heo 
391616db877STejun Heo /*
392616db877STejun Heo  * Per-cpu work items which run for longer than the following threshold are
393616db877STejun Heo  * automatically considered CPU intensive and excluded from concurrency
394616db877STejun Heo  * management to prevent them from noticeably delaying other per-cpu work items.
395aa6fde93STejun Heo  * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter.
396aa6fde93STejun Heo  * The actual value is initialized in wq_cpu_intensive_thresh_init().
397616db877STejun Heo  */
398aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX;
399616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644);
400616db877STejun Heo 
401cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
402552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
403cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
404cee22a15SViresh Kumar 
405863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
4063347fa09STejun Heo 
407fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */
408fef59c9cSTejun Heo static struct workqueue_attrs *wq_update_pod_attrs_buf;
4094c16bd32STejun Heo 
41068e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
4111258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
412a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
413d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */
414d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
4155bcab335STejun Heo 
416e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
41768e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
4187d19c5ceSTejun Heo 
41999c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */
420ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
421ef557180SMike Galbraith 
422fe28f631SWaiman Long /* PL: user requested unbound cpumask via sysfs */
423fe28f631SWaiman Long static cpumask_var_t wq_requested_unbound_cpumask;
424fe28f631SWaiman Long 
425fe28f631SWaiman Long /* PL: isolated cpumask to be excluded from unbound cpumask */
426fe28f631SWaiman Long static cpumask_var_t wq_isolated_cpumask;
427fe28f631SWaiman Long 
428ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/
429ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata;
430ace3c549Stiozhang 
431ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
432ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
433b05a7928SFrederic Weisbecker 
434f303fccbSTejun Heo /*
435f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
436f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
437f303fccbSTejun Heo  * to uncover usages which depend on it.
438f303fccbSTejun Heo  */
439f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
440f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
441f303fccbSTejun Heo #else
442f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
443f303fccbSTejun Heo #endif
444f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
445f303fccbSTejun Heo 
4467d19c5ceSTejun Heo /* the per-cpu worker pools */
44725528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
4487d19c5ceSTejun Heo 
44968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
4507d19c5ceSTejun Heo 
45168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
45229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
45329c91e99STejun Heo 
454c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
45529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
45629c91e99STejun Heo 
4578a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
4588a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
4598a2b7538STejun Heo 
460967b494eSTejun Heo /*
461967b494eSTejun Heo  * I: kthread_worker to release pwq's. pwq release needs to be bounced to a
462967b494eSTejun Heo  * process context while holding a pool lock. Bounce to a dedicated kthread
463967b494eSTejun Heo  * worker to avoid A-A deadlocks.
464967b494eSTejun Heo  */
46568279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init;
466967b494eSTejun Heo 
46768279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init;
468ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
46968279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init;
4701aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
47168279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init;
472d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
47368279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init;
474f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
47568279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init;
47624d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
47768279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init;
4780668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
47968279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init;
4800668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
481d320c038STejun Heo 
4827d19c5ceSTejun Heo static int worker_thread(void *__worker);
4836ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
484c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq);
48555df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool);
4867d19c5ceSTejun Heo 
48797bd2347STejun Heo #define CREATE_TRACE_POINTS
48897bd2347STejun Heo #include <trace/events/workqueue.h>
48997bd2347STejun Heo 
49068e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
49124acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
492f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
49324acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
4945bcab335STejun Heo 
4955b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
49624acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
497f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
498f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
49924acfb71SThomas Gleixner 			 "RCU, wq->mutex or wq_pool_mutex should be held")
5005b95e1afSLai Jiangshan 
501f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
502f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
503f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5047a62c2c8STejun Heo 	     (pool)++)
5054ce62e9eSTejun Heo 
50649e3cf44STejun Heo /**
50717116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
50817116969STejun Heo  * @pool: iteration cursor
509611c92a0STejun Heo  * @pi: integer used for iteration
510fa1b54e6STejun Heo  *
51124acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or RCU read
51268e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
51368e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
514fa1b54e6STejun Heo  *
515fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
516fa1b54e6STejun Heo  * ignored.
51717116969STejun Heo  */
518611c92a0STejun Heo #define for_each_pool(pool, pi)						\
519611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
52068e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
521fa1b54e6STejun Heo 		else
52217116969STejun Heo 
52317116969STejun Heo /**
524822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
525822d8405STejun Heo  * @worker: iteration cursor
526822d8405STejun Heo  * @pool: worker_pool to iterate workers of
527822d8405STejun Heo  *
5281258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
529822d8405STejun Heo  *
530822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
531822d8405STejun Heo  * ignored.
532822d8405STejun Heo  */
533da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
534da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
5351258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
536822d8405STejun Heo 		else
537822d8405STejun Heo 
538822d8405STejun Heo /**
53949e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
54049e3cf44STejun Heo  * @pwq: iteration cursor
54149e3cf44STejun Heo  * @wq: the target workqueue
54276af4d93STejun Heo  *
54324acfb71SThomas Gleixner  * This must be called either with wq->mutex held or RCU read locked.
544794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
545794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
54676af4d93STejun Heo  *
54776af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
54876af4d93STejun Heo  * ignored.
54949e3cf44STejun Heo  */
55049e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
55149e9d1a9SSebastian Andrzej Siewior 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node,		\
5525a644662SJoel Fernandes (Google) 				 lockdep_is_held(&(wq->mutex)))
553f3421797STejun Heo 
554dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
555dc186ad7SThomas Gleixner 
556f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr;
557dc186ad7SThomas Gleixner 
55899777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
55999777288SStanislaw Gruszka {
56099777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
56199777288SStanislaw Gruszka }
56299777288SStanislaw Gruszka 
563b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
564b9fdac7fSDu, Changbin {
565b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
566b9fdac7fSDu, Changbin 
567b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
568b9fdac7fSDu, Changbin }
569b9fdac7fSDu, Changbin 
570dc186ad7SThomas Gleixner /*
571dc186ad7SThomas Gleixner  * fixup_init is called when:
572dc186ad7SThomas Gleixner  * - an active object is initialized
573dc186ad7SThomas Gleixner  */
57402a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
575dc186ad7SThomas Gleixner {
576dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
577dc186ad7SThomas Gleixner 
578dc186ad7SThomas Gleixner 	switch (state) {
579dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
580dc186ad7SThomas Gleixner 		cancel_work_sync(work);
581dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
58202a982a6SDu, Changbin 		return true;
583dc186ad7SThomas Gleixner 	default:
58402a982a6SDu, Changbin 		return false;
585dc186ad7SThomas Gleixner 	}
586dc186ad7SThomas Gleixner }
587dc186ad7SThomas Gleixner 
588dc186ad7SThomas Gleixner /*
589dc186ad7SThomas Gleixner  * fixup_free is called when:
590dc186ad7SThomas Gleixner  * - an active object is freed
591dc186ad7SThomas Gleixner  */
59202a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
593dc186ad7SThomas Gleixner {
594dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
595dc186ad7SThomas Gleixner 
596dc186ad7SThomas Gleixner 	switch (state) {
597dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
598dc186ad7SThomas Gleixner 		cancel_work_sync(work);
599dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
60002a982a6SDu, Changbin 		return true;
601dc186ad7SThomas Gleixner 	default:
60202a982a6SDu, Changbin 		return false;
603dc186ad7SThomas Gleixner 	}
604dc186ad7SThomas Gleixner }
605dc186ad7SThomas Gleixner 
606f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = {
607dc186ad7SThomas Gleixner 	.name		= "work_struct",
60899777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
609b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
610dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
611dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
612dc186ad7SThomas Gleixner };
613dc186ad7SThomas Gleixner 
614dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
615dc186ad7SThomas Gleixner {
616dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
617dc186ad7SThomas Gleixner }
618dc186ad7SThomas Gleixner 
619dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
620dc186ad7SThomas Gleixner {
621dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
622dc186ad7SThomas Gleixner }
623dc186ad7SThomas Gleixner 
624dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
625dc186ad7SThomas Gleixner {
626dc186ad7SThomas Gleixner 	if (onstack)
627dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
628dc186ad7SThomas Gleixner 	else
629dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
630dc186ad7SThomas Gleixner }
631dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
632dc186ad7SThomas Gleixner 
633dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
634dc186ad7SThomas Gleixner {
635dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
636dc186ad7SThomas Gleixner }
637dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
638dc186ad7SThomas Gleixner 
639ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
640ea2e64f2SThomas Gleixner {
641ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
642ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
643ea2e64f2SThomas Gleixner }
644ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
645ea2e64f2SThomas Gleixner 
646dc186ad7SThomas Gleixner #else
647dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
648dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
649dc186ad7SThomas Gleixner #endif
650dc186ad7SThomas Gleixner 
6514e8b22bdSLi Bin /**
65267dc8325SCai Huoqing  * worker_pool_assign_id - allocate ID and assign it to @pool
6534e8b22bdSLi Bin  * @pool: the pool pointer of interest
6544e8b22bdSLi Bin  *
6554e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
6564e8b22bdSLi Bin  * successfully, -errno on failure.
6574e8b22bdSLi Bin  */
6589daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
6599daf9e67STejun Heo {
6609daf9e67STejun Heo 	int ret;
6619daf9e67STejun Heo 
66268e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6635bcab335STejun Heo 
6644e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
6654e8b22bdSLi Bin 			GFP_KERNEL);
666229641a6STejun Heo 	if (ret >= 0) {
667e68035fbSTejun Heo 		pool->id = ret;
668229641a6STejun Heo 		return 0;
669229641a6STejun Heo 	}
6709daf9e67STejun Heo 	return ret;
6719daf9e67STejun Heo }
6729daf9e67STejun Heo 
6739f66cff2STejun Heo static struct pool_workqueue __rcu **
6749f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu)
6759f66cff2STejun Heo {
6769f66cff2STejun Heo        if (cpu >= 0)
6779f66cff2STejun Heo                return per_cpu_ptr(wq->cpu_pwq, cpu);
6789f66cff2STejun Heo        else
6799f66cff2STejun Heo                return &wq->dfl_pwq;
6809f66cff2STejun Heo }
6819f66cff2STejun Heo 
6829f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */
6839f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu)
6849f66cff2STejun Heo {
6859f66cff2STejun Heo 	return rcu_dereference_check(*unbound_pwq_slot(wq, cpu),
6869f66cff2STejun Heo 				     lockdep_is_held(&wq_pool_mutex) ||
6879f66cff2STejun Heo 				     lockdep_is_held(&wq->mutex));
6889f66cff2STejun Heo }
6899f66cff2STejun Heo 
6905797b1c1STejun Heo /**
6915797b1c1STejun Heo  * unbound_effective_cpumask - effective cpumask of an unbound workqueue
6925797b1c1STejun Heo  * @wq: workqueue of interest
6935797b1c1STejun Heo  *
6945797b1c1STejun Heo  * @wq->unbound_attrs->cpumask contains the cpumask requested by the user which
6955797b1c1STejun Heo  * is masked with wq_unbound_cpumask to determine the effective cpumask. The
6965797b1c1STejun Heo  * default pwq is always mapped to the pool with the current effective cpumask.
6975797b1c1STejun Heo  */
6985797b1c1STejun Heo static struct cpumask *unbound_effective_cpumask(struct workqueue_struct *wq)
6995797b1c1STejun Heo {
7005797b1c1STejun Heo 	return unbound_pwq(wq, -1)->pool->attrs->__pod_cpumask;
7015797b1c1STejun Heo }
7025797b1c1STejun Heo 
70373f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
70473f53c4aSTejun Heo {
70573f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
70673f53c4aSTejun Heo }
70773f53c4aSTejun Heo 
708c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data)
70973f53c4aSTejun Heo {
710c4560c2cSLai Jiangshan 	return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
71173f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
71273f53c4aSTejun Heo }
71373f53c4aSTejun Heo 
71473f53c4aSTejun Heo static int work_next_color(int color)
71573f53c4aSTejun Heo {
71673f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
717a848e3b6SOleg Nesterov }
718a848e3b6SOleg Nesterov 
7194594bf15SDavid Howells /*
720112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
721112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
7227c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
7237a22ad75STejun Heo  *
724112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
725112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
726bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
727bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
7287a22ad75STejun Heo  *
729112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7307c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
731112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
7327c3eed5cSTejun Heo  * available only while the work item is queued.
733bbb68dfaSTejun Heo  *
734bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
735bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
736bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
737bbb68dfaSTejun Heo  * try to steal the PENDING bit.
7384594bf15SDavid Howells  */
7397a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
7407a22ad75STejun Heo 				 unsigned long flags)
7417a22ad75STejun Heo {
7426183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
7437a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
7447a22ad75STejun Heo }
7457a22ad75STejun Heo 
746112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
7474690c4abSTejun Heo 			 unsigned long extra_flags)
748365970a1SDavid Howells {
749112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
750112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
751365970a1SDavid Howells }
752365970a1SDavid Howells 
7534468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
7544468a00fSLai Jiangshan 					   int pool_id)
7554468a00fSLai Jiangshan {
7564468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
7574468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
7584468a00fSLai Jiangshan }
7594468a00fSLai Jiangshan 
7607c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
7617c3eed5cSTejun Heo 					    int pool_id)
7624d707b9fSOleg Nesterov {
76323657bb1STejun Heo 	/*
76423657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
76523657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
76623657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
76723657bb1STejun Heo 	 * owner.
76823657bb1STejun Heo 	 */
76923657bb1STejun Heo 	smp_wmb();
7707c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
771346c09f8SRoman Pen 	/*
772346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
773346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
774346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
7758bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
776346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
777346c09f8SRoman Pen 	 *
778346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
779346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
780346c09f8SRoman Pen 	 *
781346c09f8SRoman Pen 	 * 1  STORE event_indicated
782346c09f8SRoman Pen 	 * 2  queue_work_on() {
783346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
784346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
785346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
786346c09f8SRoman Pen 	 * 6                                 smp_mb()
787346c09f8SRoman Pen 	 * 7                               work->current_func() {
788346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
789346c09f8SRoman Pen 	 *				   }
790346c09f8SRoman Pen 	 *
791346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
792346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
793346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
794346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
795346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
796346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
797346c09f8SRoman Pen 	 * before actual STORE.
798346c09f8SRoman Pen 	 */
799346c09f8SRoman Pen 	smp_mb();
8004d707b9fSOleg Nesterov }
8014d707b9fSOleg Nesterov 
8027a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
803365970a1SDavid Howells {
8047c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
8057c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
8067a22ad75STejun Heo }
8077a22ad75STejun Heo 
808afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data)
809afa4bb77SLinus Torvalds {
810afa4bb77SLinus Torvalds 	return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK);
811afa4bb77SLinus Torvalds }
812afa4bb77SLinus Torvalds 
813112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
8147a22ad75STejun Heo {
815e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8167a22ad75STejun Heo 
817112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
818afa4bb77SLinus Torvalds 		return work_struct_pwq(data);
819e120153dSTejun Heo 	else
820e120153dSTejun Heo 		return NULL;
8217a22ad75STejun Heo }
8227a22ad75STejun Heo 
8237c3eed5cSTejun Heo /**
8247c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
8257c3eed5cSTejun Heo  * @work: the work item of interest
8267c3eed5cSTejun Heo  *
82768e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
82824acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
82924acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
830fa1b54e6STejun Heo  *
831fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
832fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
833fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
834fa1b54e6STejun Heo  * returned pool is and stays online.
835d185af30SYacine Belkadi  *
836d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
8377c3eed5cSTejun Heo  */
8387c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
8397a22ad75STejun Heo {
840e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8417c3eed5cSTejun Heo 	int pool_id;
8427a22ad75STejun Heo 
84368e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
844fa1b54e6STejun Heo 
845112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
846afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool;
8477a22ad75STejun Heo 
8487c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
8497c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
8507a22ad75STejun Heo 		return NULL;
8517a22ad75STejun Heo 
852fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
8537c3eed5cSTejun Heo }
8547c3eed5cSTejun Heo 
8557c3eed5cSTejun Heo /**
8567c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
8577c3eed5cSTejun Heo  * @work: the work item of interest
8587c3eed5cSTejun Heo  *
859d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
8607c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
8617c3eed5cSTejun Heo  */
8627c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
8637c3eed5cSTejun Heo {
86454d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
8657c3eed5cSTejun Heo 
866112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
867afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool->id;
86854d5b7d0SLai Jiangshan 
86954d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
8707c3eed5cSTejun Heo }
8717c3eed5cSTejun Heo 
872bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
873bbb68dfaSTejun Heo {
8747c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
875bbb68dfaSTejun Heo 
8767c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
8777c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
878bbb68dfaSTejun Heo }
879bbb68dfaSTejun Heo 
880bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
881bbb68dfaSTejun Heo {
882bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
883bbb68dfaSTejun Heo 
884112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
885bbb68dfaSTejun Heo }
886bbb68dfaSTejun Heo 
887e22bee78STejun Heo /*
8883270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
8893270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
890d565ed63STejun Heo  * they're being called with pool->lock held.
891e22bee78STejun Heo  */
892e22bee78STejun Heo 
893e22bee78STejun Heo /*
894e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
895e22bee78STejun Heo  * running workers.
896974271c4STejun Heo  *
897974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
898706026c2STejun Heo  * function will always return %true for unbound pools as long as the
899974271c4STejun Heo  * worklist isn't empty.
900e22bee78STejun Heo  */
90163d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
902e22bee78STejun Heo {
9030219a352STejun Heo 	return !list_empty(&pool->worklist) && !pool->nr_running;
904e22bee78STejun Heo }
905e22bee78STejun Heo 
906e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
90763d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
908e22bee78STejun Heo {
90963d95a91STejun Heo 	return pool->nr_idle;
910e22bee78STejun Heo }
911e22bee78STejun Heo 
912e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
91363d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
914e22bee78STejun Heo {
915bc35f7efSLai Jiangshan 	return !list_empty(&pool->worklist) && (pool->nr_running <= 1);
916e22bee78STejun Heo }
917e22bee78STejun Heo 
918e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
91963d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
920e22bee78STejun Heo {
92163d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
922e22bee78STejun Heo }
923e22bee78STejun Heo 
924e22bee78STejun Heo /* Do we have too many workers and should some go away? */
92563d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
926e22bee78STejun Heo {
927692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
92863d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
92963d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
930e22bee78STejun Heo 
931e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
932e22bee78STejun Heo }
933e22bee78STejun Heo 
9344690c4abSTejun Heo /**
935e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
936cb444766STejun Heo  * @worker: self
937d302f017STejun Heo  * @flags: flags to set
938d302f017STejun Heo  *
939228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
940d302f017STejun Heo  */
941228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
942d302f017STejun Heo {
943bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
944e22bee78STejun Heo 
945bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
946cb444766STejun Heo 
947228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
948e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
949e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
950bc35f7efSLai Jiangshan 		pool->nr_running--;
951e22bee78STejun Heo 	}
952e22bee78STejun Heo 
953d302f017STejun Heo 	worker->flags |= flags;
954d302f017STejun Heo }
955d302f017STejun Heo 
956d302f017STejun Heo /**
957e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
958cb444766STejun Heo  * @worker: self
959d302f017STejun Heo  * @flags: flags to clear
960d302f017STejun Heo  *
961e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
962d302f017STejun Heo  */
963d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
964d302f017STejun Heo {
96563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
966e22bee78STejun Heo 	unsigned int oflags = worker->flags;
967e22bee78STejun Heo 
968bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
969cb444766STejun Heo 
970d302f017STejun Heo 	worker->flags &= ~flags;
971e22bee78STejun Heo 
97242c025f3STejun Heo 	/*
97342c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
97442c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
97542c025f3STejun Heo 	 * of multiple flags, not a single flag.
97642c025f3STejun Heo 	 */
977e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
978e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
979bc35f7efSLai Jiangshan 			pool->nr_running++;
980d302f017STejun Heo }
981d302f017STejun Heo 
982797e8345STejun Heo /* Return the first idle worker.  Called with pool->lock held. */
983797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool)
984797e8345STejun Heo {
985797e8345STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
986797e8345STejun Heo 		return NULL;
987797e8345STejun Heo 
988797e8345STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
989797e8345STejun Heo }
990797e8345STejun Heo 
991797e8345STejun Heo /**
992797e8345STejun Heo  * worker_enter_idle - enter idle state
993797e8345STejun Heo  * @worker: worker which is entering idle state
994797e8345STejun Heo  *
995797e8345STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
996797e8345STejun Heo  * necessary.
997797e8345STejun Heo  *
998797e8345STejun Heo  * LOCKING:
999797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1000797e8345STejun Heo  */
1001797e8345STejun Heo static void worker_enter_idle(struct worker *worker)
1002797e8345STejun Heo {
1003797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1004797e8345STejun Heo 
1005797e8345STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1006797e8345STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
1007797e8345STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
1008797e8345STejun Heo 		return;
1009797e8345STejun Heo 
1010797e8345STejun Heo 	/* can't use worker_set_flags(), also called from create_worker() */
1011797e8345STejun Heo 	worker->flags |= WORKER_IDLE;
1012797e8345STejun Heo 	pool->nr_idle++;
1013797e8345STejun Heo 	worker->last_active = jiffies;
1014797e8345STejun Heo 
1015797e8345STejun Heo 	/* idle_list is LIFO */
1016797e8345STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1017797e8345STejun Heo 
1018797e8345STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1019797e8345STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1020797e8345STejun Heo 
1021797e8345STejun Heo 	/* Sanity check nr_running. */
1022797e8345STejun Heo 	WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running);
1023797e8345STejun Heo }
1024797e8345STejun Heo 
1025797e8345STejun Heo /**
1026797e8345STejun Heo  * worker_leave_idle - leave idle state
1027797e8345STejun Heo  * @worker: worker which is leaving idle state
1028797e8345STejun Heo  *
1029797e8345STejun Heo  * @worker is leaving idle state.  Update stats.
1030797e8345STejun Heo  *
1031797e8345STejun Heo  * LOCKING:
1032797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1033797e8345STejun Heo  */
1034797e8345STejun Heo static void worker_leave_idle(struct worker *worker)
1035797e8345STejun Heo {
1036797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1037797e8345STejun Heo 
1038797e8345STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1039797e8345STejun Heo 		return;
1040797e8345STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1041797e8345STejun Heo 	pool->nr_idle--;
1042797e8345STejun Heo 	list_del_init(&worker->entry);
1043797e8345STejun Heo }
1044797e8345STejun Heo 
1045797e8345STejun Heo /**
1046797e8345STejun Heo  * find_worker_executing_work - find worker which is executing a work
1047797e8345STejun Heo  * @pool: pool of interest
1048797e8345STejun Heo  * @work: work to find worker for
1049797e8345STejun Heo  *
1050797e8345STejun Heo  * Find a worker which is executing @work on @pool by searching
1051797e8345STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
1052797e8345STejun Heo  * to match, its current execution should match the address of @work and
1053797e8345STejun Heo  * its work function.  This is to avoid unwanted dependency between
1054797e8345STejun Heo  * unrelated work executions through a work item being recycled while still
1055797e8345STejun Heo  * being executed.
1056797e8345STejun Heo  *
1057797e8345STejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1058797e8345STejun Heo  * starts and nothing prevents the freed area from being recycled for
1059797e8345STejun Heo  * another work item.  If the same work item address ends up being reused
1060797e8345STejun Heo  * before the original execution finishes, workqueue will identify the
1061797e8345STejun Heo  * recycled work item as currently executing and make it wait until the
1062797e8345STejun Heo  * current execution finishes, introducing an unwanted dependency.
1063797e8345STejun Heo  *
1064797e8345STejun Heo  * This function checks the work item address and work function to avoid
1065797e8345STejun Heo  * false positives.  Note that this isn't complete as one may construct a
1066797e8345STejun Heo  * work function which can introduce dependency onto itself through a
1067797e8345STejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1068797e8345STejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1069797e8345STejun Heo  * actually occurs, it should be easy to locate the culprit work function.
1070797e8345STejun Heo  *
1071797e8345STejun Heo  * CONTEXT:
1072797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1073797e8345STejun Heo  *
1074797e8345STejun Heo  * Return:
1075797e8345STejun Heo  * Pointer to worker which is executing @work if found, %NULL
1076797e8345STejun Heo  * otherwise.
1077797e8345STejun Heo  */
1078797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
1079797e8345STejun Heo 						 struct work_struct *work)
1080797e8345STejun Heo {
1081797e8345STejun Heo 	struct worker *worker;
1082797e8345STejun Heo 
1083797e8345STejun Heo 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1084797e8345STejun Heo 			       (unsigned long)work)
1085797e8345STejun Heo 		if (worker->current_work == work &&
1086797e8345STejun Heo 		    worker->current_func == work->func)
1087797e8345STejun Heo 			return worker;
1088797e8345STejun Heo 
1089797e8345STejun Heo 	return NULL;
1090797e8345STejun Heo }
1091797e8345STejun Heo 
1092797e8345STejun Heo /**
1093797e8345STejun Heo  * move_linked_works - move linked works to a list
1094797e8345STejun Heo  * @work: start of series of works to be scheduled
1095797e8345STejun Heo  * @head: target list to append @work to
1096797e8345STejun Heo  * @nextp: out parameter for nested worklist walking
1097797e8345STejun Heo  *
1098873eaca6STejun Heo  * Schedule linked works starting from @work to @head. Work series to be
1099873eaca6STejun Heo  * scheduled starts at @work and includes any consecutive work with
1100873eaca6STejun Heo  * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on
1101873eaca6STejun Heo  * @nextp.
1102797e8345STejun Heo  *
1103797e8345STejun Heo  * CONTEXT:
1104797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1105797e8345STejun Heo  */
1106797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1107797e8345STejun Heo 			      struct work_struct **nextp)
1108797e8345STejun Heo {
1109797e8345STejun Heo 	struct work_struct *n;
1110797e8345STejun Heo 
1111797e8345STejun Heo 	/*
1112797e8345STejun Heo 	 * Linked worklist will always end before the end of the list,
1113797e8345STejun Heo 	 * use NULL for list head.
1114797e8345STejun Heo 	 */
1115797e8345STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1116797e8345STejun Heo 		list_move_tail(&work->entry, head);
1117797e8345STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1118797e8345STejun Heo 			break;
1119797e8345STejun Heo 	}
1120797e8345STejun Heo 
1121797e8345STejun Heo 	/*
1122797e8345STejun Heo 	 * If we're already inside safe list traversal and have moved
1123797e8345STejun Heo 	 * multiple works to the scheduled queue, the next position
1124797e8345STejun Heo 	 * needs to be updated.
1125797e8345STejun Heo 	 */
1126797e8345STejun Heo 	if (nextp)
1127797e8345STejun Heo 		*nextp = n;
1128797e8345STejun Heo }
1129797e8345STejun Heo 
1130797e8345STejun Heo /**
1131873eaca6STejun Heo  * assign_work - assign a work item and its linked work items to a worker
1132873eaca6STejun Heo  * @work: work to assign
1133873eaca6STejun Heo  * @worker: worker to assign to
1134873eaca6STejun Heo  * @nextp: out parameter for nested worklist walking
1135873eaca6STejun Heo  *
1136873eaca6STejun Heo  * Assign @work and its linked work items to @worker. If @work is already being
1137873eaca6STejun Heo  * executed by another worker in the same pool, it'll be punted there.
1138873eaca6STejun Heo  *
1139873eaca6STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of the last
1140873eaca6STejun Heo  * scheduled work. This allows assign_work() to be nested inside
1141873eaca6STejun Heo  * list_for_each_entry_safe().
1142873eaca6STejun Heo  *
1143873eaca6STejun Heo  * Returns %true if @work was successfully assigned to @worker. %false if @work
1144873eaca6STejun Heo  * was punted to another worker already executing it.
1145873eaca6STejun Heo  */
1146873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker,
1147873eaca6STejun Heo 			struct work_struct **nextp)
1148873eaca6STejun Heo {
1149873eaca6STejun Heo 	struct worker_pool *pool = worker->pool;
1150873eaca6STejun Heo 	struct worker *collision;
1151873eaca6STejun Heo 
1152873eaca6STejun Heo 	lockdep_assert_held(&pool->lock);
1153873eaca6STejun Heo 
1154873eaca6STejun Heo 	/*
1155873eaca6STejun Heo 	 * A single work shouldn't be executed concurrently by multiple workers.
1156873eaca6STejun Heo 	 * __queue_work() ensures that @work doesn't jump to a different pool
1157873eaca6STejun Heo 	 * while still running in the previous pool. Here, we should ensure that
1158873eaca6STejun Heo 	 * @work is not executed concurrently by multiple workers from the same
1159873eaca6STejun Heo 	 * pool. Check whether anyone is already processing the work. If so,
1160873eaca6STejun Heo 	 * defer the work to the currently executing one.
1161873eaca6STejun Heo 	 */
1162873eaca6STejun Heo 	collision = find_worker_executing_work(pool, work);
1163873eaca6STejun Heo 	if (unlikely(collision)) {
1164873eaca6STejun Heo 		move_linked_works(work, &collision->scheduled, nextp);
1165873eaca6STejun Heo 		return false;
1166873eaca6STejun Heo 	}
1167873eaca6STejun Heo 
1168873eaca6STejun Heo 	move_linked_works(work, &worker->scheduled, nextp);
1169873eaca6STejun Heo 	return true;
1170873eaca6STejun Heo }
1171873eaca6STejun Heo 
1172873eaca6STejun Heo /**
11730219a352STejun Heo  * kick_pool - wake up an idle worker if necessary
11740219a352STejun Heo  * @pool: pool to kick
1175797e8345STejun Heo  *
11760219a352STejun Heo  * @pool may have pending work items. Wake up worker if necessary. Returns
11770219a352STejun Heo  * whether a worker was woken up.
1178797e8345STejun Heo  */
11790219a352STejun Heo static bool kick_pool(struct worker_pool *pool)
1180797e8345STejun Heo {
1181797e8345STejun Heo 	struct worker *worker = first_idle_worker(pool);
11828639ecebSTejun Heo 	struct task_struct *p;
1183797e8345STejun Heo 
11840219a352STejun Heo 	lockdep_assert_held(&pool->lock);
11850219a352STejun Heo 
11860219a352STejun Heo 	if (!need_more_worker(pool) || !worker)
11870219a352STejun Heo 		return false;
11880219a352STejun Heo 
11898639ecebSTejun Heo 	p = worker->task;
11908639ecebSTejun Heo 
11918639ecebSTejun Heo #ifdef CONFIG_SMP
11928639ecebSTejun Heo 	/*
11938639ecebSTejun Heo 	 * Idle @worker is about to execute @work and waking up provides an
11948639ecebSTejun Heo 	 * opportunity to migrate @worker at a lower cost by setting the task's
11958639ecebSTejun Heo 	 * wake_cpu field. Let's see if we want to move @worker to improve
11968639ecebSTejun Heo 	 * execution locality.
11978639ecebSTejun Heo 	 *
11988639ecebSTejun Heo 	 * We're waking the worker that went idle the latest and there's some
11998639ecebSTejun Heo 	 * chance that @worker is marked idle but hasn't gone off CPU yet. If
12008639ecebSTejun Heo 	 * so, setting the wake_cpu won't do anything. As this is a best-effort
12018639ecebSTejun Heo 	 * optimization and the race window is narrow, let's leave as-is for
12028639ecebSTejun Heo 	 * now. If this becomes pronounced, we can skip over workers which are
12038639ecebSTejun Heo 	 * still on cpu when picking an idle worker.
12048639ecebSTejun Heo 	 *
12058639ecebSTejun Heo 	 * If @pool has non-strict affinity, @worker might have ended up outside
12068639ecebSTejun Heo 	 * its affinity scope. Repatriate.
12078639ecebSTejun Heo 	 */
12088639ecebSTejun Heo 	if (!pool->attrs->affn_strict &&
12098639ecebSTejun Heo 	    !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) {
12108639ecebSTejun Heo 		struct work_struct *work = list_first_entry(&pool->worklist,
12118639ecebSTejun Heo 						struct work_struct, entry);
12128639ecebSTejun Heo 		p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask);
12138639ecebSTejun Heo 		get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++;
12148639ecebSTejun Heo 	}
12158639ecebSTejun Heo #endif
12168639ecebSTejun Heo 	wake_up_process(p);
12170219a352STejun Heo 	return true;
1218797e8345STejun Heo }
1219797e8345STejun Heo 
122063638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT
122163638450STejun Heo 
122263638450STejun Heo /*
122363638450STejun Heo  * Concurrency-managed per-cpu work items that hog CPU for longer than
122463638450STejun Heo  * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism,
122563638450STejun Heo  * which prevents them from stalling other concurrency-managed work items. If a
122663638450STejun Heo  * work function keeps triggering this mechanism, it's likely that the work item
122763638450STejun Heo  * should be using an unbound workqueue instead.
122863638450STejun Heo  *
122963638450STejun Heo  * wq_cpu_intensive_report() tracks work functions which trigger such conditions
123063638450STejun Heo  * and report them so that they can be examined and converted to use unbound
123163638450STejun Heo  * workqueues as appropriate. To avoid flooding the console, each violating work
123263638450STejun Heo  * function is tracked and reported with exponential backoff.
123363638450STejun Heo  */
123463638450STejun Heo #define WCI_MAX_ENTS 128
123563638450STejun Heo 
123663638450STejun Heo struct wci_ent {
123763638450STejun Heo 	work_func_t		func;
123863638450STejun Heo 	atomic64_t		cnt;
123963638450STejun Heo 	struct hlist_node	hash_node;
124063638450STejun Heo };
124163638450STejun Heo 
124263638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS];
124363638450STejun Heo static int wci_nr_ents;
124463638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock);
124563638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS));
124663638450STejun Heo 
124763638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func)
124863638450STejun Heo {
124963638450STejun Heo 	struct wci_ent *ent;
125063638450STejun Heo 
125163638450STejun Heo 	hash_for_each_possible_rcu(wci_hash, ent, hash_node,
125263638450STejun Heo 				   (unsigned long)func) {
125363638450STejun Heo 		if (ent->func == func)
125463638450STejun Heo 			return ent;
125563638450STejun Heo 	}
125663638450STejun Heo 	return NULL;
125763638450STejun Heo }
125863638450STejun Heo 
125963638450STejun Heo static void wq_cpu_intensive_report(work_func_t func)
126063638450STejun Heo {
126163638450STejun Heo 	struct wci_ent *ent;
126263638450STejun Heo 
126363638450STejun Heo restart:
126463638450STejun Heo 	ent = wci_find_ent(func);
126563638450STejun Heo 	if (ent) {
126663638450STejun Heo 		u64 cnt;
126763638450STejun Heo 
126863638450STejun Heo 		/*
126963638450STejun Heo 		 * Start reporting from the fourth time and back off
127063638450STejun Heo 		 * exponentially.
127163638450STejun Heo 		 */
127263638450STejun Heo 		cnt = atomic64_inc_return_relaxed(&ent->cnt);
127363638450STejun Heo 		if (cnt >= 4 && is_power_of_2(cnt))
127463638450STejun Heo 			printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n",
127563638450STejun Heo 					ent->func, wq_cpu_intensive_thresh_us,
127663638450STejun Heo 					atomic64_read(&ent->cnt));
127763638450STejun Heo 		return;
127863638450STejun Heo 	}
127963638450STejun Heo 
128063638450STejun Heo 	/*
128163638450STejun Heo 	 * @func is a new violation. Allocate a new entry for it. If wcn_ents[]
128263638450STejun Heo 	 * is exhausted, something went really wrong and we probably made enough
128363638450STejun Heo 	 * noise already.
128463638450STejun Heo 	 */
128563638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS)
128663638450STejun Heo 		return;
128763638450STejun Heo 
128863638450STejun Heo 	raw_spin_lock(&wci_lock);
128963638450STejun Heo 
129063638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS) {
129163638450STejun Heo 		raw_spin_unlock(&wci_lock);
129263638450STejun Heo 		return;
129363638450STejun Heo 	}
129463638450STejun Heo 
129563638450STejun Heo 	if (wci_find_ent(func)) {
129663638450STejun Heo 		raw_spin_unlock(&wci_lock);
129763638450STejun Heo 		goto restart;
129863638450STejun Heo 	}
129963638450STejun Heo 
130063638450STejun Heo 	ent = &wci_ents[wci_nr_ents++];
130163638450STejun Heo 	ent->func = func;
130263638450STejun Heo 	atomic64_set(&ent->cnt, 1);
130363638450STejun Heo 	hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func);
130463638450STejun Heo 
130563638450STejun Heo 	raw_spin_unlock(&wci_lock);
130663638450STejun Heo }
130763638450STejun Heo 
130863638450STejun Heo #else	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
130963638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {}
131063638450STejun Heo #endif	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
131163638450STejun Heo 
1312c54d5046STejun Heo /**
13131da177e4SLinus Torvalds  * wq_worker_running - a worker is running again
13141da177e4SLinus Torvalds  * @task: task waking up
13151da177e4SLinus Torvalds  *
13161da177e4SLinus Torvalds  * This function is called when a worker returns from schedule()
13171da177e4SLinus Torvalds  */
13181da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task)
13191da177e4SLinus Torvalds {
13201da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
13211da177e4SLinus Torvalds 
1322c8f6219bSZqiang 	if (!READ_ONCE(worker->sleeping))
13231da177e4SLinus Torvalds 		return;
13241da177e4SLinus Torvalds 
13251da177e4SLinus Torvalds 	/*
13261da177e4SLinus Torvalds 	 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
13271da177e4SLinus Torvalds 	 * and the nr_running increment below, we may ruin the nr_running reset
13281da177e4SLinus Torvalds 	 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
13291da177e4SLinus Torvalds 	 * pool. Protect against such race.
13301da177e4SLinus Torvalds 	 */
13311da177e4SLinus Torvalds 	preempt_disable();
13321da177e4SLinus Torvalds 	if (!(worker->flags & WORKER_NOT_RUNNING))
13331da177e4SLinus Torvalds 		worker->pool->nr_running++;
13341da177e4SLinus Torvalds 	preempt_enable();
1335616db877STejun Heo 
1336616db877STejun Heo 	/*
1337616db877STejun Heo 	 * CPU intensive auto-detection cares about how long a work item hogged
1338616db877STejun Heo 	 * CPU without sleeping. Reset the starting timestamp on wakeup.
1339616db877STejun Heo 	 */
1340616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
1341616db877STejun Heo 
1342c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 0);
13431da177e4SLinus Torvalds }
13441da177e4SLinus Torvalds 
13451da177e4SLinus Torvalds /**
13461da177e4SLinus Torvalds  * wq_worker_sleeping - a worker is going to sleep
13471da177e4SLinus Torvalds  * @task: task going to sleep
13481da177e4SLinus Torvalds  *
13491da177e4SLinus Torvalds  * This function is called from schedule() when a busy worker is
13501da177e4SLinus Torvalds  * going to sleep.
13511da177e4SLinus Torvalds  */
13521da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task)
13531da177e4SLinus Torvalds {
13541da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
13551da177e4SLinus Torvalds 	struct worker_pool *pool;
13561da177e4SLinus Torvalds 
13571da177e4SLinus Torvalds 	/*
13581da177e4SLinus Torvalds 	 * Rescuers, which may not have all the fields set up like normal
13591da177e4SLinus Torvalds 	 * workers, also reach here, let's not access anything before
13601da177e4SLinus Torvalds 	 * checking NOT_RUNNING.
13611da177e4SLinus Torvalds 	 */
13621da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING)
13631da177e4SLinus Torvalds 		return;
13641da177e4SLinus Torvalds 
13651da177e4SLinus Torvalds 	pool = worker->pool;
13661da177e4SLinus Torvalds 
13671da177e4SLinus Torvalds 	/* Return if preempted before wq_worker_running() was reached */
1368c8f6219bSZqiang 	if (READ_ONCE(worker->sleeping))
13691da177e4SLinus Torvalds 		return;
13701da177e4SLinus Torvalds 
1371c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 1);
13721da177e4SLinus Torvalds 	raw_spin_lock_irq(&pool->lock);
13731da177e4SLinus Torvalds 
13741da177e4SLinus Torvalds 	/*
13751da177e4SLinus Torvalds 	 * Recheck in case unbind_workers() preempted us. We don't
13761da177e4SLinus Torvalds 	 * want to decrement nr_running after the worker is unbound
13771da177e4SLinus Torvalds 	 * and nr_running has been reset.
13781da177e4SLinus Torvalds 	 */
13791da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING) {
13801da177e4SLinus Torvalds 		raw_spin_unlock_irq(&pool->lock);
13811da177e4SLinus Torvalds 		return;
13821da177e4SLinus Torvalds 	}
13831da177e4SLinus Torvalds 
13841da177e4SLinus Torvalds 	pool->nr_running--;
13850219a352STejun Heo 	if (kick_pool(pool))
1386725e8ec5STejun Heo 		worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++;
13870219a352STejun Heo 
13881da177e4SLinus Torvalds 	raw_spin_unlock_irq(&pool->lock);
13891da177e4SLinus Torvalds }
13901da177e4SLinus Torvalds 
13911da177e4SLinus Torvalds /**
1392616db877STejun Heo  * wq_worker_tick - a scheduler tick occurred while a kworker is running
1393616db877STejun Heo  * @task: task currently running
1394616db877STejun Heo  *
1395616db877STejun Heo  * Called from scheduler_tick(). We're in the IRQ context and the current
1396616db877STejun Heo  * worker's fields which follow the 'K' locking rule can be accessed safely.
1397616db877STejun Heo  */
1398616db877STejun Heo void wq_worker_tick(struct task_struct *task)
1399616db877STejun Heo {
1400616db877STejun Heo 	struct worker *worker = kthread_data(task);
1401616db877STejun Heo 	struct pool_workqueue *pwq = worker->current_pwq;
1402616db877STejun Heo 	struct worker_pool *pool = worker->pool;
1403616db877STejun Heo 
1404616db877STejun Heo 	if (!pwq)
1405616db877STejun Heo 		return;
1406616db877STejun Heo 
14078a1dd1e5STejun Heo 	pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC;
14088a1dd1e5STejun Heo 
140918c8ae81SZqiang 	if (!wq_cpu_intensive_thresh_us)
141018c8ae81SZqiang 		return;
141118c8ae81SZqiang 
1412616db877STejun Heo 	/*
1413616db877STejun Heo 	 * If the current worker is concurrency managed and hogged the CPU for
1414616db877STejun Heo 	 * longer than wq_cpu_intensive_thresh_us, it's automatically marked
1415616db877STejun Heo 	 * CPU_INTENSIVE to avoid stalling other concurrency-managed work items.
1416c8f6219bSZqiang 	 *
1417c8f6219bSZqiang 	 * Set @worker->sleeping means that @worker is in the process of
1418c8f6219bSZqiang 	 * switching out voluntarily and won't be contributing to
1419c8f6219bSZqiang 	 * @pool->nr_running until it wakes up. As wq_worker_sleeping() also
1420c8f6219bSZqiang 	 * decrements ->nr_running, setting CPU_INTENSIVE here can lead to
1421c8f6219bSZqiang 	 * double decrements. The task is releasing the CPU anyway. Let's skip.
1422c8f6219bSZqiang 	 * We probably want to make this prettier in the future.
1423616db877STejun Heo 	 */
1424c8f6219bSZqiang 	if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) ||
1425616db877STejun Heo 	    worker->task->se.sum_exec_runtime - worker->current_at <
1426616db877STejun Heo 	    wq_cpu_intensive_thresh_us * NSEC_PER_USEC)
1427616db877STejun Heo 		return;
1428616db877STejun Heo 
1429616db877STejun Heo 	raw_spin_lock(&pool->lock);
1430616db877STejun Heo 
1431616db877STejun Heo 	worker_set_flags(worker, WORKER_CPU_INTENSIVE);
143263638450STejun Heo 	wq_cpu_intensive_report(worker->current_func);
1433616db877STejun Heo 	pwq->stats[PWQ_STAT_CPU_INTENSIVE]++;
1434616db877STejun Heo 
14350219a352STejun Heo 	if (kick_pool(pool))
1436616db877STejun Heo 		pwq->stats[PWQ_STAT_CM_WAKEUP]++;
1437616db877STejun Heo 
1438616db877STejun Heo 	raw_spin_unlock(&pool->lock);
1439616db877STejun Heo }
1440616db877STejun Heo 
1441616db877STejun Heo /**
14421da177e4SLinus Torvalds  * wq_worker_last_func - retrieve worker's last work function
14431da177e4SLinus Torvalds  * @task: Task to retrieve last work function of.
14441da177e4SLinus Torvalds  *
14451da177e4SLinus Torvalds  * Determine the last function a worker executed. This is called from
14461da177e4SLinus Torvalds  * the scheduler to get a worker's last known identity.
14471da177e4SLinus Torvalds  *
14481da177e4SLinus Torvalds  * CONTEXT:
14499b41ea72SAndrew Morton  * raw_spin_lock_irq(rq->lock)
14501da177e4SLinus Torvalds  *
14511da177e4SLinus Torvalds  * This function is called during schedule() when a kworker is going
1452f756d5e2SNathan Lynch  * to sleep. It's used by psi to identify aggregation workers during
1453f756d5e2SNathan Lynch  * dequeuing, to allow periodic aggregation to shut-off when that
14541da177e4SLinus Torvalds  * worker is the last task in the system or cgroup to go to sleep.
14551da177e4SLinus Torvalds  *
14561da177e4SLinus Torvalds  * As this function doesn't involve any workqueue-related locking, it
14571da177e4SLinus Torvalds  * only returns stable values when called from inside the scheduler's
14581da177e4SLinus Torvalds  * queuing and dequeuing paths, when @task, which must be a kworker,
14591da177e4SLinus Torvalds  * is guaranteed to not be processing any works.
1460365970a1SDavid Howells  *
1461365970a1SDavid Howells  * Return:
1462365970a1SDavid Howells  * The last work function %current executed as a worker, NULL if it
1463365970a1SDavid Howells  * hasn't executed any work yet.
1464365970a1SDavid Howells  */
1465365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task)
1466365970a1SDavid Howells {
1467365970a1SDavid Howells 	struct worker *worker = kthread_data(task);
1468365970a1SDavid Howells 
1469365970a1SDavid Howells 	return worker->last_func;
1470365970a1SDavid Howells }
1471365970a1SDavid Howells 
1472d302f017STejun Heo /**
147391ccc6e7STejun Heo  * wq_node_nr_active - Determine wq_node_nr_active to use
147491ccc6e7STejun Heo  * @wq: workqueue of interest
147591ccc6e7STejun Heo  * @node: NUMA node, can be %NUMA_NO_NODE
147691ccc6e7STejun Heo  *
147791ccc6e7STejun Heo  * Determine wq_node_nr_active to use for @wq on @node. Returns:
147891ccc6e7STejun Heo  *
147991ccc6e7STejun Heo  * - %NULL for per-cpu workqueues as they don't need to use shared nr_active.
148091ccc6e7STejun Heo  *
148191ccc6e7STejun Heo  * - node_nr_active[nr_node_ids] if @node is %NUMA_NO_NODE.
148291ccc6e7STejun Heo  *
148391ccc6e7STejun Heo  * - Otherwise, node_nr_active[@node].
148491ccc6e7STejun Heo  */
148591ccc6e7STejun Heo static struct wq_node_nr_active *wq_node_nr_active(struct workqueue_struct *wq,
148691ccc6e7STejun Heo 						   int node)
148791ccc6e7STejun Heo {
148891ccc6e7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
148991ccc6e7STejun Heo 		return NULL;
149091ccc6e7STejun Heo 
149191ccc6e7STejun Heo 	if (node == NUMA_NO_NODE)
149291ccc6e7STejun Heo 		node = nr_node_ids;
149391ccc6e7STejun Heo 
149491ccc6e7STejun Heo 	return wq->node_nr_active[node];
149591ccc6e7STejun Heo }
149691ccc6e7STejun Heo 
149791ccc6e7STejun Heo /**
14985797b1c1STejun Heo  * wq_update_node_max_active - Update per-node max_actives to use
14995797b1c1STejun Heo  * @wq: workqueue to update
15005797b1c1STejun Heo  * @off_cpu: CPU that's going down, -1 if a CPU is not going down
15015797b1c1STejun Heo  *
15025797b1c1STejun Heo  * Update @wq->node_nr_active[]->max. @wq must be unbound. max_active is
15035797b1c1STejun Heo  * distributed among nodes according to the proportions of numbers of online
15045797b1c1STejun Heo  * cpus. The result is always between @wq->min_active and max_active.
15055797b1c1STejun Heo  */
15065797b1c1STejun Heo static void wq_update_node_max_active(struct workqueue_struct *wq, int off_cpu)
15075797b1c1STejun Heo {
15085797b1c1STejun Heo 	struct cpumask *effective = unbound_effective_cpumask(wq);
15095797b1c1STejun Heo 	int min_active = READ_ONCE(wq->min_active);
15105797b1c1STejun Heo 	int max_active = READ_ONCE(wq->max_active);
15115797b1c1STejun Heo 	int total_cpus, node;
15125797b1c1STejun Heo 
15135797b1c1STejun Heo 	lockdep_assert_held(&wq->mutex);
15145797b1c1STejun Heo 
1515c5f8cd6cSTejun Heo 	if (!wq_topo_initialized)
1516c5f8cd6cSTejun Heo 		return;
1517c5f8cd6cSTejun Heo 
151815930da4STejun Heo 	if (off_cpu >= 0 && !cpumask_test_cpu(off_cpu, effective))
15195797b1c1STejun Heo 		off_cpu = -1;
15205797b1c1STejun Heo 
15215797b1c1STejun Heo 	total_cpus = cpumask_weight_and(effective, cpu_online_mask);
15225797b1c1STejun Heo 	if (off_cpu >= 0)
15235797b1c1STejun Heo 		total_cpus--;
15245797b1c1STejun Heo 
15255797b1c1STejun Heo 	for_each_node(node) {
15265797b1c1STejun Heo 		int node_cpus;
15275797b1c1STejun Heo 
15285797b1c1STejun Heo 		node_cpus = cpumask_weight_and(effective, cpumask_of_node(node));
15295797b1c1STejun Heo 		if (off_cpu >= 0 && cpu_to_node(off_cpu) == node)
15305797b1c1STejun Heo 			node_cpus--;
15315797b1c1STejun Heo 
15325797b1c1STejun Heo 		wq_node_nr_active(wq, node)->max =
15335797b1c1STejun Heo 			clamp(DIV_ROUND_UP(max_active * node_cpus, total_cpus),
15345797b1c1STejun Heo 			      min_active, max_active);
15355797b1c1STejun Heo 	}
15365797b1c1STejun Heo 
15375797b1c1STejun Heo 	wq_node_nr_active(wq, NUMA_NO_NODE)->max = min_active;
15385797b1c1STejun Heo }
15395797b1c1STejun Heo 
15405797b1c1STejun Heo /**
15418864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
15428864b4e5STejun Heo  * @pwq: pool_workqueue to get
15438864b4e5STejun Heo  *
15448864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
15458864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
15468864b4e5STejun Heo  */
15478864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
15488864b4e5STejun Heo {
15498864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
15508864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
15518864b4e5STejun Heo 	pwq->refcnt++;
15528864b4e5STejun Heo }
15538864b4e5STejun Heo 
15548864b4e5STejun Heo /**
15558864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
15568864b4e5STejun Heo  * @pwq: pool_workqueue to put
15578864b4e5STejun Heo  *
15588864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
15598864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
15608864b4e5STejun Heo  */
15618864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
15628864b4e5STejun Heo {
15638864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
15648864b4e5STejun Heo 	if (likely(--pwq->refcnt))
15658864b4e5STejun Heo 		return;
15668864b4e5STejun Heo 	/*
1567967b494eSTejun Heo 	 * @pwq can't be released under pool->lock, bounce to a dedicated
1568967b494eSTejun Heo 	 * kthread_worker to avoid A-A deadlocks.
15698864b4e5STejun Heo 	 */
1570687a9aa5STejun Heo 	kthread_queue_work(pwq_release_worker, &pwq->release_work);
15718864b4e5STejun Heo }
15728864b4e5STejun Heo 
1573dce90d47STejun Heo /**
1574dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1575dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1576dce90d47STejun Heo  *
1577dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1578dce90d47STejun Heo  */
1579dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1580dce90d47STejun Heo {
1581dce90d47STejun Heo 	if (pwq) {
1582dce90d47STejun Heo 		/*
158324acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1584dce90d47STejun Heo 		 * following lock operations are safe.
1585dce90d47STejun Heo 		 */
1586a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
1587dce90d47STejun Heo 		put_pwq(pwq);
1588a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
1589dce90d47STejun Heo 	}
1590dce90d47STejun Heo }
1591dce90d47STejun Heo 
1592afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq)
1593afa87ce8STejun Heo {
1594afa87ce8STejun Heo 	return !pwq->nr_active && list_empty(&pwq->inactive_works);
1595afa87ce8STejun Heo }
1596afa87ce8STejun Heo 
15974c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq,
15984c638030STejun Heo 				struct work_struct *work)
1599bf4ede01STejun Heo {
16001c270b79STejun Heo 	unsigned long *wdb = work_data_bits(work);
16011c270b79STejun Heo 
16021c270b79STejun Heo 	WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE));
1603bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
160482607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
160582607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1606112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
16071c270b79STejun Heo 	__clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb);
16084c638030STejun Heo }
16094c638030STejun Heo 
16104c638030STejun Heo /**
16114c638030STejun Heo  * pwq_activate_work - Activate a work item if inactive
16124c638030STejun Heo  * @pwq: pool_workqueue @work belongs to
16134c638030STejun Heo  * @work: work item to activate
16144c638030STejun Heo  *
16154c638030STejun Heo  * Returns %true if activated. %false if already active.
16164c638030STejun Heo  */
16174c638030STejun Heo static bool pwq_activate_work(struct pool_workqueue *pwq,
16184c638030STejun Heo 			      struct work_struct *work)
16194c638030STejun Heo {
16204c638030STejun Heo 	struct worker_pool *pool = pwq->pool;
162191ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
16224c638030STejun Heo 
16234c638030STejun Heo 	lockdep_assert_held(&pool->lock);
16244c638030STejun Heo 
16254c638030STejun Heo 	if (!(*work_data_bits(work) & WORK_STRUCT_INACTIVE))
16264c638030STejun Heo 		return false;
16274c638030STejun Heo 
162891ccc6e7STejun Heo 	nna = wq_node_nr_active(pwq->wq, pool->node);
162991ccc6e7STejun Heo 	if (nna)
163091ccc6e7STejun Heo 		atomic_inc(&nna->nr);
163191ccc6e7STejun Heo 
1632112202d9STejun Heo 	pwq->nr_active++;
16334c638030STejun Heo 	__pwq_activate_work(pwq, work);
16344c638030STejun Heo 	return true;
1635bf4ede01STejun Heo }
1636bf4ede01STejun Heo 
16375797b1c1STejun Heo static bool tryinc_node_nr_active(struct wq_node_nr_active *nna)
16385797b1c1STejun Heo {
16395797b1c1STejun Heo 	int max = READ_ONCE(nna->max);
16405797b1c1STejun Heo 
16415797b1c1STejun Heo 	while (true) {
16425797b1c1STejun Heo 		int old, tmp;
16435797b1c1STejun Heo 
16445797b1c1STejun Heo 		old = atomic_read(&nna->nr);
16455797b1c1STejun Heo 		if (old >= max)
16465797b1c1STejun Heo 			return false;
16475797b1c1STejun Heo 		tmp = atomic_cmpxchg_relaxed(&nna->nr, old, old + 1);
16485797b1c1STejun Heo 		if (tmp == old)
16495797b1c1STejun Heo 			return true;
16505797b1c1STejun Heo 	}
16515797b1c1STejun Heo }
16525797b1c1STejun Heo 
16531c270b79STejun Heo /**
16541c270b79STejun Heo  * pwq_tryinc_nr_active - Try to increment nr_active for a pwq
16551c270b79STejun Heo  * @pwq: pool_workqueue of interest
16565797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
16571c270b79STejun Heo  *
16581c270b79STejun Heo  * Try to increment nr_active for @pwq. Returns %true if an nr_active count is
16591c270b79STejun Heo  * successfully obtained. %false otherwise.
16601c270b79STejun Heo  */
16615797b1c1STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq, bool fill)
16623aa62497SLai Jiangshan {
16631c270b79STejun Heo 	struct workqueue_struct *wq = pwq->wq;
16641c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
166591ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(wq, pool->node);
16665797b1c1STejun Heo 	bool obtained = false;
16671c270b79STejun Heo 
16681c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
16691c270b79STejun Heo 
16705797b1c1STejun Heo 	if (!nna) {
16715797b1c1STejun Heo 		/* per-cpu workqueue, pwq->nr_active is sufficient */
16721c270b79STejun Heo 		obtained = pwq->nr_active < READ_ONCE(wq->max_active);
16735797b1c1STejun Heo 		goto out;
167491ccc6e7STejun Heo 	}
16755797b1c1STejun Heo 
16765797b1c1STejun Heo 	/*
16775797b1c1STejun Heo 	 * Unbound workqueue uses per-node shared nr_active $nna. If @pwq is
16785797b1c1STejun Heo 	 * already waiting on $nna, pwq_dec_nr_active() will maintain the
16795797b1c1STejun Heo 	 * concurrency level. Don't jump the line.
16805797b1c1STejun Heo 	 *
16815797b1c1STejun Heo 	 * We need to ignore the pending test after max_active has increased as
16825797b1c1STejun Heo 	 * pwq_dec_nr_active() can only maintain the concurrency level but not
16835797b1c1STejun Heo 	 * increase it. This is indicated by @fill.
16845797b1c1STejun Heo 	 */
16855797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node) && likely(!fill))
16865797b1c1STejun Heo 		goto out;
16875797b1c1STejun Heo 
16885797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
16895797b1c1STejun Heo 	if (obtained)
16905797b1c1STejun Heo 		goto out;
16915797b1c1STejun Heo 
16925797b1c1STejun Heo 	/*
16935797b1c1STejun Heo 	 * Lockless acquisition failed. Lock, add ourself to $nna->pending_pwqs
16945797b1c1STejun Heo 	 * and try again. The smp_mb() is paired with the implied memory barrier
16955797b1c1STejun Heo 	 * of atomic_dec_return() in pwq_dec_nr_active() to ensure that either
16965797b1c1STejun Heo 	 * we see the decremented $nna->nr or they see non-empty
16975797b1c1STejun Heo 	 * $nna->pending_pwqs.
16985797b1c1STejun Heo 	 */
16995797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
17005797b1c1STejun Heo 
17015797b1c1STejun Heo 	if (list_empty(&pwq->pending_node))
17025797b1c1STejun Heo 		list_add_tail(&pwq->pending_node, &nna->pending_pwqs);
17035797b1c1STejun Heo 	else if (likely(!fill))
17045797b1c1STejun Heo 		goto out_unlock;
17055797b1c1STejun Heo 
17065797b1c1STejun Heo 	smp_mb();
17075797b1c1STejun Heo 
17085797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17095797b1c1STejun Heo 
17105797b1c1STejun Heo 	/*
17115797b1c1STejun Heo 	 * If @fill, @pwq might have already been pending. Being spuriously
17125797b1c1STejun Heo 	 * pending in cold paths doesn't affect anything. Let's leave it be.
17135797b1c1STejun Heo 	 */
17145797b1c1STejun Heo 	if (obtained && likely(!fill))
17155797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
17165797b1c1STejun Heo 
17175797b1c1STejun Heo out_unlock:
17185797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
17195797b1c1STejun Heo out:
17205797b1c1STejun Heo 	if (obtained)
17215797b1c1STejun Heo 		pwq->nr_active++;
17221c270b79STejun Heo 	return obtained;
17231c270b79STejun Heo }
17241c270b79STejun Heo 
17251c270b79STejun Heo /**
17261c270b79STejun Heo  * pwq_activate_first_inactive - Activate the first inactive work item on a pwq
17271c270b79STejun Heo  * @pwq: pool_workqueue of interest
17285797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
17291c270b79STejun Heo  *
17301c270b79STejun Heo  * Activate the first inactive work item of @pwq if available and allowed by
17311c270b79STejun Heo  * max_active limit.
17321c270b79STejun Heo  *
17331c270b79STejun Heo  * Returns %true if an inactive work item has been activated. %false if no
17341c270b79STejun Heo  * inactive work item is found or max_active limit is reached.
17351c270b79STejun Heo  */
17365797b1c1STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq, bool fill)
17371c270b79STejun Heo {
17381c270b79STejun Heo 	struct work_struct *work =
17391c270b79STejun Heo 		list_first_entry_or_null(&pwq->inactive_works,
17403aa62497SLai Jiangshan 					 struct work_struct, entry);
17413aa62497SLai Jiangshan 
17425797b1c1STejun Heo 	if (work && pwq_tryinc_nr_active(pwq, fill)) {
17431c270b79STejun Heo 		__pwq_activate_work(pwq, work);
17441c270b79STejun Heo 		return true;
17451c270b79STejun Heo 	} else {
17461c270b79STejun Heo 		return false;
17471c270b79STejun Heo 	}
17481c270b79STejun Heo }
17491c270b79STejun Heo 
17501c270b79STejun Heo /**
17515797b1c1STejun Heo  * node_activate_pending_pwq - Activate a pending pwq on a wq_node_nr_active
17525797b1c1STejun Heo  * @nna: wq_node_nr_active to activate a pending pwq for
17535797b1c1STejun Heo  * @caller_pool: worker_pool the caller is locking
17545797b1c1STejun Heo  *
17555797b1c1STejun Heo  * Activate a pwq in @nna->pending_pwqs. Called with @caller_pool locked.
17565797b1c1STejun Heo  * @caller_pool may be unlocked and relocked to lock other worker_pools.
17575797b1c1STejun Heo  */
17585797b1c1STejun Heo static void node_activate_pending_pwq(struct wq_node_nr_active *nna,
17595797b1c1STejun Heo 				      struct worker_pool *caller_pool)
17605797b1c1STejun Heo {
17615797b1c1STejun Heo 	struct worker_pool *locked_pool = caller_pool;
17625797b1c1STejun Heo 	struct pool_workqueue *pwq;
17635797b1c1STejun Heo 	struct work_struct *work;
17645797b1c1STejun Heo 
17655797b1c1STejun Heo 	lockdep_assert_held(&caller_pool->lock);
17665797b1c1STejun Heo 
17675797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
17685797b1c1STejun Heo retry:
17695797b1c1STejun Heo 	pwq = list_first_entry_or_null(&nna->pending_pwqs,
17705797b1c1STejun Heo 				       struct pool_workqueue, pending_node);
17715797b1c1STejun Heo 	if (!pwq)
17725797b1c1STejun Heo 		goto out_unlock;
17735797b1c1STejun Heo 
17745797b1c1STejun Heo 	/*
17755797b1c1STejun Heo 	 * If @pwq is for a different pool than @locked_pool, we need to lock
17765797b1c1STejun Heo 	 * @pwq->pool->lock. Let's trylock first. If unsuccessful, do the unlock
17775797b1c1STejun Heo 	 * / lock dance. For that, we also need to release @nna->lock as it's
17785797b1c1STejun Heo 	 * nested inside pool locks.
17795797b1c1STejun Heo 	 */
17805797b1c1STejun Heo 	if (pwq->pool != locked_pool) {
17815797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
17825797b1c1STejun Heo 		locked_pool = pwq->pool;
17835797b1c1STejun Heo 		if (!raw_spin_trylock(&locked_pool->lock)) {
17845797b1c1STejun Heo 			raw_spin_unlock(&nna->lock);
17855797b1c1STejun Heo 			raw_spin_lock(&locked_pool->lock);
17865797b1c1STejun Heo 			raw_spin_lock(&nna->lock);
17875797b1c1STejun Heo 			goto retry;
17885797b1c1STejun Heo 		}
17895797b1c1STejun Heo 	}
17905797b1c1STejun Heo 
17915797b1c1STejun Heo 	/*
17925797b1c1STejun Heo 	 * $pwq may not have any inactive work items due to e.g. cancellations.
17935797b1c1STejun Heo 	 * Drop it from pending_pwqs and see if there's another one.
17945797b1c1STejun Heo 	 */
17955797b1c1STejun Heo 	work = list_first_entry_or_null(&pwq->inactive_works,
17965797b1c1STejun Heo 					struct work_struct, entry);
17975797b1c1STejun Heo 	if (!work) {
17985797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
17995797b1c1STejun Heo 		goto retry;
18005797b1c1STejun Heo 	}
18015797b1c1STejun Heo 
18025797b1c1STejun Heo 	/*
18035797b1c1STejun Heo 	 * Acquire an nr_active count and activate the inactive work item. If
18045797b1c1STejun Heo 	 * $pwq still has inactive work items, rotate it to the end of the
18055797b1c1STejun Heo 	 * pending_pwqs so that we round-robin through them. This means that
18065797b1c1STejun Heo 	 * inactive work items are not activated in queueing order which is fine
18075797b1c1STejun Heo 	 * given that there has never been any ordering across different pwqs.
18085797b1c1STejun Heo 	 */
18095797b1c1STejun Heo 	if (likely(tryinc_node_nr_active(nna))) {
18105797b1c1STejun Heo 		pwq->nr_active++;
18115797b1c1STejun Heo 		__pwq_activate_work(pwq, work);
18125797b1c1STejun Heo 
18135797b1c1STejun Heo 		if (list_empty(&pwq->inactive_works))
18145797b1c1STejun Heo 			list_del_init(&pwq->pending_node);
18155797b1c1STejun Heo 		else
18165797b1c1STejun Heo 			list_move_tail(&pwq->pending_node, &nna->pending_pwqs);
18175797b1c1STejun Heo 
18185797b1c1STejun Heo 		/* if activating a foreign pool, make sure it's running */
18195797b1c1STejun Heo 		if (pwq->pool != caller_pool)
18205797b1c1STejun Heo 			kick_pool(pwq->pool);
18215797b1c1STejun Heo 	}
18225797b1c1STejun Heo 
18235797b1c1STejun Heo out_unlock:
18245797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
18255797b1c1STejun Heo 	if (locked_pool != caller_pool) {
18265797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
18275797b1c1STejun Heo 		raw_spin_lock(&caller_pool->lock);
18285797b1c1STejun Heo 	}
18295797b1c1STejun Heo }
18305797b1c1STejun Heo 
18315797b1c1STejun Heo /**
18321c270b79STejun Heo  * pwq_dec_nr_active - Retire an active count
18331c270b79STejun Heo  * @pwq: pool_workqueue of interest
18341c270b79STejun Heo  *
18351c270b79STejun Heo  * Decrement @pwq's nr_active and try to activate the first inactive work item.
18365797b1c1STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock.
18371c270b79STejun Heo  */
18381c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq)
18391c270b79STejun Heo {
18401c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
184191ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(pwq->wq, pool->node);
18421c270b79STejun Heo 
18431c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
18441c270b79STejun Heo 
184591ccc6e7STejun Heo 	/*
184691ccc6e7STejun Heo 	 * @pwq->nr_active should be decremented for both percpu and unbound
184791ccc6e7STejun Heo 	 * workqueues.
184891ccc6e7STejun Heo 	 */
18491c270b79STejun Heo 	pwq->nr_active--;
185091ccc6e7STejun Heo 
185191ccc6e7STejun Heo 	/*
185291ccc6e7STejun Heo 	 * For a percpu workqueue, it's simple. Just need to kick the first
185391ccc6e7STejun Heo 	 * inactive work item on @pwq itself.
185491ccc6e7STejun Heo 	 */
185591ccc6e7STejun Heo 	if (!nna) {
18565797b1c1STejun Heo 		pwq_activate_first_inactive(pwq, false);
185791ccc6e7STejun Heo 		return;
185891ccc6e7STejun Heo 	}
185991ccc6e7STejun Heo 
18605797b1c1STejun Heo 	/*
18615797b1c1STejun Heo 	 * If @pwq is for an unbound workqueue, it's more complicated because
18625797b1c1STejun Heo 	 * multiple pwqs and pools may be sharing the nr_active count. When a
18635797b1c1STejun Heo 	 * pwq needs to wait for an nr_active count, it puts itself on
18645797b1c1STejun Heo 	 * $nna->pending_pwqs. The following atomic_dec_return()'s implied
18655797b1c1STejun Heo 	 * memory barrier is paired with smp_mb() in pwq_tryinc_nr_active() to
18665797b1c1STejun Heo 	 * guarantee that either we see non-empty pending_pwqs or they see
18675797b1c1STejun Heo 	 * decremented $nna->nr.
18685797b1c1STejun Heo 	 *
18695797b1c1STejun Heo 	 * $nna->max may change as CPUs come online/offline and @pwq->wq's
18705797b1c1STejun Heo 	 * max_active gets updated. However, it is guaranteed to be equal to or
18715797b1c1STejun Heo 	 * larger than @pwq->wq->min_active which is above zero unless freezing.
18725797b1c1STejun Heo 	 * This maintains the forward progress guarantee.
18735797b1c1STejun Heo 	 */
18745797b1c1STejun Heo 	if (atomic_dec_return(&nna->nr) >= READ_ONCE(nna->max))
18755797b1c1STejun Heo 		return;
18765797b1c1STejun Heo 
18775797b1c1STejun Heo 	if (!list_empty(&nna->pending_pwqs))
18785797b1c1STejun Heo 		node_activate_pending_pwq(nna, pool);
18793aa62497SLai Jiangshan }
18803aa62497SLai Jiangshan 
1881bf4ede01STejun Heo /**
1882112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1883112202d9STejun Heo  * @pwq: pwq of interest
1884c4560c2cSLai Jiangshan  * @work_data: work_data of work which left the queue
1885bf4ede01STejun Heo  *
1886bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1887112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1888bf4ede01STejun Heo  *
1889dd6c3c54STejun Heo  * NOTE:
1890dd6c3c54STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock
1891dd6c3c54STejun Heo  * and thus should be called after all other state updates for the in-flight
1892dd6c3c54STejun Heo  * work item is complete.
1893dd6c3c54STejun Heo  *
1894bf4ede01STejun Heo  * CONTEXT:
1895a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1896bf4ede01STejun Heo  */
1897c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
1898bf4ede01STejun Heo {
1899c4560c2cSLai Jiangshan 	int color = get_work_color(work_data);
1900c4560c2cSLai Jiangshan 
19011c270b79STejun Heo 	if (!(work_data & WORK_STRUCT_INACTIVE))
19021c270b79STejun Heo 		pwq_dec_nr_active(pwq);
1903018f3a13SLai Jiangshan 
1904018f3a13SLai Jiangshan 	pwq->nr_in_flight[color]--;
1905bf4ede01STejun Heo 
1906bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1907112202d9STejun Heo 	if (likely(pwq->flush_color != color))
19088864b4e5STejun Heo 		goto out_put;
1909bf4ede01STejun Heo 
1910bf4ede01STejun Heo 	/* are there still in-flight works? */
1911112202d9STejun Heo 	if (pwq->nr_in_flight[color])
19128864b4e5STejun Heo 		goto out_put;
1913bf4ede01STejun Heo 
1914112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1915112202d9STejun Heo 	pwq->flush_color = -1;
1916bf4ede01STejun Heo 
1917bf4ede01STejun Heo 	/*
1918112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1919bf4ede01STejun Heo 	 * will handle the rest.
1920bf4ede01STejun Heo 	 */
1921112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1922112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
19238864b4e5STejun Heo out_put:
19248864b4e5STejun Heo 	put_pwq(pwq);
1925bf4ede01STejun Heo }
1926bf4ede01STejun Heo 
192736e227d2STejun Heo /**
1928bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
192936e227d2STejun Heo  * @work: work item to steal
193036e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1931bbb68dfaSTejun Heo  * @flags: place to store irq state
193236e227d2STejun Heo  *
193336e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1934d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
193536e227d2STejun Heo  *
1936d185af30SYacine Belkadi  * Return:
19373eb6b31bSMauro Carvalho Chehab  *
19383eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
193936e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
194036e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
194136e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1942bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1943bbb68dfaSTejun Heo  *		for arbitrarily long
19443eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
194536e227d2STejun Heo  *
1946d185af30SYacine Belkadi  * Note:
1947bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1948e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1949e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1950e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1951bbb68dfaSTejun Heo  *
1952bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1953bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1954bbb68dfaSTejun Heo  *
1955e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1956bf4ede01STejun Heo  */
1957bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1958bbb68dfaSTejun Heo 			       unsigned long *flags)
1959bf4ede01STejun Heo {
1960d565ed63STejun Heo 	struct worker_pool *pool;
1961112202d9STejun Heo 	struct pool_workqueue *pwq;
1962bf4ede01STejun Heo 
1963bbb68dfaSTejun Heo 	local_irq_save(*flags);
1964bbb68dfaSTejun Heo 
196536e227d2STejun Heo 	/* try to steal the timer if it exists */
196636e227d2STejun Heo 	if (is_dwork) {
196736e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
196836e227d2STejun Heo 
1969e0aecdd8STejun Heo 		/*
1970e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1971e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1972e0aecdd8STejun Heo 		 * running on the local CPU.
1973e0aecdd8STejun Heo 		 */
197436e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
197536e227d2STejun Heo 			return 1;
197636e227d2STejun Heo 	}
197736e227d2STejun Heo 
197836e227d2STejun Heo 	/* try to claim PENDING the normal way */
1979bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1980bf4ede01STejun Heo 		return 0;
1981bf4ede01STejun Heo 
198224acfb71SThomas Gleixner 	rcu_read_lock();
1983bf4ede01STejun Heo 	/*
1984bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1985bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1986bf4ede01STejun Heo 	 */
1987d565ed63STejun Heo 	pool = get_work_pool(work);
1988d565ed63STejun Heo 	if (!pool)
1989bbb68dfaSTejun Heo 		goto fail;
1990bf4ede01STejun Heo 
1991a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&pool->lock);
1992bf4ede01STejun Heo 	/*
1993112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1994112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1995112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1996112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1997112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
19980b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1999bf4ede01STejun Heo 	 */
2000112202d9STejun Heo 	pwq = get_work_pwq(work);
2001112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
2002c70e1779STejun Heo 		unsigned long work_data;
2003c70e1779STejun Heo 
2004bf4ede01STejun Heo 		debug_work_deactivate(work);
20053aa62497SLai Jiangshan 
20063aa62497SLai Jiangshan 		/*
2007018f3a13SLai Jiangshan 		 * A cancelable inactive work item must be in the
2008018f3a13SLai Jiangshan 		 * pwq->inactive_works since a queued barrier can't be
2009018f3a13SLai Jiangshan 		 * canceled (see the comments in insert_wq_barrier()).
2010018f3a13SLai Jiangshan 		 *
2011f97a4a1aSLai Jiangshan 		 * An inactive work item cannot be grabbed directly because
2012d812796eSLai Jiangshan 		 * it might have linked barrier work items which, if left
2013f97a4a1aSLai Jiangshan 		 * on the inactive_works list, will confuse pwq->nr_active
201416062836STejun Heo 		 * management later on and cause stall.  Make sure the work
201516062836STejun Heo 		 * item is activated before grabbing.
20163aa62497SLai Jiangshan 		 */
20174c638030STejun Heo 		pwq_activate_work(pwq, work);
20183aa62497SLai Jiangshan 
2019bf4ede01STejun Heo 		list_del_init(&work->entry);
202036e227d2STejun Heo 
2021c70e1779STejun Heo 		/*
2022c70e1779STejun Heo 		 * work->data points to pwq iff queued. Let's point to pool. As
2023c70e1779STejun Heo 		 * this destroys work->data needed by the next step, stash it.
2024c70e1779STejun Heo 		 */
2025c70e1779STejun Heo 		work_data = *work_data_bits(work);
20264468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
20274468a00fSLai Jiangshan 
2028dd6c3c54STejun Heo 		/* must be the last step, see the function comment */
2029c70e1779STejun Heo 		pwq_dec_nr_in_flight(pwq, work_data);
2030dd6c3c54STejun Heo 
2031a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock(&pool->lock);
203224acfb71SThomas Gleixner 		rcu_read_unlock();
203336e227d2STejun Heo 		return 1;
2034bf4ede01STejun Heo 	}
2035a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pool->lock);
2036bbb68dfaSTejun Heo fail:
203724acfb71SThomas Gleixner 	rcu_read_unlock();
2038bbb68dfaSTejun Heo 	local_irq_restore(*flags);
2039bbb68dfaSTejun Heo 	if (work_is_canceling(work))
2040bbb68dfaSTejun Heo 		return -ENOENT;
2041bbb68dfaSTejun Heo 	cpu_relax();
204236e227d2STejun Heo 	return -EAGAIN;
2043bf4ede01STejun Heo }
2044bf4ede01STejun Heo 
2045bf4ede01STejun Heo /**
2046706026c2STejun Heo  * insert_work - insert a work into a pool
2047112202d9STejun Heo  * @pwq: pwq @work belongs to
20484690c4abSTejun Heo  * @work: work to insert
20494690c4abSTejun Heo  * @head: insertion point
20504690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
20514690c4abSTejun Heo  *
2052112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
2053706026c2STejun Heo  * work_struct flags.
20544690c4abSTejun Heo  *
20554690c4abSTejun Heo  * CONTEXT:
2056a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2057365970a1SDavid Howells  */
2058112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
2059112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
2060b89deed3SOleg Nesterov {
2061fe089f87STejun Heo 	debug_work_activate(work);
2062e1d8aa9fSFrederic Weisbecker 
2063e89a85d6SWalter Wu 	/* record the work call stack in order to print it in KASAN reports */
2064f70da745SMarco Elver 	kasan_record_aux_stack_noalloc(work);
2065e89a85d6SWalter Wu 
20664690c4abSTejun Heo 	/* we own @work, set data and link */
2067112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
20681a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
20698864b4e5STejun Heo 	get_pwq(pwq);
2070b89deed3SOleg Nesterov }
2071b89deed3SOleg Nesterov 
2072c8efcc25STejun Heo /*
2073c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
20748d03ecfeSTejun Heo  * same workqueue.
2075c8efcc25STejun Heo  */
2076c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
2077c8efcc25STejun Heo {
2078c8efcc25STejun Heo 	struct worker *worker;
2079c8efcc25STejun Heo 
20808d03ecfeSTejun Heo 	worker = current_wq_worker();
2081c8efcc25STejun Heo 	/*
2082bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
20838d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
2084c8efcc25STejun Heo 	 */
2085112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
2086c8efcc25STejun Heo }
2087c8efcc25STejun Heo 
2088ef557180SMike Galbraith /*
2089ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
2090ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
2091ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
2092ef557180SMike Galbraith  */
2093ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
2094ef557180SMike Galbraith {
2095ef557180SMike Galbraith 	int new_cpu;
2096ef557180SMike Galbraith 
2097f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
2098ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
2099ef557180SMike Galbraith 			return cpu;
2100a8ec5880SAmmar Faizi 	} else {
2101a8ec5880SAmmar Faizi 		pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n");
2102f303fccbSTejun Heo 	}
2103f303fccbSTejun Heo 
2104ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
2105ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
2106ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
2107ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
2108ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
2109ef557180SMike Galbraith 			return cpu;
2110ef557180SMike Galbraith 	}
2111ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
2112ef557180SMike Galbraith 
2113ef557180SMike Galbraith 	return new_cpu;
2114ef557180SMike Galbraith }
2115ef557180SMike Galbraith 
2116d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
21171da177e4SLinus Torvalds 			 struct work_struct *work)
21181da177e4SLinus Torvalds {
2119112202d9STejun Heo 	struct pool_workqueue *pwq;
2120fe089f87STejun Heo 	struct worker_pool *last_pool, *pool;
21218a2e8e5dSTejun Heo 	unsigned int work_flags;
2122b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
21238930cabaSTejun Heo 
21248930cabaSTejun Heo 	/*
21258930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
21268930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
21278930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
21288930cabaSTejun Heo 	 * happen with IRQ disabled.
21298930cabaSTejun Heo 	 */
21308e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
21311da177e4SLinus Torvalds 
21321e19ffc6STejun Heo 
213333e3f0a3SRichard Clark 	/*
213433e3f0a3SRichard Clark 	 * For a draining wq, only works from the same workqueue are
213533e3f0a3SRichard Clark 	 * allowed. The __WQ_DESTROYING helps to spot the issue that
213633e3f0a3SRichard Clark 	 * queues a new work item to a wq after destroy_workqueue(wq).
213733e3f0a3SRichard Clark 	 */
213833e3f0a3SRichard Clark 	if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) &&
213933e3f0a3SRichard Clark 		     WARN_ON_ONCE(!is_chained_work(wq))))
2140e41e704bSTejun Heo 		return;
214124acfb71SThomas Gleixner 	rcu_read_lock();
21429e8cd2f5STejun Heo retry:
2143aa202f1fSHillf Danton 	/* pwq which will be used unless @work is executing elsewhere */
2144636b927eSTejun Heo 	if (req_cpu == WORK_CPU_UNBOUND) {
2145636b927eSTejun Heo 		if (wq->flags & WQ_UNBOUND)
2146ef557180SMike Galbraith 			cpu = wq_select_unbound_cpu(raw_smp_processor_id());
2147636b927eSTejun Heo 		else
2148aa202f1fSHillf Danton 			cpu = raw_smp_processor_id();
2149aa202f1fSHillf Danton 	}
2150f3421797STejun Heo 
2151636b927eSTejun Heo 	pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu));
2152fe089f87STejun Heo 	pool = pwq->pool;
2153fe089f87STejun Heo 
215418aa9effSTejun Heo 	/*
2155c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
2156c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
2157c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
215818aa9effSTejun Heo 	 */
2159c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
2160fe089f87STejun Heo 	if (last_pool && last_pool != pool) {
216118aa9effSTejun Heo 		struct worker *worker;
216218aa9effSTejun Heo 
2163a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&last_pool->lock);
216418aa9effSTejun Heo 
2165c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
216618aa9effSTejun Heo 
2167112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
2168c9178087STejun Heo 			pwq = worker->current_pwq;
2169fe089f87STejun Heo 			pool = pwq->pool;
2170fe089f87STejun Heo 			WARN_ON_ONCE(pool != last_pool);
21718594fadeSLai Jiangshan 		} else {
217218aa9effSTejun Heo 			/* meh... not running there, queue here */
2173a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&last_pool->lock);
2174fe089f87STejun Heo 			raw_spin_lock(&pool->lock);
217518aa9effSTejun Heo 		}
21768930cabaSTejun Heo 	} else {
2177fe089f87STejun Heo 		raw_spin_lock(&pool->lock);
21788930cabaSTejun Heo 	}
2179502ca9d8STejun Heo 
21809e8cd2f5STejun Heo 	/*
2181636b927eSTejun Heo 	 * pwq is determined and locked. For unbound pools, we could have raced
2182636b927eSTejun Heo 	 * with pwq release and it could already be dead. If its refcnt is zero,
2183636b927eSTejun Heo 	 * repeat pwq selection. Note that unbound pwqs never die without
2184636b927eSTejun Heo 	 * another pwq replacing it in cpu_pwq or while work items are executing
2185636b927eSTejun Heo 	 * on it, so the retrying is guaranteed to make forward-progress.
21869e8cd2f5STejun Heo 	 */
21879e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
21889e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
2189fe089f87STejun Heo 			raw_spin_unlock(&pool->lock);
21909e8cd2f5STejun Heo 			cpu_relax();
21919e8cd2f5STejun Heo 			goto retry;
21929e8cd2f5STejun Heo 		}
21939e8cd2f5STejun Heo 		/* oops */
21949e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
21959e8cd2f5STejun Heo 			  wq->name, cpu);
21969e8cd2f5STejun Heo 	}
21979e8cd2f5STejun Heo 
2198112202d9STejun Heo 	/* pwq determined, queue */
2199112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
2200502ca9d8STejun Heo 
220124acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
220224acfb71SThomas Gleixner 		goto out;
22031e19ffc6STejun Heo 
2204112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
2205112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
22061e19ffc6STejun Heo 
2207a045a272STejun Heo 	/*
2208a045a272STejun Heo 	 * Limit the number of concurrently active work items to max_active.
2209a045a272STejun Heo 	 * @work must also queue behind existing inactive work items to maintain
2210a045a272STejun Heo 	 * ordering when max_active changes. See wq_adjust_max_active().
2211a045a272STejun Heo 	 */
22125797b1c1STejun Heo 	if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq, false)) {
2213fe089f87STejun Heo 		if (list_empty(&pool->worklist))
2214fe089f87STejun Heo 			pool->watchdog_ts = jiffies;
2215fe089f87STejun Heo 
2216cdadf009STejun Heo 		trace_workqueue_activate_work(work);
2217fe089f87STejun Heo 		insert_work(pwq, work, &pool->worklist, work_flags);
22180219a352STejun Heo 		kick_pool(pool);
22198a2e8e5dSTejun Heo 	} else {
2220f97a4a1aSLai Jiangshan 		work_flags |= WORK_STRUCT_INACTIVE;
2221fe089f87STejun Heo 		insert_work(pwq, work, &pwq->inactive_works, work_flags);
22228a2e8e5dSTejun Heo 	}
22231e19ffc6STejun Heo 
222424acfb71SThomas Gleixner out:
2225fe089f87STejun Heo 	raw_spin_unlock(&pool->lock);
222624acfb71SThomas Gleixner 	rcu_read_unlock();
22271da177e4SLinus Torvalds }
22281da177e4SLinus Torvalds 
22290fcb78c2SRolf Eike Beer /**
2230c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
2231c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
2232c1a220e7SZhang Rui  * @wq: workqueue to use
2233c1a220e7SZhang Rui  * @work: work to queue
2234c1a220e7SZhang Rui  *
2235c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
2236443378f0SPaul E. McKenney  * can't go away.  Callers that fail to ensure that the specified
2237443378f0SPaul E. McKenney  * CPU cannot go away will execute on a randomly chosen CPU.
2238854f5cc5SPaul E. McKenney  * But note well that callers specifying a CPU that never has been
2239854f5cc5SPaul E. McKenney  * online will get a splat.
2240d185af30SYacine Belkadi  *
2241d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
2242c1a220e7SZhang Rui  */
2243d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
2244d4283e93STejun Heo 		   struct work_struct *work)
2245c1a220e7SZhang Rui {
2246d4283e93STejun Heo 	bool ret = false;
22478930cabaSTejun Heo 	unsigned long flags;
22488930cabaSTejun Heo 
22498930cabaSTejun Heo 	local_irq_save(flags);
2250c1a220e7SZhang Rui 
225122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
22524690c4abSTejun Heo 		__queue_work(cpu, wq, work);
2253d4283e93STejun Heo 		ret = true;
2254c1a220e7SZhang Rui 	}
22558930cabaSTejun Heo 
22568930cabaSTejun Heo 	local_irq_restore(flags);
2257c1a220e7SZhang Rui 	return ret;
2258c1a220e7SZhang Rui }
2259ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
2260c1a220e7SZhang Rui 
22618204e0c1SAlexander Duyck /**
2262fef59c9cSTejun Heo  * select_numa_node_cpu - Select a CPU based on NUMA node
22638204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
22648204e0c1SAlexander Duyck  *
22658204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
22668204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
22678204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
22688204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
22698204e0c1SAlexander Duyck  */
2270fef59c9cSTejun Heo static int select_numa_node_cpu(int node)
22718204e0c1SAlexander Duyck {
22728204e0c1SAlexander Duyck 	int cpu;
22738204e0c1SAlexander Duyck 
22748204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
22758204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
22768204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
22778204e0c1SAlexander Duyck 
22788204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
22798204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
22808204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
22818204e0c1SAlexander Duyck 		return cpu;
22828204e0c1SAlexander Duyck 
22838204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
22848204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
22858204e0c1SAlexander Duyck 
22868204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
22878204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
22888204e0c1SAlexander Duyck }
22898204e0c1SAlexander Duyck 
22908204e0c1SAlexander Duyck /**
22918204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
22928204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
22938204e0c1SAlexander Duyck  * @wq: workqueue to use
22948204e0c1SAlexander Duyck  * @work: work to queue
22958204e0c1SAlexander Duyck  *
22968204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
22978204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
22988204e0c1SAlexander Duyck  * NUMA node.
22998204e0c1SAlexander Duyck  *
23008204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
23018204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
23028204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
23038204e0c1SAlexander Duyck  *
23048204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
23058204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
23068204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
23078204e0c1SAlexander Duyck  *
23088204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
23098204e0c1SAlexander Duyck  */
23108204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
23118204e0c1SAlexander Duyck 		     struct work_struct *work)
23128204e0c1SAlexander Duyck {
23138204e0c1SAlexander Duyck 	unsigned long flags;
23148204e0c1SAlexander Duyck 	bool ret = false;
23158204e0c1SAlexander Duyck 
23168204e0c1SAlexander Duyck 	/*
23178204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
23188204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
23198204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
23208204e0c1SAlexander Duyck 	 *
23218204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
23228204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
23238204e0c1SAlexander Duyck 	 * some round robin type logic.
23248204e0c1SAlexander Duyck 	 */
23258204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
23268204e0c1SAlexander Duyck 
23278204e0c1SAlexander Duyck 	local_irq_save(flags);
23288204e0c1SAlexander Duyck 
23298204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
2330fef59c9cSTejun Heo 		int cpu = select_numa_node_cpu(node);
23318204e0c1SAlexander Duyck 
23328204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
23338204e0c1SAlexander Duyck 		ret = true;
23348204e0c1SAlexander Duyck 	}
23358204e0c1SAlexander Duyck 
23368204e0c1SAlexander Duyck 	local_irq_restore(flags);
23378204e0c1SAlexander Duyck 	return ret;
23388204e0c1SAlexander Duyck }
23398204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
23408204e0c1SAlexander Duyck 
23418c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
23421da177e4SLinus Torvalds {
23438c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
23441da177e4SLinus Torvalds 
2345e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
234660c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
23471da177e4SLinus Torvalds }
23481438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
23491da177e4SLinus Torvalds 
23507beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
235152bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
23521da177e4SLinus Torvalds {
23537beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
23547beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
23551da177e4SLinus Torvalds 
2356637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
23574b243563SSami Tolvanen 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
2358fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
2359fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
23607beb2edfSTejun Heo 
23618852aac2STejun Heo 	/*
23628852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
23638852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
23648852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
23658852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
23668852aac2STejun Heo 	 */
23678852aac2STejun Heo 	if (!delay) {
23688852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
23698852aac2STejun Heo 		return;
23708852aac2STejun Heo 	}
23718852aac2STejun Heo 
237260c057bcSLai Jiangshan 	dwork->wq = wq;
23731265057fSTejun Heo 	dwork->cpu = cpu;
23747beb2edfSTejun Heo 	timer->expires = jiffies + delay;
23757beb2edfSTejun Heo 
2376aae17ebbSLeonardo Bras 	if (housekeeping_enabled(HK_TYPE_TIMER)) {
2377aae17ebbSLeonardo Bras 		/* If the current cpu is a housekeeping cpu, use it. */
2378aae17ebbSLeonardo Bras 		cpu = smp_processor_id();
2379aae17ebbSLeonardo Bras 		if (!housekeeping_test_cpu(cpu, HK_TYPE_TIMER))
2380aae17ebbSLeonardo Bras 			cpu = housekeeping_any_cpu(HK_TYPE_TIMER);
23817beb2edfSTejun Heo 		add_timer_on(timer, cpu);
2382aae17ebbSLeonardo Bras 	} else {
2383aae17ebbSLeonardo Bras 		if (likely(cpu == WORK_CPU_UNBOUND))
2384041bd12eSTejun Heo 			add_timer(timer);
2385aae17ebbSLeonardo Bras 		else
2386aae17ebbSLeonardo Bras 			add_timer_on(timer, cpu);
2387aae17ebbSLeonardo Bras 	}
23887beb2edfSTejun Heo }
23891da177e4SLinus Torvalds 
23900fcb78c2SRolf Eike Beer /**
23910fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
23920fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
23930fcb78c2SRolf Eike Beer  * @wq: workqueue to use
2394af9997e4SRandy Dunlap  * @dwork: work to queue
23950fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
23960fcb78c2SRolf Eike Beer  *
2397d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
2398715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
2399715f1300STejun Heo  * execution.
24000fcb78c2SRolf Eike Beer  */
2401d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
240252bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
24037a6bc1cdSVenkatesh Pallipadi {
240452bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
2405d4283e93STejun Heo 	bool ret = false;
24068930cabaSTejun Heo 	unsigned long flags;
24078930cabaSTejun Heo 
24088930cabaSTejun Heo 	/* read the comment in __queue_work() */
24098930cabaSTejun Heo 	local_irq_save(flags);
24107a6bc1cdSVenkatesh Pallipadi 
241122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
24127beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
2413d4283e93STejun Heo 		ret = true;
24147a6bc1cdSVenkatesh Pallipadi 	}
24158930cabaSTejun Heo 
24168930cabaSTejun Heo 	local_irq_restore(flags);
24177a6bc1cdSVenkatesh Pallipadi 	return ret;
24187a6bc1cdSVenkatesh Pallipadi }
2419ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
24201da177e4SLinus Torvalds 
2421c8e55f36STejun Heo /**
24228376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
24238376fe22STejun Heo  * @cpu: CPU number to execute work on
24248376fe22STejun Heo  * @wq: workqueue to use
24258376fe22STejun Heo  * @dwork: work to queue
24268376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
24278376fe22STejun Heo  *
24288376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
24298376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
24308376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
24318376fe22STejun Heo  * current state.
24328376fe22STejun Heo  *
2433d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
24348376fe22STejun Heo  * pending and its timer was modified.
24358376fe22STejun Heo  *
2436e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
24378376fe22STejun Heo  * See try_to_grab_pending() for details.
24388376fe22STejun Heo  */
24398376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
24408376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
24418376fe22STejun Heo {
24428376fe22STejun Heo 	unsigned long flags;
24438376fe22STejun Heo 	int ret;
24448376fe22STejun Heo 
24458376fe22STejun Heo 	do {
24468376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
24478376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
24488376fe22STejun Heo 
24498376fe22STejun Heo 	if (likely(ret >= 0)) {
24508376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
24518376fe22STejun Heo 		local_irq_restore(flags);
24528376fe22STejun Heo 	}
24538376fe22STejun Heo 
24548376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
24558376fe22STejun Heo 	return ret;
24568376fe22STejun Heo }
24578376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
24588376fe22STejun Heo 
245905f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
246005f0fe6bSTejun Heo {
246105f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
246205f0fe6bSTejun Heo 
246305f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
246405f0fe6bSTejun Heo 	local_irq_disable();
246505f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
246605f0fe6bSTejun Heo 	local_irq_enable();
246705f0fe6bSTejun Heo }
246805f0fe6bSTejun Heo 
246905f0fe6bSTejun Heo /**
247005f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
247105f0fe6bSTejun Heo  * @wq: workqueue to use
247205f0fe6bSTejun Heo  * @rwork: work to queue
247305f0fe6bSTejun Heo  *
247405f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
247505f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
2476bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
247705f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
247805f0fe6bSTejun Heo  */
247905f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
248005f0fe6bSTejun Heo {
248105f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
248205f0fe6bSTejun Heo 
248305f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
248405f0fe6bSTejun Heo 		rwork->wq = wq;
2485a7e30c0eSUladzislau Rezki 		call_rcu_hurry(&rwork->rcu, rcu_work_rcufn);
248605f0fe6bSTejun Heo 		return true;
248705f0fe6bSTejun Heo 	}
248805f0fe6bSTejun Heo 
248905f0fe6bSTejun Heo 	return false;
249005f0fe6bSTejun Heo }
249105f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
249205f0fe6bSTejun Heo 
2493f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
2494c34056a3STejun Heo {
2495c34056a3STejun Heo 	struct worker *worker;
2496c34056a3STejun Heo 
2497f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
2498c8e55f36STejun Heo 	if (worker) {
2499c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
2500affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
2501da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
2502e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
2503e22bee78STejun Heo 		worker->flags = WORKER_PREP;
2504c8e55f36STejun Heo 	}
2505c34056a3STejun Heo 	return worker;
2506c34056a3STejun Heo }
2507c34056a3STejun Heo 
25089546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool)
25099546b29eSTejun Heo {
25108639ecebSTejun Heo 	if (pool->cpu < 0 && pool->attrs->affn_strict)
25119546b29eSTejun Heo 		return pool->attrs->__pod_cpumask;
25128639ecebSTejun Heo 	else
25138639ecebSTejun Heo 		return pool->attrs->cpumask;
25149546b29eSTejun Heo }
25159546b29eSTejun Heo 
2516c34056a3STejun Heo /**
25174736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
25184736cbf7SLai Jiangshan  * @worker: worker to be attached
25194736cbf7SLai Jiangshan  * @pool: the target pool
25204736cbf7SLai Jiangshan  *
25214736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
25224736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
25234736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
25244736cbf7SLai Jiangshan  */
25254736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
25264736cbf7SLai Jiangshan 				   struct worker_pool *pool)
25274736cbf7SLai Jiangshan {
25281258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
25294736cbf7SLai Jiangshan 
25304736cbf7SLai Jiangshan 	/*
25311258fae7STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
25321258fae7STejun Heo 	 * stable across this function.  See the comments above the flag
25331258fae7STejun Heo 	 * definition for details.
25344736cbf7SLai Jiangshan 	 */
25354736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
25364736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
25375c25b5ffSPeter Zijlstra 	else
25385c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
25394736cbf7SLai Jiangshan 
2540640f17c8SPeter Zijlstra 	if (worker->rescue_wq)
25419546b29eSTejun Heo 		set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool));
2542640f17c8SPeter Zijlstra 
25434736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
2544a2d812a2STejun Heo 	worker->pool = pool;
25454736cbf7SLai Jiangshan 
25461258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
25474736cbf7SLai Jiangshan }
25484736cbf7SLai Jiangshan 
25494736cbf7SLai Jiangshan /**
255060f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
255160f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
255260f5a4bcSLai Jiangshan  *
25534736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
25544736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
25554736cbf7SLai Jiangshan  * other reference to the pool.
255660f5a4bcSLai Jiangshan  */
2557a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
255860f5a4bcSLai Jiangshan {
2559a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
256060f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
256160f5a4bcSLai Jiangshan 
25621258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2563a2d812a2STejun Heo 
25645c25b5ffSPeter Zijlstra 	kthread_set_per_cpu(worker->task, -1);
2565da028469SLai Jiangshan 	list_del(&worker->node);
2566a2d812a2STejun Heo 	worker->pool = NULL;
2567a2d812a2STejun Heo 
2568e02b9312SValentin Schneider 	if (list_empty(&pool->workers) && list_empty(&pool->dying_workers))
256960f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
25701258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
257160f5a4bcSLai Jiangshan 
2572b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
2573b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
2574b62c0751SLai Jiangshan 
257560f5a4bcSLai Jiangshan 	if (detach_completion)
257660f5a4bcSLai Jiangshan 		complete(detach_completion);
257760f5a4bcSLai Jiangshan }
257860f5a4bcSLai Jiangshan 
257960f5a4bcSLai Jiangshan /**
2580c34056a3STejun Heo  * create_worker - create a new workqueue worker
258163d95a91STejun Heo  * @pool: pool the new worker will belong to
2582c34056a3STejun Heo  *
2583051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
2584c34056a3STejun Heo  *
2585c34056a3STejun Heo  * CONTEXT:
2586c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
2587c34056a3STejun Heo  *
2588d185af30SYacine Belkadi  * Return:
2589c34056a3STejun Heo  * Pointer to the newly created worker.
2590c34056a3STejun Heo  */
2591bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
2592c34056a3STejun Heo {
2593e441b56fSZhen Lei 	struct worker *worker;
2594e441b56fSZhen Lei 	int id;
25955d9c7a1eSLucy Mielke 	char id_buf[23];
2596c34056a3STejun Heo 
25977cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
2598e441b56fSZhen Lei 	id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
25993f0ea0b8SPetr Mladek 	if (id < 0) {
26003f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n",
26013f0ea0b8SPetr Mladek 			    ERR_PTR(id));
2602e441b56fSZhen Lei 		return NULL;
26033f0ea0b8SPetr Mladek 	}
2604c34056a3STejun Heo 
2605f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
26063f0ea0b8SPetr Mladek 	if (!worker) {
26073f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker\n");
2608c34056a3STejun Heo 		goto fail;
26093f0ea0b8SPetr Mladek 	}
2610c34056a3STejun Heo 
2611c34056a3STejun Heo 	worker->id = id;
2612c34056a3STejun Heo 
261329c91e99STejun Heo 	if (pool->cpu >= 0)
2614e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
2615e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
2616f3421797STejun Heo 	else
2617e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
2618e3c916a4STejun Heo 
2619f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
2620e3c916a4STejun Heo 					      "kworker/%s", id_buf);
26213f0ea0b8SPetr Mladek 	if (IS_ERR(worker->task)) {
262260f54038SPetr Mladek 		if (PTR_ERR(worker->task) == -EINTR) {
262360f54038SPetr Mladek 			pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n",
262460f54038SPetr Mladek 			       id_buf);
262560f54038SPetr Mladek 		} else {
26263f0ea0b8SPetr Mladek 			pr_err_once("workqueue: Failed to create a worker thread: %pe",
26273f0ea0b8SPetr Mladek 				    worker->task);
262860f54038SPetr Mladek 		}
2629c34056a3STejun Heo 		goto fail;
26303f0ea0b8SPetr Mladek 	}
2631c34056a3STejun Heo 
263291151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
26339546b29eSTejun Heo 	kthread_bind_mask(worker->task, pool_allowed_cpus(pool));
263491151228SOleg Nesterov 
2635da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
26364736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
2637822d8405STejun Heo 
2638051e1850SLai Jiangshan 	/* start the newly created worker */
2639a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
26400219a352STejun Heo 
2641051e1850SLai Jiangshan 	worker->pool->nr_workers++;
2642051e1850SLai Jiangshan 	worker_enter_idle(worker);
26430219a352STejun Heo 
26440219a352STejun Heo 	/*
26450219a352STejun Heo 	 * @worker is waiting on a completion in kthread() and will trigger hung
26466a229b0eSTejun Heo 	 * check if not woken up soon. As kick_pool() is noop if @pool is empty,
26476a229b0eSTejun Heo 	 * wake it up explicitly.
26480219a352STejun Heo 	 */
2649051e1850SLai Jiangshan 	wake_up_process(worker->task);
26500219a352STejun Heo 
2651a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2652051e1850SLai Jiangshan 
2653c34056a3STejun Heo 	return worker;
2654822d8405STejun Heo 
2655c34056a3STejun Heo fail:
2656e441b56fSZhen Lei 	ida_free(&pool->worker_ida, id);
2657c34056a3STejun Heo 	kfree(worker);
2658c34056a3STejun Heo 	return NULL;
2659c34056a3STejun Heo }
2660c34056a3STejun Heo 
2661793777bcSValentin Schneider static void unbind_worker(struct worker *worker)
2662793777bcSValentin Schneider {
2663793777bcSValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2664793777bcSValentin Schneider 
2665793777bcSValentin Schneider 	kthread_set_per_cpu(worker->task, -1);
2666793777bcSValentin Schneider 	if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask))
2667793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0);
2668793777bcSValentin Schneider 	else
2669793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
2670793777bcSValentin Schneider }
2671793777bcSValentin Schneider 
2672e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list)
2673e02b9312SValentin Schneider {
2674e02b9312SValentin Schneider 	struct worker *worker, *tmp;
2675e02b9312SValentin Schneider 
2676e02b9312SValentin Schneider 	list_for_each_entry_safe(worker, tmp, cull_list, entry) {
2677e02b9312SValentin Schneider 		list_del_init(&worker->entry);
2678e02b9312SValentin Schneider 		unbind_worker(worker);
2679e02b9312SValentin Schneider 		/*
2680e02b9312SValentin Schneider 		 * If the worker was somehow already running, then it had to be
2681e02b9312SValentin Schneider 		 * in pool->idle_list when set_worker_dying() happened or we
2682e02b9312SValentin Schneider 		 * wouldn't have gotten here.
2683c34056a3STejun Heo 		 *
2684e02b9312SValentin Schneider 		 * Thus, the worker must either have observed the WORKER_DIE
2685e02b9312SValentin Schneider 		 * flag, or have set its state to TASK_IDLE. Either way, the
2686e02b9312SValentin Schneider 		 * below will be observed by the worker and is safe to do
2687e02b9312SValentin Schneider 		 * outside of pool->lock.
2688e02b9312SValentin Schneider 		 */
2689e02b9312SValentin Schneider 		wake_up_process(worker->task);
2690e02b9312SValentin Schneider 	}
2691e02b9312SValentin Schneider }
2692e02b9312SValentin Schneider 
2693e02b9312SValentin Schneider /**
2694e02b9312SValentin Schneider  * set_worker_dying - Tag a worker for destruction
2695e02b9312SValentin Schneider  * @worker: worker to be destroyed
2696e02b9312SValentin Schneider  * @list: transfer worker away from its pool->idle_list and into list
2697e02b9312SValentin Schneider  *
2698e02b9312SValentin Schneider  * Tag @worker for destruction and adjust @pool stats accordingly.  The worker
2699e02b9312SValentin Schneider  * should be idle.
2700c8e55f36STejun Heo  *
2701c8e55f36STejun Heo  * CONTEXT:
2702a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2703c34056a3STejun Heo  */
2704e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list)
2705c34056a3STejun Heo {
2706bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2707c34056a3STejun Heo 
2708cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
2709e02b9312SValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2710cd549687STejun Heo 
2711c34056a3STejun Heo 	/* sanity check frenzy */
27126183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
271373eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
271473eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
27156183c009STejun Heo 		return;
2716c34056a3STejun Heo 
2717bd7bdd43STejun Heo 	pool->nr_workers--;
2718bd7bdd43STejun Heo 	pool->nr_idle--;
2719c8e55f36STejun Heo 
2720cb444766STejun Heo 	worker->flags |= WORKER_DIE;
2721e02b9312SValentin Schneider 
2722e02b9312SValentin Schneider 	list_move(&worker->entry, list);
2723e02b9312SValentin Schneider 	list_move(&worker->node, &pool->dying_workers);
2724c34056a3STejun Heo }
2725c34056a3STejun Heo 
27263f959aa3SValentin Schneider /**
27273f959aa3SValentin Schneider  * idle_worker_timeout - check if some idle workers can now be deleted.
27283f959aa3SValentin Schneider  * @t: The pool's idle_timer that just expired
27293f959aa3SValentin Schneider  *
27303f959aa3SValentin Schneider  * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in
27313f959aa3SValentin Schneider  * worker_leave_idle(), as a worker flicking between idle and active while its
27323f959aa3SValentin Schneider  * pool is at the too_many_workers() tipping point would cause too much timer
27333f959aa3SValentin Schneider  * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let
27343f959aa3SValentin Schneider  * it expire and re-evaluate things from there.
27353f959aa3SValentin Schneider  */
273632a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
2737e22bee78STejun Heo {
273832a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
27393f959aa3SValentin Schneider 	bool do_cull = false;
27403f959aa3SValentin Schneider 
27413f959aa3SValentin Schneider 	if (work_pending(&pool->idle_cull_work))
27423f959aa3SValentin Schneider 		return;
27433f959aa3SValentin Schneider 
27443f959aa3SValentin Schneider 	raw_spin_lock_irq(&pool->lock);
27453f959aa3SValentin Schneider 
27463f959aa3SValentin Schneider 	if (too_many_workers(pool)) {
27473f959aa3SValentin Schneider 		struct worker *worker;
27483f959aa3SValentin Schneider 		unsigned long expires;
27493f959aa3SValentin Schneider 
27503f959aa3SValentin Schneider 		/* idle_list is kept in LIFO order, check the last one */
27513f959aa3SValentin Schneider 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
27523f959aa3SValentin Schneider 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
27533f959aa3SValentin Schneider 		do_cull = !time_before(jiffies, expires);
27543f959aa3SValentin Schneider 
27553f959aa3SValentin Schneider 		if (!do_cull)
27563f959aa3SValentin Schneider 			mod_timer(&pool->idle_timer, expires);
27573f959aa3SValentin Schneider 	}
27583f959aa3SValentin Schneider 	raw_spin_unlock_irq(&pool->lock);
27593f959aa3SValentin Schneider 
27603f959aa3SValentin Schneider 	if (do_cull)
27613f959aa3SValentin Schneider 		queue_work(system_unbound_wq, &pool->idle_cull_work);
27623f959aa3SValentin Schneider }
27633f959aa3SValentin Schneider 
27643f959aa3SValentin Schneider /**
27653f959aa3SValentin Schneider  * idle_cull_fn - cull workers that have been idle for too long.
27663f959aa3SValentin Schneider  * @work: the pool's work for handling these idle workers
27673f959aa3SValentin Schneider  *
27683f959aa3SValentin Schneider  * This goes through a pool's idle workers and gets rid of those that have been
27693f959aa3SValentin Schneider  * idle for at least IDLE_WORKER_TIMEOUT seconds.
2770e02b9312SValentin Schneider  *
2771e02b9312SValentin Schneider  * We don't want to disturb isolated CPUs because of a pcpu kworker being
2772e02b9312SValentin Schneider  * culled, so this also resets worker affinity. This requires a sleepable
2773e02b9312SValentin Schneider  * context, hence the split between timer callback and work item.
27743f959aa3SValentin Schneider  */
27753f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work)
27763f959aa3SValentin Schneider {
27773f959aa3SValentin Schneider 	struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work);
27789680540cSYang Yingliang 	LIST_HEAD(cull_list);
2779e22bee78STejun Heo 
2780e02b9312SValentin Schneider 	/*
2781e02b9312SValentin Schneider 	 * Grabbing wq_pool_attach_mutex here ensures an already-running worker
2782e02b9312SValentin Schneider 	 * cannot proceed beyong worker_detach_from_pool() in its self-destruct
2783e02b9312SValentin Schneider 	 * path. This is required as a previously-preempted worker could run after
2784e02b9312SValentin Schneider 	 * set_worker_dying() has happened but before wake_dying_workers() did.
2785e02b9312SValentin Schneider 	 */
2786e02b9312SValentin Schneider 	mutex_lock(&wq_pool_attach_mutex);
2787a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2788e22bee78STejun Heo 
27893347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
2790e22bee78STejun Heo 		struct worker *worker;
2791e22bee78STejun Heo 		unsigned long expires;
2792e22bee78STejun Heo 
279363d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2794e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2795e22bee78STejun Heo 
27963347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
279763d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
27983347fc9fSLai Jiangshan 			break;
2799e22bee78STejun Heo 		}
28003347fc9fSLai Jiangshan 
2801e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
2802e22bee78STejun Heo 	}
2803e22bee78STejun Heo 
2804a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2805e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
2806e02b9312SValentin Schneider 	mutex_unlock(&wq_pool_attach_mutex);
2807e22bee78STejun Heo }
2808e22bee78STejun Heo 
2809493a1724STejun Heo static void send_mayday(struct work_struct *work)
2810e22bee78STejun Heo {
2811112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2812112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2813493a1724STejun Heo 
28142e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2815e22bee78STejun Heo 
2816493008a8STejun Heo 	if (!wq->rescuer)
2817493a1724STejun Heo 		return;
2818e22bee78STejun Heo 
2819e22bee78STejun Heo 	/* mayday mayday mayday */
2820493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
282177668c8bSLai Jiangshan 		/*
282277668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
282377668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
282477668c8bSLai Jiangshan 		 * rescuer is done with it.
282577668c8bSLai Jiangshan 		 */
282677668c8bSLai Jiangshan 		get_pwq(pwq);
2827493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2828e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2829725e8ec5STejun Heo 		pwq->stats[PWQ_STAT_MAYDAY]++;
2830493a1724STejun Heo 	}
2831e22bee78STejun Heo }
2832e22bee78STejun Heo 
283332a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2834e22bee78STejun Heo {
283532a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2836e22bee78STejun Heo 	struct work_struct *work;
2837e22bee78STejun Heo 
2838a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2839a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2840e22bee78STejun Heo 
284163d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2842e22bee78STejun Heo 		/*
2843e22bee78STejun Heo 		 * We've been trying to create a new worker but
2844e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2845e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2846e22bee78STejun Heo 		 * rescuers.
2847e22bee78STejun Heo 		 */
284863d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2849e22bee78STejun Heo 			send_mayday(work);
2850e22bee78STejun Heo 	}
2851e22bee78STejun Heo 
2852a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&wq_mayday_lock);
2853a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2854e22bee78STejun Heo 
285563d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2856e22bee78STejun Heo }
2857e22bee78STejun Heo 
2858e22bee78STejun Heo /**
2859e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
286063d95a91STejun Heo  * @pool: pool to create a new worker for
2861e22bee78STejun Heo  *
286263d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2863e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2864e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
286563d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2866e22bee78STejun Heo  * possible allocation deadlock.
2867e22bee78STejun Heo  *
2868c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2869c5aa87bbSTejun Heo  * may_start_working() %true.
2870e22bee78STejun Heo  *
2871e22bee78STejun Heo  * LOCKING:
2872a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2873e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2874e22bee78STejun Heo  * manager.
2875e22bee78STejun Heo  */
287629187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2877d565ed63STejun Heo __releases(&pool->lock)
2878d565ed63STejun Heo __acquires(&pool->lock)
2879e22bee78STejun Heo {
2880e22bee78STejun Heo restart:
2881a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
28829f9c2364STejun Heo 
2883e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
288463d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2885e22bee78STejun Heo 
2886e22bee78STejun Heo 	while (true) {
2887051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2888e22bee78STejun Heo 			break;
2889e22bee78STejun Heo 
2890e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
28919f9c2364STejun Heo 
289263d95a91STejun Heo 		if (!need_to_create_worker(pool))
2893e22bee78STejun Heo 			break;
2894e22bee78STejun Heo 	}
2895e22bee78STejun Heo 
289663d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2897a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2898051e1850SLai Jiangshan 	/*
2899051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
2900051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
2901051e1850SLai Jiangshan 	 * already become busy.
2902051e1850SLai Jiangshan 	 */
290363d95a91STejun Heo 	if (need_to_create_worker(pool))
2904e22bee78STejun Heo 		goto restart;
2905e22bee78STejun Heo }
2906e22bee78STejun Heo 
2907e22bee78STejun Heo /**
2908e22bee78STejun Heo  * manage_workers - manage worker pool
2909e22bee78STejun Heo  * @worker: self
2910e22bee78STejun Heo  *
2911706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2912e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2913706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2914e22bee78STejun Heo  *
2915e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2916e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2917e22bee78STejun Heo  * and may_start_working() is true.
2918e22bee78STejun Heo  *
2919e22bee78STejun Heo  * CONTEXT:
2920a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2921e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2922e22bee78STejun Heo  *
2923d185af30SYacine Belkadi  * Return:
292429187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
292529187a9eSTejun Heo  * start processing works, %true if management function was performed and
292629187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
292729187a9eSTejun Heo  * no longer be true.
2928e22bee78STejun Heo  */
2929e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2930e22bee78STejun Heo {
293163d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2932e22bee78STejun Heo 
2933692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
293429187a9eSTejun Heo 		return false;
2935692b4825STejun Heo 
2936692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
29372607d7a6STejun Heo 	pool->manager = worker;
2938e22bee78STejun Heo 
293929187a9eSTejun Heo 	maybe_create_worker(pool);
2940e22bee78STejun Heo 
29412607d7a6STejun Heo 	pool->manager = NULL;
2942692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
2943d8bb65abSSebastian Andrzej Siewior 	rcuwait_wake_up(&manager_wait);
294429187a9eSTejun Heo 	return true;
2945e22bee78STejun Heo }
2946e22bee78STejun Heo 
2947a62428c0STejun Heo /**
2948a62428c0STejun Heo  * process_one_work - process single work
2949c34056a3STejun Heo  * @worker: self
2950a62428c0STejun Heo  * @work: work to process
2951a62428c0STejun Heo  *
2952a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2953a62428c0STejun Heo  * process a single work including synchronization against and
2954a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2955a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2956a62428c0STejun Heo  * call this function to process a work.
2957a62428c0STejun Heo  *
2958a62428c0STejun Heo  * CONTEXT:
2959a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
2960a62428c0STejun Heo  */
2961c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2962d565ed63STejun Heo __releases(&pool->lock)
2963d565ed63STejun Heo __acquires(&pool->lock)
29641da177e4SLinus Torvalds {
2965112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2966bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2967c4560c2cSLai Jiangshan 	unsigned long work_data;
29684e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
29694e6045f1SJohannes Berg 	/*
2970a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2971a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2972a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2973a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2974a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
29754e6045f1SJohannes Berg 	 */
29764d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
29774d82a1deSPeter Zijlstra 
29784d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
29794e6045f1SJohannes Berg #endif
2980807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
298185327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2982ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
298325511a47STejun Heo 
29848930cabaSTejun Heo 	/* claim and dequeue */
2985dc186ad7SThomas Gleixner 	debug_work_deactivate(work);
2986c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2987c34056a3STejun Heo 	worker->current_work = work;
2988a2c1c57bSTejun Heo 	worker->current_func = work->func;
2989112202d9STejun Heo 	worker->current_pwq = pwq;
2990616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
2991c4560c2cSLai Jiangshan 	work_data = *work_data_bits(work);
2992d812796eSLai Jiangshan 	worker->current_color = get_work_color(work_data);
29937a22ad75STejun Heo 
29948bf89593STejun Heo 	/*
29958bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
29968bf89593STejun Heo 	 * overridden through set_worker_desc().
29978bf89593STejun Heo 	 */
29988bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
29998bf89593STejun Heo 
3000a62428c0STejun Heo 	list_del_init(&work->entry);
3001a62428c0STejun Heo 
3002649027d7STejun Heo 	/*
3003228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
3004228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
3005228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
3006228f1d00SLai Jiangshan 	 * execution of the pending work items.
3007fb0e7bebSTejun Heo 	 */
3008616db877STejun Heo 	if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE))
3009228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
3010fb0e7bebSTejun Heo 
3011974271c4STejun Heo 	/*
30120219a352STejun Heo 	 * Kick @pool if necessary. It's always noop for per-cpu worker pools
30130219a352STejun Heo 	 * since nr_running would always be >= 1 at this point. This is used to
30140219a352STejun Heo 	 * chain execution of the pending work items for WORKER_NOT_RUNNING
30150219a352STejun Heo 	 * workers such as the UNBOUND and CPU_INTENSIVE ones.
3016974271c4STejun Heo 	 */
30170219a352STejun Heo 	kick_pool(pool);
3018974271c4STejun Heo 
30198930cabaSTejun Heo 	/*
30207c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
3021d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
302223657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
302323657bb1STejun Heo 	 * disabled.
30248930cabaSTejun Heo 	 */
30257c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
30261da177e4SLinus Torvalds 
3027fe48ba7dSMirsad Goran Todorovac 	pwq->stats[PWQ_STAT_STARTED]++;
3028a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3029365970a1SDavid Howells 
3030a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
30313295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
3032e6f3faa7SPeter Zijlstra 	/*
3033f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
3034f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
3035e6f3faa7SPeter Zijlstra 	 *
3036e6f3faa7SPeter Zijlstra 	 * However, that would result in:
3037e6f3faa7SPeter Zijlstra 	 *
3038e6f3faa7SPeter Zijlstra 	 *   A(W1)
3039e6f3faa7SPeter Zijlstra 	 *   WFC(C)
3040e6f3faa7SPeter Zijlstra 	 *		A(W1)
3041e6f3faa7SPeter Zijlstra 	 *		C(C)
3042e6f3faa7SPeter Zijlstra 	 *
3043e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
3044e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
3045e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
3046f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
3047e6f3faa7SPeter Zijlstra 	 * these locks.
3048e6f3faa7SPeter Zijlstra 	 *
3049e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
3050e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
3051e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
3052e6f3faa7SPeter Zijlstra 	 */
3053f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
3054e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
3055a2c1c57bSTejun Heo 	worker->current_func(work);
3056e36c886aSArjan van de Ven 	/*
3057e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
3058e36c886aSArjan van de Ven 	 * point will only record its address.
3059e36c886aSArjan van de Ven 	 */
30601c5da0ecSDaniel Jordan 	trace_workqueue_execute_end(work, worker->current_func);
3061725e8ec5STejun Heo 	pwq->stats[PWQ_STAT_COMPLETED]++;
30623295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
3063112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
30641da177e4SLinus Torvalds 
30651a65a6d1SXuewen Yan 	if (unlikely(in_atomic() || lockdep_depth(current) > 0 ||
30661a65a6d1SXuewen Yan 		     rcu_preempt_depth() > 0)) {
30671a65a6d1SXuewen Yan 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d/%d\n"
3068d75f773cSSakari Ailus 		       "     last function: %ps\n",
30691a65a6d1SXuewen Yan 		       current->comm, preempt_count(), rcu_preempt_depth(),
30701a65a6d1SXuewen Yan 		       task_pid_nr(current), worker->current_func);
3071d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
3072d5abe669SPeter Zijlstra 		dump_stack();
3073d5abe669SPeter Zijlstra 	}
3074d5abe669SPeter Zijlstra 
3075b22ce278STejun Heo 	/*
3076025f50f3SSebastian Andrzej Siewior 	 * The following prevents a kworker from hogging CPU on !PREEMPTION
3077b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
3078b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
3079b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
3080789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
3081789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
3082b22ce278STejun Heo 	 */
3083a7e6425eSPaul E. McKenney 	cond_resched();
3084b22ce278STejun Heo 
3085a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3086a62428c0STejun Heo 
3087616db877STejun Heo 	/*
3088616db877STejun Heo 	 * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked
3089616db877STejun Heo 	 * CPU intensive by wq_worker_tick() if @work hogged CPU longer than
3090616db877STejun Heo 	 * wq_cpu_intensive_thresh_us. Clear it.
3091616db877STejun Heo 	 */
3092fb0e7bebSTejun Heo 	worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
3093fb0e7bebSTejun Heo 
30941b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
30951b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
30961b69ac6bSJohannes Weiner 
3097a62428c0STejun Heo 	/* we're done with it, release */
309842f8570fSSasha Levin 	hash_del(&worker->hentry);
3099c34056a3STejun Heo 	worker->current_work = NULL;
3100a2c1c57bSTejun Heo 	worker->current_func = NULL;
3101112202d9STejun Heo 	worker->current_pwq = NULL;
3102d812796eSLai Jiangshan 	worker->current_color = INT_MAX;
3103dd6c3c54STejun Heo 
3104dd6c3c54STejun Heo 	/* must be the last step, see the function comment */
3105c4560c2cSLai Jiangshan 	pwq_dec_nr_in_flight(pwq, work_data);
31061da177e4SLinus Torvalds }
31071da177e4SLinus Torvalds 
3108affee4b2STejun Heo /**
3109affee4b2STejun Heo  * process_scheduled_works - process scheduled works
3110affee4b2STejun Heo  * @worker: self
3111affee4b2STejun Heo  *
3112affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
3113affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
3114affee4b2STejun Heo  * fetches a work from the top and executes it.
3115affee4b2STejun Heo  *
3116affee4b2STejun Heo  * CONTEXT:
3117a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3118affee4b2STejun Heo  * multiple times.
3119affee4b2STejun Heo  */
3120affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
31211da177e4SLinus Torvalds {
3122c0ab017dSTejun Heo 	struct work_struct *work;
3123c0ab017dSTejun Heo 	bool first = true;
3124c0ab017dSTejun Heo 
3125c0ab017dSTejun Heo 	while ((work = list_first_entry_or_null(&worker->scheduled,
3126c0ab017dSTejun Heo 						struct work_struct, entry))) {
3127c0ab017dSTejun Heo 		if (first) {
3128c0ab017dSTejun Heo 			worker->pool->watchdog_ts = jiffies;
3129c0ab017dSTejun Heo 			first = false;
3130c0ab017dSTejun Heo 		}
3131c34056a3STejun Heo 		process_one_work(worker, work);
3132a62428c0STejun Heo 	}
31331da177e4SLinus Torvalds }
31341da177e4SLinus Torvalds 
3135197f6accSTejun Heo static void set_pf_worker(bool val)
3136197f6accSTejun Heo {
3137197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3138197f6accSTejun Heo 	if (val)
3139197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
3140197f6accSTejun Heo 	else
3141197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
3142197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
3143197f6accSTejun Heo }
3144197f6accSTejun Heo 
31454690c4abSTejun Heo /**
31464690c4abSTejun Heo  * worker_thread - the worker thread function
3147c34056a3STejun Heo  * @__worker: self
31484690c4abSTejun Heo  *
3149c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
3150c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
3151c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
3152c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
3153c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
3154d185af30SYacine Belkadi  *
3155d185af30SYacine Belkadi  * Return: 0
31564690c4abSTejun Heo  */
3157c34056a3STejun Heo static int worker_thread(void *__worker)
31581da177e4SLinus Torvalds {
3159c34056a3STejun Heo 	struct worker *worker = __worker;
3160bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
31611da177e4SLinus Torvalds 
3162e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
3163197f6accSTejun Heo 	set_pf_worker(true);
3164c8e55f36STejun Heo woke_up:
3165a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3166affee4b2STejun Heo 
3167a9ab775bSTejun Heo 	/* am I supposed to die? */
3168a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
3169a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
3170197f6accSTejun Heo 		set_pf_worker(false);
317160f5a4bcSLai Jiangshan 
317260f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
3173e441b56fSZhen Lei 		ida_free(&pool->worker_ida, worker->id);
3174a2d812a2STejun Heo 		worker_detach_from_pool(worker);
3175e02b9312SValentin Schneider 		WARN_ON_ONCE(!list_empty(&worker->entry));
317660f5a4bcSLai Jiangshan 		kfree(worker);
3177c8e55f36STejun Heo 		return 0;
3178c8e55f36STejun Heo 	}
3179c8e55f36STejun Heo 
3180c8e55f36STejun Heo 	worker_leave_idle(worker);
3181db7bccf4STejun Heo recheck:
3182e22bee78STejun Heo 	/* no more worker necessary? */
318363d95a91STejun Heo 	if (!need_more_worker(pool))
3184e22bee78STejun Heo 		goto sleep;
3185e22bee78STejun Heo 
3186e22bee78STejun Heo 	/* do we need to manage? */
318763d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
3188e22bee78STejun Heo 		goto recheck;
3189e22bee78STejun Heo 
3190c8e55f36STejun Heo 	/*
3191c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
3192c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
3193c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
3194c8e55f36STejun Heo 	 */
31956183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
3196c8e55f36STejun Heo 
3197e22bee78STejun Heo 	/*
3198a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
3199a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
3200a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
3201a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
3202a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
3203e22bee78STejun Heo 	 */
3204a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
3205e22bee78STejun Heo 
3206e22bee78STejun Heo 	do {
3207affee4b2STejun Heo 		struct work_struct *work =
3208bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
3209affee4b2STejun Heo 					 struct work_struct, entry);
3210affee4b2STejun Heo 
3211873eaca6STejun Heo 		if (assign_work(work, worker, NULL))
3212affee4b2STejun Heo 			process_scheduled_works(worker);
321363d95a91STejun Heo 	} while (keep_working(pool));
3214affee4b2STejun Heo 
3215228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
3216d313dd85STejun Heo sleep:
3217c8e55f36STejun Heo 	/*
3218d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
3219d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
3220d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
3221d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
3222d565ed63STejun Heo 	 * event.
3223c8e55f36STejun Heo 	 */
3224c8e55f36STejun Heo 	worker_enter_idle(worker);
3225c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
3226a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
32271da177e4SLinus Torvalds 	schedule();
3228c8e55f36STejun Heo 	goto woke_up;
32291da177e4SLinus Torvalds }
32301da177e4SLinus Torvalds 
3231e22bee78STejun Heo /**
3232e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
3233111c225aSTejun Heo  * @__rescuer: self
3234e22bee78STejun Heo  *
3235e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
3236493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
3237e22bee78STejun Heo  *
3238706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
3239e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
3240e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
3241e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
3242e22bee78STejun Heo  * the problem rescuer solves.
3243e22bee78STejun Heo  *
3244706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
3245706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
3246e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
3247e22bee78STejun Heo  *
3248e22bee78STejun Heo  * This should happen rarely.
3249d185af30SYacine Belkadi  *
3250d185af30SYacine Belkadi  * Return: 0
3251e22bee78STejun Heo  */
3252111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
3253e22bee78STejun Heo {
3254111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
3255111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
32564d595b86SLai Jiangshan 	bool should_stop;
3257e22bee78STejun Heo 
3258e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
3259111c225aSTejun Heo 
3260111c225aSTejun Heo 	/*
3261111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
3262111c225aSTejun Heo 	 * doesn't participate in concurrency management.
3263111c225aSTejun Heo 	 */
3264197f6accSTejun Heo 	set_pf_worker(true);
3265e22bee78STejun Heo repeat:
3266c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
32671da177e4SLinus Torvalds 
32684d595b86SLai Jiangshan 	/*
32694d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
32704d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
32714d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
32724d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
32734d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
32744d595b86SLai Jiangshan 	 * list is always empty on exit.
32754d595b86SLai Jiangshan 	 */
32764d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
32771da177e4SLinus Torvalds 
3278493a1724STejun Heo 	/* see whether any pwq is asking for help */
3279a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq_mayday_lock);
3280493a1724STejun Heo 
3281493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
3282493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
3283493a1724STejun Heo 					struct pool_workqueue, mayday_node);
3284112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
3285e22bee78STejun Heo 		struct work_struct *work, *n;
3286e22bee78STejun Heo 
3287e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
3288493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
3289493a1724STejun Heo 
3290a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
3291e22bee78STejun Heo 
329251697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
329351697d39SLai Jiangshan 
3294a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
3295e22bee78STejun Heo 
3296e22bee78STejun Heo 		/*
3297e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
3298e22bee78STejun Heo 		 * process'em.
3299e22bee78STejun Heo 		 */
3300873eaca6STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
330182607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
3302873eaca6STejun Heo 			if (get_work_pwq(work) == pwq &&
3303873eaca6STejun Heo 			    assign_work(work, rescuer, &n))
3304725e8ec5STejun Heo 				pwq->stats[PWQ_STAT_RESCUED]++;
330582607adcSTejun Heo 		}
3306e22bee78STejun Heo 
3307873eaca6STejun Heo 		if (!list_empty(&rescuer->scheduled)) {
3308e22bee78STejun Heo 			process_scheduled_works(rescuer);
33097576958aSTejun Heo 
33107576958aSTejun Heo 			/*
3311008847f6SNeilBrown 			 * The above execution of rescued work items could
3312008847f6SNeilBrown 			 * have created more to rescue through
3313f97a4a1aSLai Jiangshan 			 * pwq_activate_first_inactive() or chained
3314008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
3315008847f6SNeilBrown 			 * that such back-to-back work items, which may be
3316008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
3317008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
3318008847f6SNeilBrown 			 */
33194f3f4cf3SLai Jiangshan 			if (pwq->nr_active && need_to_create_worker(pool)) {
3320a9b8a985SSebastian Andrzej Siewior 				raw_spin_lock(&wq_mayday_lock);
3321e66b39afSTejun Heo 				/*
3322e66b39afSTejun Heo 				 * Queue iff we aren't racing destruction
3323e66b39afSTejun Heo 				 * and somebody else hasn't queued it already.
3324e66b39afSTejun Heo 				 */
3325e66b39afSTejun Heo 				if (wq->rescuer && list_empty(&pwq->mayday_node)) {
3326008847f6SNeilBrown 					get_pwq(pwq);
3327e66b39afSTejun Heo 					list_add_tail(&pwq->mayday_node, &wq->maydays);
3328e66b39afSTejun Heo 				}
3329a9b8a985SSebastian Andrzej Siewior 				raw_spin_unlock(&wq_mayday_lock);
3330008847f6SNeilBrown 			}
3331008847f6SNeilBrown 		}
3332008847f6SNeilBrown 
3333008847f6SNeilBrown 		/*
333477668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
333513b1d625SLai Jiangshan 		 * go away while we're still attached to it.
333677668c8bSLai Jiangshan 		 */
333777668c8bSLai Jiangshan 		put_pwq(pwq);
333877668c8bSLai Jiangshan 
333977668c8bSLai Jiangshan 		/*
33400219a352STejun Heo 		 * Leave this pool. Notify regular workers; otherwise, we end up
33410219a352STejun Heo 		 * with 0 concurrency and stalling the execution.
33427576958aSTejun Heo 		 */
33430219a352STejun Heo 		kick_pool(pool);
33447576958aSTejun Heo 
3345a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
334613b1d625SLai Jiangshan 
3347a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
334813b1d625SLai Jiangshan 
3349a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
33501da177e4SLinus Torvalds 	}
33511da177e4SLinus Torvalds 
3352a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq_mayday_lock);
3353493a1724STejun Heo 
33544d595b86SLai Jiangshan 	if (should_stop) {
33554d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
3356197f6accSTejun Heo 		set_pf_worker(false);
33574d595b86SLai Jiangshan 		return 0;
33584d595b86SLai Jiangshan 	}
33594d595b86SLai Jiangshan 
3360111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
3361111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
3362e22bee78STejun Heo 	schedule();
3363e22bee78STejun Heo 	goto repeat;
33641da177e4SLinus Torvalds }
33651da177e4SLinus Torvalds 
3366fca839c0STejun Heo /**
3367fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
3368fca839c0STejun Heo  * @target_wq: workqueue being flushed
3369fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
3370fca839c0STejun Heo  *
3371fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
3372fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
3373fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
3374fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
3375fca839c0STejun Heo  * a deadlock.
3376fca839c0STejun Heo  */
3377fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
3378fca839c0STejun Heo 				   struct work_struct *target_work)
3379fca839c0STejun Heo {
3380fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
3381fca839c0STejun Heo 	struct worker *worker;
3382fca839c0STejun Heo 
3383fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
3384fca839c0STejun Heo 		return;
3385fca839c0STejun Heo 
3386fca839c0STejun Heo 	worker = current_wq_worker();
3387fca839c0STejun Heo 
3388fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
3389d75f773cSSakari Ailus 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
3390fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
339123d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
339223d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
3393d75f773cSSakari Ailus 		  "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
3394fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
3395fca839c0STejun Heo 		  target_wq->name, target_func);
3396fca839c0STejun Heo }
3397fca839c0STejun Heo 
3398fc2e4d70SOleg Nesterov struct wq_barrier {
3399fc2e4d70SOleg Nesterov 	struct work_struct	work;
3400fc2e4d70SOleg Nesterov 	struct completion	done;
34012607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
3402fc2e4d70SOleg Nesterov };
3403fc2e4d70SOleg Nesterov 
3404fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
3405fc2e4d70SOleg Nesterov {
3406fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
3407fc2e4d70SOleg Nesterov 	complete(&barr->done);
3408fc2e4d70SOleg Nesterov }
3409fc2e4d70SOleg Nesterov 
34104690c4abSTejun Heo /**
34114690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
3412112202d9STejun Heo  * @pwq: pwq to insert barrier into
34134690c4abSTejun Heo  * @barr: wq_barrier to insert
3414affee4b2STejun Heo  * @target: target work to attach @barr to
3415affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
34164690c4abSTejun Heo  *
3417affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
3418affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
3419affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
3420affee4b2STejun Heo  * cpu.
3421affee4b2STejun Heo  *
3422affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
3423affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
3424affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
3425affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
3426affee4b2STejun Heo  * after a work with LINKED flag set.
3427affee4b2STejun Heo  *
3428affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
3429112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
34304690c4abSTejun Heo  *
34314690c4abSTejun Heo  * CONTEXT:
3432a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
34334690c4abSTejun Heo  */
3434112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
3435affee4b2STejun Heo 			      struct wq_barrier *barr,
3436affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
3437fc2e4d70SOleg Nesterov {
3438d812796eSLai Jiangshan 	unsigned int work_flags = 0;
3439d812796eSLai Jiangshan 	unsigned int work_color;
3440affee4b2STejun Heo 	struct list_head *head;
3441affee4b2STejun Heo 
3442dc186ad7SThomas Gleixner 	/*
3443d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
3444dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
3445dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
3446dc186ad7SThomas Gleixner 	 * might deadlock.
3447dc186ad7SThomas Gleixner 	 */
3448ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
344922df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
345052fa5bc5SBoqun Feng 
3451fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
3452fd1a5b04SByungchul Park 
34532607d7a6STejun Heo 	barr->task = current;
345483c22520SOleg Nesterov 
34555797b1c1STejun Heo 	/* The barrier work item does not participate in nr_active. */
3456018f3a13SLai Jiangshan 	work_flags |= WORK_STRUCT_INACTIVE;
3457018f3a13SLai Jiangshan 
3458affee4b2STejun Heo 	/*
3459affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
3460affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
3461affee4b2STejun Heo 	 */
3462d812796eSLai Jiangshan 	if (worker) {
3463affee4b2STejun Heo 		head = worker->scheduled.next;
3464d812796eSLai Jiangshan 		work_color = worker->current_color;
3465d812796eSLai Jiangshan 	} else {
3466affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
3467affee4b2STejun Heo 
3468affee4b2STejun Heo 		head = target->entry.next;
3469affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
3470d21cece0SLai Jiangshan 		work_flags |= *bits & WORK_STRUCT_LINKED;
3471d812796eSLai Jiangshan 		work_color = get_work_color(*bits);
3472affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
3473affee4b2STejun Heo 	}
3474affee4b2STejun Heo 
3475d812796eSLai Jiangshan 	pwq->nr_in_flight[work_color]++;
3476d812796eSLai Jiangshan 	work_flags |= work_color_to_flags(work_color);
3477d812796eSLai Jiangshan 
3478d21cece0SLai Jiangshan 	insert_work(pwq, &barr->work, head, work_flags);
3479fc2e4d70SOleg Nesterov }
3480fc2e4d70SOleg Nesterov 
348173f53c4aSTejun Heo /**
3482112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
348373f53c4aSTejun Heo  * @wq: workqueue being flushed
348473f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
348573f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
348673f53c4aSTejun Heo  *
3487112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
348873f53c4aSTejun Heo  *
3489112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
3490112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
3491112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
3492112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
3493112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
349473f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
349573f53c4aSTejun Heo  *
349673f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
349773f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
349873f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
349973f53c4aSTejun Heo  * is returned.
350073f53c4aSTejun Heo  *
3501112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
350273f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
350373f53c4aSTejun Heo  * advanced to @work_color.
350473f53c4aSTejun Heo  *
350573f53c4aSTejun Heo  * CONTEXT:
35063c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
350773f53c4aSTejun Heo  *
3508d185af30SYacine Belkadi  * Return:
350973f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
351073f53c4aSTejun Heo  * otherwise.
351173f53c4aSTejun Heo  */
3512112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
351373f53c4aSTejun Heo 				      int flush_color, int work_color)
35141da177e4SLinus Torvalds {
351573f53c4aSTejun Heo 	bool wait = false;
351649e3cf44STejun Heo 	struct pool_workqueue *pwq;
35171da177e4SLinus Torvalds 
351873f53c4aSTejun Heo 	if (flush_color >= 0) {
35196183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
3520112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
3521dc186ad7SThomas Gleixner 	}
352214441960SOleg Nesterov 
352349e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3524112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
35251da177e4SLinus Torvalds 
3526a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
352773f53c4aSTejun Heo 
352873f53c4aSTejun Heo 		if (flush_color >= 0) {
35296183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
353073f53c4aSTejun Heo 
3531112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
3532112202d9STejun Heo 				pwq->flush_color = flush_color;
3533112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
353473f53c4aSTejun Heo 				wait = true;
35351da177e4SLinus Torvalds 			}
353673f53c4aSTejun Heo 		}
353773f53c4aSTejun Heo 
353873f53c4aSTejun Heo 		if (work_color >= 0) {
35396183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
3540112202d9STejun Heo 			pwq->work_color = work_color;
354173f53c4aSTejun Heo 		}
354273f53c4aSTejun Heo 
3543a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
35441da177e4SLinus Torvalds 	}
35451da177e4SLinus Torvalds 
3546112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
354773f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
354873f53c4aSTejun Heo 
354973f53c4aSTejun Heo 	return wait;
355083c22520SOleg Nesterov }
35511da177e4SLinus Torvalds 
35520fcb78c2SRolf Eike Beer /**
3553c4f135d6STetsuo Handa  * __flush_workqueue - ensure that any scheduled work has run to completion.
35540fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
35551da177e4SLinus Torvalds  *
3556c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
3557c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
35581da177e4SLinus Torvalds  */
3559c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq)
35601da177e4SLinus Torvalds {
356173f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
356273f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
356373f53c4aSTejun Heo 		.flush_color = -1,
3564fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
356573f53c4aSTejun Heo 	};
356673f53c4aSTejun Heo 	int next_color;
3567b1f4ec17SOleg Nesterov 
35683347fa09STejun Heo 	if (WARN_ON(!wq_online))
35693347fa09STejun Heo 		return;
35703347fa09STejun Heo 
357187915adcSJohannes Berg 	lock_map_acquire(&wq->lockdep_map);
357287915adcSJohannes Berg 	lock_map_release(&wq->lockdep_map);
357387915adcSJohannes Berg 
35743c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
357573f53c4aSTejun Heo 
357673f53c4aSTejun Heo 	/*
357773f53c4aSTejun Heo 	 * Start-to-wait phase
357873f53c4aSTejun Heo 	 */
357973f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
358073f53c4aSTejun Heo 
358173f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
358273f53c4aSTejun Heo 		/*
358373f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
358473f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
358573f53c4aSTejun Heo 		 * by one.
358673f53c4aSTejun Heo 		 */
35876183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
358873f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
358973f53c4aSTejun Heo 		wq->work_color = next_color;
359073f53c4aSTejun Heo 
359173f53c4aSTejun Heo 		if (!wq->first_flusher) {
359273f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
35936183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
359473f53c4aSTejun Heo 
359573f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
359673f53c4aSTejun Heo 
3597112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
359873f53c4aSTejun Heo 						       wq->work_color)) {
359973f53c4aSTejun Heo 				/* nothing to flush, done */
360073f53c4aSTejun Heo 				wq->flush_color = next_color;
360173f53c4aSTejun Heo 				wq->first_flusher = NULL;
360273f53c4aSTejun Heo 				goto out_unlock;
360373f53c4aSTejun Heo 			}
360473f53c4aSTejun Heo 		} else {
360573f53c4aSTejun Heo 			/* wait in queue */
36066183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
360773f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
3608112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
360973f53c4aSTejun Heo 		}
361073f53c4aSTejun Heo 	} else {
361173f53c4aSTejun Heo 		/*
361273f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
361373f53c4aSTejun Heo 		 * The next flush completion will assign us
361473f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
361573f53c4aSTejun Heo 		 */
361673f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
361773f53c4aSTejun Heo 	}
361873f53c4aSTejun Heo 
3619fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
3620fca839c0STejun Heo 
36213c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
362273f53c4aSTejun Heo 
362373f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
362473f53c4aSTejun Heo 
362573f53c4aSTejun Heo 	/*
362673f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
362773f53c4aSTejun Heo 	 *
362873f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
362973f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
363073f53c4aSTejun Heo 	 */
363100d5d15bSChris Wilson 	if (READ_ONCE(wq->first_flusher) != &this_flusher)
363273f53c4aSTejun Heo 		return;
363373f53c4aSTejun Heo 
36343c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
363573f53c4aSTejun Heo 
36364ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
36374ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
36384ce48b37STejun Heo 		goto out_unlock;
36394ce48b37STejun Heo 
364000d5d15bSChris Wilson 	WRITE_ONCE(wq->first_flusher, NULL);
364173f53c4aSTejun Heo 
36426183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
36436183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
364473f53c4aSTejun Heo 
364573f53c4aSTejun Heo 	while (true) {
364673f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
364773f53c4aSTejun Heo 
364873f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
364973f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
365073f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
365173f53c4aSTejun Heo 				break;
365273f53c4aSTejun Heo 			list_del_init(&next->list);
365373f53c4aSTejun Heo 			complete(&next->done);
365473f53c4aSTejun Heo 		}
365573f53c4aSTejun Heo 
36566183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
365773f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
365873f53c4aSTejun Heo 
365973f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
366073f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
366173f53c4aSTejun Heo 
366273f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
366373f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
366473f53c4aSTejun Heo 			/*
366573f53c4aSTejun Heo 			 * Assign the same color to all overflowed
366673f53c4aSTejun Heo 			 * flushers, advance work_color and append to
366773f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
366873f53c4aSTejun Heo 			 * phase for these overflowed flushers.
366973f53c4aSTejun Heo 			 */
367073f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
367173f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
367273f53c4aSTejun Heo 
367373f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
367473f53c4aSTejun Heo 
367573f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
367673f53c4aSTejun Heo 					      &wq->flusher_queue);
3677112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
367873f53c4aSTejun Heo 		}
367973f53c4aSTejun Heo 
368073f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
36816183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
368273f53c4aSTejun Heo 			break;
368373f53c4aSTejun Heo 		}
368473f53c4aSTejun Heo 
368573f53c4aSTejun Heo 		/*
368673f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
3687112202d9STejun Heo 		 * the new first flusher and arm pwqs.
368873f53c4aSTejun Heo 		 */
36896183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
36906183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
369173f53c4aSTejun Heo 
369273f53c4aSTejun Heo 		list_del_init(&next->list);
369373f53c4aSTejun Heo 		wq->first_flusher = next;
369473f53c4aSTejun Heo 
3695112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
369673f53c4aSTejun Heo 			break;
369773f53c4aSTejun Heo 
369873f53c4aSTejun Heo 		/*
369973f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
370073f53c4aSTejun Heo 		 * flusher and repeat cascading.
370173f53c4aSTejun Heo 		 */
370273f53c4aSTejun Heo 		wq->first_flusher = NULL;
370373f53c4aSTejun Heo 	}
370473f53c4aSTejun Heo 
370573f53c4aSTejun Heo out_unlock:
37063c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
37071da177e4SLinus Torvalds }
3708c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue);
37091da177e4SLinus Torvalds 
37109c5a2ba7STejun Heo /**
37119c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
37129c5a2ba7STejun Heo  * @wq: workqueue to drain
37139c5a2ba7STejun Heo  *
37149c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
37159c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
37169c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
3717b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
37189c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
37199c5a2ba7STejun Heo  * takes too long.
37209c5a2ba7STejun Heo  */
37219c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
37229c5a2ba7STejun Heo {
37239c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
372449e3cf44STejun Heo 	struct pool_workqueue *pwq;
37259c5a2ba7STejun Heo 
37269c5a2ba7STejun Heo 	/*
37279c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
37289c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
3729618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
37309c5a2ba7STejun Heo 	 */
373187fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
37329c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
3733618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
373487fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
37359c5a2ba7STejun Heo reflush:
3736c4f135d6STetsuo Handa 	__flush_workqueue(wq);
37379c5a2ba7STejun Heo 
3738b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
373976af4d93STejun Heo 
374049e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3741fa2563e4SThomas Tuttle 		bool drained;
37429c5a2ba7STejun Heo 
3743a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
3744afa87ce8STejun Heo 		drained = pwq_is_empty(pwq);
3745a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
3746fa2563e4SThomas Tuttle 
3747fa2563e4SThomas Tuttle 		if (drained)
37489c5a2ba7STejun Heo 			continue;
37499c5a2ba7STejun Heo 
37509c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
37519c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3752e9ad2eb3SStephen Zhang 			pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3753e9ad2eb3SStephen Zhang 				wq->name, __func__, flush_cnt);
375476af4d93STejun Heo 
3755b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
37569c5a2ba7STejun Heo 		goto reflush;
37579c5a2ba7STejun Heo 	}
37589c5a2ba7STejun Heo 
37599c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
3760618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
376187fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
37629c5a2ba7STejun Heo }
37639c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
37649c5a2ba7STejun Heo 
3765d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3766d6e89786SJohannes Berg 			     bool from_cancel)
3767baf59022STejun Heo {
3768baf59022STejun Heo 	struct worker *worker = NULL;
3769c9e7cf27STejun Heo 	struct worker_pool *pool;
3770112202d9STejun Heo 	struct pool_workqueue *pwq;
3771baf59022STejun Heo 
3772baf59022STejun Heo 	might_sleep();
3773baf59022STejun Heo 
377424acfb71SThomas Gleixner 	rcu_read_lock();
3775fa1b54e6STejun Heo 	pool = get_work_pool(work);
3776fa1b54e6STejun Heo 	if (!pool) {
377724acfb71SThomas Gleixner 		rcu_read_unlock();
3778fa1b54e6STejun Heo 		return false;
3779fa1b54e6STejun Heo 	}
3780fa1b54e6STejun Heo 
3781a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
37820b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
3783112202d9STejun Heo 	pwq = get_work_pwq(work);
3784112202d9STejun Heo 	if (pwq) {
3785112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
3786baf59022STejun Heo 			goto already_gone;
3787606a5020STejun Heo 	} else {
3788c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
3789baf59022STejun Heo 		if (!worker)
3790baf59022STejun Heo 			goto already_gone;
3791112202d9STejun Heo 		pwq = worker->current_pwq;
3792606a5020STejun Heo 	}
3793baf59022STejun Heo 
3794fca839c0STejun Heo 	check_flush_dependency(pwq->wq, work);
3795fca839c0STejun Heo 
3796112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
3797a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3798baf59022STejun Heo 
3799e159489bSTejun Heo 	/*
3800a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
3801a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
3802a1d14934SPeter Zijlstra 	 *
3803a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
3804a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
3805a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
3806a1d14934SPeter Zijlstra 	 * forward progress.
3807e159489bSTejun Heo 	 */
3808d6e89786SJohannes Berg 	if (!from_cancel &&
3809d6e89786SJohannes Berg 	    (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3810112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
3811112202d9STejun Heo 		lock_map_release(&pwq->wq->lockdep_map);
3812a1d14934SPeter Zijlstra 	}
381324acfb71SThomas Gleixner 	rcu_read_unlock();
3814baf59022STejun Heo 	return true;
3815baf59022STejun Heo already_gone:
3816a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
381724acfb71SThomas Gleixner 	rcu_read_unlock();
3818baf59022STejun Heo 	return false;
3819baf59022STejun Heo }
3820baf59022STejun Heo 
3821d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
3822d6e89786SJohannes Berg {
3823d6e89786SJohannes Berg 	struct wq_barrier barr;
3824d6e89786SJohannes Berg 
3825d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
3826d6e89786SJohannes Berg 		return false;
3827d6e89786SJohannes Berg 
38284d43d395STetsuo Handa 	if (WARN_ON(!work->func))
38294d43d395STetsuo Handa 		return false;
38304d43d395STetsuo Handa 
383187915adcSJohannes Berg 	lock_map_acquire(&work->lockdep_map);
383287915adcSJohannes Berg 	lock_map_release(&work->lockdep_map);
383387915adcSJohannes Berg 
3834d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
3835d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
3836d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
3837d6e89786SJohannes Berg 		return true;
3838d6e89786SJohannes Berg 	} else {
3839d6e89786SJohannes Berg 		return false;
3840d6e89786SJohannes Berg 	}
3841d6e89786SJohannes Berg }
3842d6e89786SJohannes Berg 
3843db700897SOleg Nesterov /**
3844401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
3845401a8d04STejun Heo  * @work: the work to flush
3846db700897SOleg Nesterov  *
3847606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
3848606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
3849401a8d04STejun Heo  *
3850d185af30SYacine Belkadi  * Return:
3851401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3852401a8d04STejun Heo  * %false if it was already idle.
3853db700897SOleg Nesterov  */
3854401a8d04STejun Heo bool flush_work(struct work_struct *work)
3855db700897SOleg Nesterov {
3856d6e89786SJohannes Berg 	return __flush_work(work, false);
3857606a5020STejun Heo }
3858db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
3859db700897SOleg Nesterov 
38608603e1b3STejun Heo struct cwt_wait {
3861ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
38628603e1b3STejun Heo 	struct work_struct	*work;
38638603e1b3STejun Heo };
38648603e1b3STejun Heo 
3865ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
38668603e1b3STejun Heo {
38678603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
38688603e1b3STejun Heo 
38698603e1b3STejun Heo 	if (cwait->work != key)
38708603e1b3STejun Heo 		return 0;
38718603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
38728603e1b3STejun Heo }
38738603e1b3STejun Heo 
387436e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3875401a8d04STejun Heo {
38768603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3877bbb68dfaSTejun Heo 	unsigned long flags;
38781f1f642eSOleg Nesterov 	int ret;
38791f1f642eSOleg Nesterov 
38801f1f642eSOleg Nesterov 	do {
3881bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
3882bbb68dfaSTejun Heo 		/*
38838603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
38848603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
38858603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
38868603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
38878603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
38888603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
38898603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
38908603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
38918603e1b3STejun Heo 		 * we're hogging the CPU.
38928603e1b3STejun Heo 		 *
38938603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
38948603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
38958603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
38968603e1b3STejun Heo 		 * wait and wakeup.
3897bbb68dfaSTejun Heo 		 */
38988603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
38998603e1b3STejun Heo 			struct cwt_wait cwait;
39008603e1b3STejun Heo 
39018603e1b3STejun Heo 			init_wait(&cwait.wait);
39028603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
39038603e1b3STejun Heo 			cwait.work = work;
39048603e1b3STejun Heo 
39058603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
39068603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
39078603e1b3STejun Heo 			if (work_is_canceling(work))
39088603e1b3STejun Heo 				schedule();
39098603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
39108603e1b3STejun Heo 		}
39111f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
39121f1f642eSOleg Nesterov 
3913bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
3914bbb68dfaSTejun Heo 	mark_work_canceling(work);
3915bbb68dfaSTejun Heo 	local_irq_restore(flags);
3916bbb68dfaSTejun Heo 
39173347fa09STejun Heo 	/*
39183347fa09STejun Heo 	 * This allows canceling during early boot.  We know that @work
39193347fa09STejun Heo 	 * isn't executing.
39203347fa09STejun Heo 	 */
39213347fa09STejun Heo 	if (wq_online)
3922d6e89786SJohannes Berg 		__flush_work(work, true);
39233347fa09STejun Heo 
39247a22ad75STejun Heo 	clear_work_data(work);
39258603e1b3STejun Heo 
39268603e1b3STejun Heo 	/*
39278603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
39288603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
39298603e1b3STejun Heo 	 * visible there.
39308603e1b3STejun Heo 	 */
39318603e1b3STejun Heo 	smp_mb();
39328603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
39338603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
39348603e1b3STejun Heo 
39351f1f642eSOleg Nesterov 	return ret;
39361f1f642eSOleg Nesterov }
39371f1f642eSOleg Nesterov 
39386e84d644SOleg Nesterov /**
3939401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
3940401a8d04STejun Heo  * @work: the work to cancel
39416e84d644SOleg Nesterov  *
3942401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
3943401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
3944401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
3945401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
39461f1f642eSOleg Nesterov  *
3947401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
3948401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
39496e84d644SOleg Nesterov  *
3950401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
39516e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
3952401a8d04STejun Heo  *
3953d185af30SYacine Belkadi  * Return:
3954401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
39556e84d644SOleg Nesterov  */
3956401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
39576e84d644SOleg Nesterov {
395836e227d2STejun Heo 	return __cancel_work_timer(work, false);
3959b89deed3SOleg Nesterov }
396028e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
3961b89deed3SOleg Nesterov 
39626e84d644SOleg Nesterov /**
3963401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
3964401a8d04STejun Heo  * @dwork: the delayed work to flush
39656e84d644SOleg Nesterov  *
3966401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
3967401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
3968401a8d04STejun Heo  * considers the last queueing instance of @dwork.
39691f1f642eSOleg Nesterov  *
3970d185af30SYacine Belkadi  * Return:
3971401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3972401a8d04STejun Heo  * %false if it was already idle.
39736e84d644SOleg Nesterov  */
3974401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
3975401a8d04STejun Heo {
39768930cabaSTejun Heo 	local_irq_disable();
3977401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
397860c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
39798930cabaSTejun Heo 	local_irq_enable();
3980401a8d04STejun Heo 	return flush_work(&dwork->work);
3981401a8d04STejun Heo }
3982401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3983401a8d04STejun Heo 
398405f0fe6bSTejun Heo /**
398505f0fe6bSTejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
398605f0fe6bSTejun Heo  * @rwork: the rcu work to flush
398705f0fe6bSTejun Heo  *
398805f0fe6bSTejun Heo  * Return:
398905f0fe6bSTejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
399005f0fe6bSTejun Heo  * %false if it was already idle.
399105f0fe6bSTejun Heo  */
399205f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork)
399305f0fe6bSTejun Heo {
399405f0fe6bSTejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
399505f0fe6bSTejun Heo 		rcu_barrier();
399605f0fe6bSTejun Heo 		flush_work(&rwork->work);
399705f0fe6bSTejun Heo 		return true;
399805f0fe6bSTejun Heo 	} else {
399905f0fe6bSTejun Heo 		return flush_work(&rwork->work);
400005f0fe6bSTejun Heo 	}
400105f0fe6bSTejun Heo }
400205f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work);
400305f0fe6bSTejun Heo 
4004f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork)
4005f72b8792SJens Axboe {
4006f72b8792SJens Axboe 	unsigned long flags;
4007f72b8792SJens Axboe 	int ret;
4008f72b8792SJens Axboe 
4009f72b8792SJens Axboe 	do {
4010f72b8792SJens Axboe 		ret = try_to_grab_pending(work, is_dwork, &flags);
4011f72b8792SJens Axboe 	} while (unlikely(ret == -EAGAIN));
4012f72b8792SJens Axboe 
4013f72b8792SJens Axboe 	if (unlikely(ret < 0))
4014f72b8792SJens Axboe 		return false;
4015f72b8792SJens Axboe 
4016f72b8792SJens Axboe 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
4017f72b8792SJens Axboe 	local_irq_restore(flags);
4018f72b8792SJens Axboe 	return ret;
4019f72b8792SJens Axboe }
4020f72b8792SJens Axboe 
402173b4b532SAndrey Grodzovsky /*
402273b4b532SAndrey Grodzovsky  * See cancel_delayed_work()
402373b4b532SAndrey Grodzovsky  */
402473b4b532SAndrey Grodzovsky bool cancel_work(struct work_struct *work)
402573b4b532SAndrey Grodzovsky {
402673b4b532SAndrey Grodzovsky 	return __cancel_work(work, false);
402773b4b532SAndrey Grodzovsky }
402873b4b532SAndrey Grodzovsky EXPORT_SYMBOL(cancel_work);
402973b4b532SAndrey Grodzovsky 
4030401a8d04STejun Heo /**
403157b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
403257b30ae7STejun Heo  * @dwork: delayed_work to cancel
403309383498STejun Heo  *
4034d185af30SYacine Belkadi  * Kill off a pending delayed_work.
4035d185af30SYacine Belkadi  *
4036d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
4037d185af30SYacine Belkadi  * pending.
4038d185af30SYacine Belkadi  *
4039d185af30SYacine Belkadi  * Note:
4040d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
4041d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
4042d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
404309383498STejun Heo  *
404457b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
404509383498STejun Heo  */
404657b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
404709383498STejun Heo {
4048f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
404909383498STejun Heo }
405057b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
405109383498STejun Heo 
405209383498STejun Heo /**
4053401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
4054401a8d04STejun Heo  * @dwork: the delayed work cancel
4055401a8d04STejun Heo  *
4056401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
4057401a8d04STejun Heo  *
4058d185af30SYacine Belkadi  * Return:
4059401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
4060401a8d04STejun Heo  */
4061401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
40626e84d644SOleg Nesterov {
406336e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
40646e84d644SOleg Nesterov }
4065f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
40661da177e4SLinus Torvalds 
40670fcb78c2SRolf Eike Beer /**
406831ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
4069b6136773SAndrew Morton  * @func: the function to call
4070b6136773SAndrew Morton  *
407131ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
407231ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
4073b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
407431ddd871STejun Heo  *
4075d185af30SYacine Belkadi  * Return:
407631ddd871STejun Heo  * 0 on success, -errno on failure.
4077b6136773SAndrew Morton  */
407865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
407915316ba8SChristoph Lameter {
408015316ba8SChristoph Lameter 	int cpu;
408138f51568SNamhyung Kim 	struct work_struct __percpu *works;
408215316ba8SChristoph Lameter 
4083b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
4084b6136773SAndrew Morton 	if (!works)
408515316ba8SChristoph Lameter 		return -ENOMEM;
4086b6136773SAndrew Morton 
4087ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
408893981800STejun Heo 
408915316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
40909bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
40919bfb1839SIngo Molnar 
40929bfb1839SIngo Molnar 		INIT_WORK(work, func);
40938de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
409415316ba8SChristoph Lameter 	}
409593981800STejun Heo 
409693981800STejun Heo 	for_each_online_cpu(cpu)
40978616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
409893981800STejun Heo 
4099ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4100b6136773SAndrew Morton 	free_percpu(works);
410115316ba8SChristoph Lameter 	return 0;
410215316ba8SChristoph Lameter }
410315316ba8SChristoph Lameter 
4104eef6a7d5SAlan Stern /**
41051fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
41061fa44ecaSJames Bottomley  * @fn:		the function to execute
41071fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
41081fa44ecaSJames Bottomley  *		be available when the work executes)
41091fa44ecaSJames Bottomley  *
41101fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
41111fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
41121fa44ecaSJames Bottomley  *
4113d185af30SYacine Belkadi  * Return:	0 - function was executed
41141fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
41151fa44ecaSJames Bottomley  */
411665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
41171fa44ecaSJames Bottomley {
41181fa44ecaSJames Bottomley 	if (!in_interrupt()) {
411965f27f38SDavid Howells 		fn(&ew->work);
41201fa44ecaSJames Bottomley 		return 0;
41211fa44ecaSJames Bottomley 	}
41221fa44ecaSJames Bottomley 
412365f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
41241fa44ecaSJames Bottomley 	schedule_work(&ew->work);
41251fa44ecaSJames Bottomley 
41261fa44ecaSJames Bottomley 	return 1;
41271fa44ecaSJames Bottomley }
41281fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
41291fa44ecaSJames Bottomley 
41307a4e344cSTejun Heo /**
41317a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
41327a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
41337a4e344cSTejun Heo  *
41347a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
41357a4e344cSTejun Heo  */
4136513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs)
41377a4e344cSTejun Heo {
41387a4e344cSTejun Heo 	if (attrs) {
41397a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
41409546b29eSTejun Heo 		free_cpumask_var(attrs->__pod_cpumask);
41417a4e344cSTejun Heo 		kfree(attrs);
41427a4e344cSTejun Heo 	}
41437a4e344cSTejun Heo }
41447a4e344cSTejun Heo 
41457a4e344cSTejun Heo /**
41467a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
41477a4e344cSTejun Heo  *
41487a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
4149d185af30SYacine Belkadi  * return it.
4150d185af30SYacine Belkadi  *
4151d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
41527a4e344cSTejun Heo  */
4153513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void)
41547a4e344cSTejun Heo {
41557a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
41567a4e344cSTejun Heo 
4157be69d00dSThomas Gleixner 	attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
41587a4e344cSTejun Heo 	if (!attrs)
41597a4e344cSTejun Heo 		goto fail;
4160be69d00dSThomas Gleixner 	if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
41617a4e344cSTejun Heo 		goto fail;
41629546b29eSTejun Heo 	if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL))
41639546b29eSTejun Heo 		goto fail;
41647a4e344cSTejun Heo 
416513e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
4166523a301eSTejun Heo 	attrs->affn_scope = WQ_AFFN_DFL;
41677a4e344cSTejun Heo 	return attrs;
41687a4e344cSTejun Heo fail:
41697a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
41707a4e344cSTejun Heo 	return NULL;
41717a4e344cSTejun Heo }
41727a4e344cSTejun Heo 
417329c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
417429c91e99STejun Heo 				 const struct workqueue_attrs *from)
417529c91e99STejun Heo {
417629c91e99STejun Heo 	to->nice = from->nice;
417729c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
41789546b29eSTejun Heo 	cpumask_copy(to->__pod_cpumask, from->__pod_cpumask);
41798639ecebSTejun Heo 	to->affn_strict = from->affn_strict;
418084193c07STejun Heo 
41812865a8fbSShaohua Li 	/*
418284193c07STejun Heo 	 * Unlike hash and equality test, copying shouldn't ignore wq-only
418384193c07STejun Heo 	 * fields as copying is used for both pool and wq attrs. Instead,
418484193c07STejun Heo 	 * get_unbound_pool() explicitly clears the fields.
41852865a8fbSShaohua Li 	 */
418684193c07STejun Heo 	to->affn_scope = from->affn_scope;
4187af73f5c9STejun Heo 	to->ordered = from->ordered;
418829c91e99STejun Heo }
418929c91e99STejun Heo 
41905de7a03cSTejun Heo /*
41915de7a03cSTejun Heo  * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the
41925de7a03cSTejun Heo  * comments in 'struct workqueue_attrs' definition.
41935de7a03cSTejun Heo  */
41945de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs)
41955de7a03cSTejun Heo {
419684193c07STejun Heo 	attrs->affn_scope = WQ_AFFN_NR_TYPES;
41975de7a03cSTejun Heo 	attrs->ordered = false;
41985de7a03cSTejun Heo }
41995de7a03cSTejun Heo 
420029c91e99STejun Heo /* hash value of the content of @attr */
420129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
420229c91e99STejun Heo {
420329c91e99STejun Heo 	u32 hash = 0;
420429c91e99STejun Heo 
420529c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
420613e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
420713e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
42089546b29eSTejun Heo 	hash = jhash(cpumask_bits(attrs->__pod_cpumask),
42099546b29eSTejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
42108639ecebSTejun Heo 	hash = jhash_1word(attrs->affn_strict, hash);
421129c91e99STejun Heo 	return hash;
421229c91e99STejun Heo }
421329c91e99STejun Heo 
421429c91e99STejun Heo /* content equality test */
421529c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
421629c91e99STejun Heo 			  const struct workqueue_attrs *b)
421729c91e99STejun Heo {
421829c91e99STejun Heo 	if (a->nice != b->nice)
421929c91e99STejun Heo 		return false;
422029c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
422129c91e99STejun Heo 		return false;
42229546b29eSTejun Heo 	if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask))
42239546b29eSTejun Heo 		return false;
42248639ecebSTejun Heo 	if (a->affn_strict != b->affn_strict)
42258639ecebSTejun Heo 		return false;
422629c91e99STejun Heo 	return true;
422729c91e99STejun Heo }
422829c91e99STejun Heo 
42290f36ee24STejun Heo /* Update @attrs with actually available CPUs */
42300f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs,
42310f36ee24STejun Heo 				      const cpumask_t *unbound_cpumask)
42320f36ee24STejun Heo {
42330f36ee24STejun Heo 	/*
42340f36ee24STejun Heo 	 * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If
42350f36ee24STejun Heo 	 * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to
42360f36ee24STejun Heo 	 * @unbound_cpumask.
42370f36ee24STejun Heo 	 */
42380f36ee24STejun Heo 	cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask);
42390f36ee24STejun Heo 	if (unlikely(cpumask_empty(attrs->cpumask)))
42400f36ee24STejun Heo 		cpumask_copy(attrs->cpumask, unbound_cpumask);
42410f36ee24STejun Heo }
42420f36ee24STejun Heo 
424384193c07STejun Heo /* find wq_pod_type to use for @attrs */
424484193c07STejun Heo static const struct wq_pod_type *
424584193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs)
424684193c07STejun Heo {
4247523a301eSTejun Heo 	enum wq_affn_scope scope;
4248523a301eSTejun Heo 	struct wq_pod_type *pt;
4249523a301eSTejun Heo 
4250523a301eSTejun Heo 	/* to synchronize access to wq_affn_dfl */
4251523a301eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4252523a301eSTejun Heo 
4253523a301eSTejun Heo 	if (attrs->affn_scope == WQ_AFFN_DFL)
4254523a301eSTejun Heo 		scope = wq_affn_dfl;
4255523a301eSTejun Heo 	else
4256523a301eSTejun Heo 		scope = attrs->affn_scope;
4257523a301eSTejun Heo 
4258523a301eSTejun Heo 	pt = &wq_pod_types[scope];
425984193c07STejun Heo 
426084193c07STejun Heo 	if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) &&
426184193c07STejun Heo 	    likely(pt->nr_pods))
426284193c07STejun Heo 		return pt;
426384193c07STejun Heo 
426484193c07STejun Heo 	/*
426584193c07STejun Heo 	 * Before workqueue_init_topology(), only SYSTEM is available which is
426684193c07STejun Heo 	 * initialized in workqueue_init_early().
426784193c07STejun Heo 	 */
426884193c07STejun Heo 	pt = &wq_pod_types[WQ_AFFN_SYSTEM];
426984193c07STejun Heo 	BUG_ON(!pt->nr_pods);
427084193c07STejun Heo 	return pt;
427184193c07STejun Heo }
427284193c07STejun Heo 
42737a4e344cSTejun Heo /**
42747a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
42757a4e344cSTejun Heo  * @pool: worker_pool to initialize
42767a4e344cSTejun Heo  *
4277402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
4278d185af30SYacine Belkadi  *
4279d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
428029c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
428129c91e99STejun Heo  * on @pool safely to release it.
42827a4e344cSTejun Heo  */
42837a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
42844e1a1f9aSTejun Heo {
4285a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_init(&pool->lock);
428629c91e99STejun Heo 	pool->id = -1;
428729c91e99STejun Heo 	pool->cpu = -1;
4288f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
42894e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
429082607adcSTejun Heo 	pool->watchdog_ts = jiffies;
42914e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
42924e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
42934e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
42944e1a1f9aSTejun Heo 
429532a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
42963f959aa3SValentin Schneider 	INIT_WORK(&pool->idle_cull_work, idle_cull_fn);
42974e1a1f9aSTejun Heo 
429832a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
42994e1a1f9aSTejun Heo 
4300da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
4301e02b9312SValentin Schneider 	INIT_LIST_HEAD(&pool->dying_workers);
43027a4e344cSTejun Heo 
43037cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
430429c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
430529c91e99STejun Heo 	pool->refcnt = 1;
430629c91e99STejun Heo 
430729c91e99STejun Heo 	/* shouldn't fail above this point */
4308be69d00dSThomas Gleixner 	pool->attrs = alloc_workqueue_attrs();
43097a4e344cSTejun Heo 	if (!pool->attrs)
43107a4e344cSTejun Heo 		return -ENOMEM;
43115de7a03cSTejun Heo 
43125de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
43135de7a03cSTejun Heo 
43147a4e344cSTejun Heo 	return 0;
43154e1a1f9aSTejun Heo }
43164e1a1f9aSTejun Heo 
4317669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
4318669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4319669de8bdSBart Van Assche {
4320669de8bdSBart Van Assche 	char *lock_name;
4321669de8bdSBart Van Assche 
4322669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
4323669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
4324669de8bdSBart Van Assche 	if (!lock_name)
4325669de8bdSBart Van Assche 		lock_name = wq->name;
432669a106c0SQian Cai 
432769a106c0SQian Cai 	wq->lock_name = lock_name;
4328669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
4329669de8bdSBart Van Assche }
4330669de8bdSBart Van Assche 
4331669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4332669de8bdSBart Van Assche {
4333669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
4334669de8bdSBart Van Assche }
4335669de8bdSBart Van Assche 
4336669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4337669de8bdSBart Van Assche {
4338669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
4339669de8bdSBart Van Assche 		kfree(wq->lock_name);
4340669de8bdSBart Van Assche }
4341669de8bdSBart Van Assche #else
4342669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4343669de8bdSBart Van Assche {
4344669de8bdSBart Van Assche }
4345669de8bdSBart Van Assche 
4346669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4347669de8bdSBart Van Assche {
4348669de8bdSBart Van Assche }
4349669de8bdSBart Van Assche 
4350669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4351669de8bdSBart Van Assche {
4352669de8bdSBart Van Assche }
4353669de8bdSBart Van Assche #endif
4354669de8bdSBart Van Assche 
435591ccc6e7STejun Heo static void free_node_nr_active(struct wq_node_nr_active **nna_ar)
435691ccc6e7STejun Heo {
435791ccc6e7STejun Heo 	int node;
435891ccc6e7STejun Heo 
435991ccc6e7STejun Heo 	for_each_node(node) {
436091ccc6e7STejun Heo 		kfree(nna_ar[node]);
436191ccc6e7STejun Heo 		nna_ar[node] = NULL;
436291ccc6e7STejun Heo 	}
436391ccc6e7STejun Heo 
436491ccc6e7STejun Heo 	kfree(nna_ar[nr_node_ids]);
436591ccc6e7STejun Heo 	nna_ar[nr_node_ids] = NULL;
436691ccc6e7STejun Heo }
436791ccc6e7STejun Heo 
436891ccc6e7STejun Heo static void init_node_nr_active(struct wq_node_nr_active *nna)
436991ccc6e7STejun Heo {
4370c5f8cd6cSTejun Heo 	nna->max = WQ_DFL_MIN_ACTIVE;
437191ccc6e7STejun Heo 	atomic_set(&nna->nr, 0);
43725797b1c1STejun Heo 	raw_spin_lock_init(&nna->lock);
43735797b1c1STejun Heo 	INIT_LIST_HEAD(&nna->pending_pwqs);
437491ccc6e7STejun Heo }
437591ccc6e7STejun Heo 
437691ccc6e7STejun Heo /*
437791ccc6e7STejun Heo  * Each node's nr_active counter will be accessed mostly from its own node and
437891ccc6e7STejun Heo  * should be allocated in the node.
437991ccc6e7STejun Heo  */
438091ccc6e7STejun Heo static int alloc_node_nr_active(struct wq_node_nr_active **nna_ar)
438191ccc6e7STejun Heo {
438291ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
438391ccc6e7STejun Heo 	int node;
438491ccc6e7STejun Heo 
438591ccc6e7STejun Heo 	for_each_node(node) {
438691ccc6e7STejun Heo 		nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, node);
438791ccc6e7STejun Heo 		if (!nna)
438891ccc6e7STejun Heo 			goto err_free;
438991ccc6e7STejun Heo 		init_node_nr_active(nna);
439091ccc6e7STejun Heo 		nna_ar[node] = nna;
439191ccc6e7STejun Heo 	}
439291ccc6e7STejun Heo 
439391ccc6e7STejun Heo 	/* [nr_node_ids] is used as the fallback */
439491ccc6e7STejun Heo 	nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, NUMA_NO_NODE);
439591ccc6e7STejun Heo 	if (!nna)
439691ccc6e7STejun Heo 		goto err_free;
439791ccc6e7STejun Heo 	init_node_nr_active(nna);
439891ccc6e7STejun Heo 	nna_ar[nr_node_ids] = nna;
439991ccc6e7STejun Heo 
440091ccc6e7STejun Heo 	return 0;
440191ccc6e7STejun Heo 
440291ccc6e7STejun Heo err_free:
440391ccc6e7STejun Heo 	free_node_nr_active(nna_ar);
440491ccc6e7STejun Heo 	return -ENOMEM;
440591ccc6e7STejun Heo }
440691ccc6e7STejun Heo 
4407e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
4408e2dca7adSTejun Heo {
4409e2dca7adSTejun Heo 	struct workqueue_struct *wq =
4410e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
4411e2dca7adSTejun Heo 
441291ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
441391ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
441491ccc6e7STejun Heo 
4415669de8bdSBart Van Assche 	wq_free_lockdep(wq);
4416ee1ceef7STejun Heo 	free_percpu(wq->cpu_pwq);
4417e2dca7adSTejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
4418e2dca7adSTejun Heo 	kfree(wq);
4419e2dca7adSTejun Heo }
4420e2dca7adSTejun Heo 
442129c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
442229c91e99STejun Heo {
442329c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
442429c91e99STejun Heo 
44257cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
442629c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
442729c91e99STejun Heo 	kfree(pool);
442829c91e99STejun Heo }
442929c91e99STejun Heo 
443029c91e99STejun Heo /**
443129c91e99STejun Heo  * put_unbound_pool - put a worker_pool
443229c91e99STejun Heo  * @pool: worker_pool to put
443329c91e99STejun Heo  *
443424acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
4435c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
4436c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
4437c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
4438a892caccSTejun Heo  *
4439a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
444029c91e99STejun Heo  */
444129c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
444229c91e99STejun Heo {
444360f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
444429c91e99STejun Heo 	struct worker *worker;
44459680540cSYang Yingliang 	LIST_HEAD(cull_list);
4446e02b9312SValentin Schneider 
4447a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4448a892caccSTejun Heo 
4449a892caccSTejun Heo 	if (--pool->refcnt)
445029c91e99STejun Heo 		return;
445129c91e99STejun Heo 
445229c91e99STejun Heo 	/* sanity checks */
445361d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
4454a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
445529c91e99STejun Heo 		return;
445629c91e99STejun Heo 
445729c91e99STejun Heo 	/* release id and unhash */
445829c91e99STejun Heo 	if (pool->id >= 0)
445929c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
446029c91e99STejun Heo 	hash_del(&pool->hash_node);
446129c91e99STejun Heo 
4462c5aa87bbSTejun Heo 	/*
4463692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
4464692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
4465692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
44669ab03be4SValentin Schneider 	 *
44679ab03be4SValentin Schneider 	 * Having a concurrent manager is quite unlikely to happen as we can
44689ab03be4SValentin Schneider 	 * only get here with
44699ab03be4SValentin Schneider 	 *   pwq->refcnt == pool->refcnt == 0
44709ab03be4SValentin Schneider 	 * which implies no work queued to the pool, which implies no worker can
44719ab03be4SValentin Schneider 	 * become the manager. However a worker could have taken the role of
44729ab03be4SValentin Schneider 	 * manager before the refcnts dropped to 0, since maybe_create_worker()
44739ab03be4SValentin Schneider 	 * drops pool->lock
4474c5aa87bbSTejun Heo 	 */
44759ab03be4SValentin Schneider 	while (true) {
44769ab03be4SValentin Schneider 		rcuwait_wait_event(&manager_wait,
44779ab03be4SValentin Schneider 				   !(pool->flags & POOL_MANAGER_ACTIVE),
4478d8bb65abSSebastian Andrzej Siewior 				   TASK_UNINTERRUPTIBLE);
4479e02b9312SValentin Schneider 
4480e02b9312SValentin Schneider 		mutex_lock(&wq_pool_attach_mutex);
44819ab03be4SValentin Schneider 		raw_spin_lock_irq(&pool->lock);
44829ab03be4SValentin Schneider 		if (!(pool->flags & POOL_MANAGER_ACTIVE)) {
4483692b4825STejun Heo 			pool->flags |= POOL_MANAGER_ACTIVE;
44849ab03be4SValentin Schneider 			break;
44859ab03be4SValentin Schneider 		}
44869ab03be4SValentin Schneider 		raw_spin_unlock_irq(&pool->lock);
4487e02b9312SValentin Schneider 		mutex_unlock(&wq_pool_attach_mutex);
44889ab03be4SValentin Schneider 	}
4489692b4825STejun Heo 
44901037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
4491e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
449229c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
4493a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
449460f5a4bcSLai Jiangshan 
4495e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
4496e02b9312SValentin Schneider 
4497e02b9312SValentin Schneider 	if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers))
449860f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
44991258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
450060f5a4bcSLai Jiangshan 
450160f5a4bcSLai Jiangshan 	if (pool->detach_completion)
450260f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
450360f5a4bcSLai Jiangshan 
450429c91e99STejun Heo 	/* shut down the timers */
450529c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
45063f959aa3SValentin Schneider 	cancel_work_sync(&pool->idle_cull_work);
450729c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
450829c91e99STejun Heo 
450924acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
451025b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
451129c91e99STejun Heo }
451229c91e99STejun Heo 
451329c91e99STejun Heo /**
451429c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
451529c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
451629c91e99STejun Heo  *
451729c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
451829c91e99STejun Heo  * reference count and return it.  If there already is a matching
451929c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
4520d185af30SYacine Belkadi  * create a new one.
4521a892caccSTejun Heo  *
4522a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
4523d185af30SYacine Belkadi  *
4524d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
4525d185af30SYacine Belkadi  * On failure, %NULL.
452629c91e99STejun Heo  */
452729c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
452829c91e99STejun Heo {
452984193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA];
453029c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
453129c91e99STejun Heo 	struct worker_pool *pool;
453284193c07STejun Heo 	int pod, node = NUMA_NO_NODE;
453329c91e99STejun Heo 
4534a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
453529c91e99STejun Heo 
453629c91e99STejun Heo 	/* do we already have a matching pool? */
453729c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
453829c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
453929c91e99STejun Heo 			pool->refcnt++;
45403fb1823cSLai Jiangshan 			return pool;
454129c91e99STejun Heo 		}
454229c91e99STejun Heo 	}
454329c91e99STejun Heo 
45449546b29eSTejun Heo 	/* If __pod_cpumask is contained inside a NUMA pod, that's our node */
454584193c07STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++) {
45469546b29eSTejun Heo 		if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) {
454784193c07STejun Heo 			node = pt->pod_node[pod];
4548e2273584SXunlei Pang 			break;
4549e2273584SXunlei Pang 		}
4550e2273584SXunlei Pang 	}
4551e2273584SXunlei Pang 
455229c91e99STejun Heo 	/* nope, create a new one */
455384193c07STejun Heo 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node);
455429c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
455529c91e99STejun Heo 		goto fail;
455629c91e99STejun Heo 
455784193c07STejun Heo 	pool->node = node;
45585de7a03cSTejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
45595de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
45602865a8fbSShaohua Li 
456129c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
456229c91e99STejun Heo 		goto fail;
456329c91e99STejun Heo 
456429c91e99STejun Heo 	/* create and start the initial worker */
45653347fa09STejun Heo 	if (wq_online && !create_worker(pool))
456629c91e99STejun Heo 		goto fail;
456729c91e99STejun Heo 
456829c91e99STejun Heo 	/* install */
456929c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
45703fb1823cSLai Jiangshan 
457129c91e99STejun Heo 	return pool;
457229c91e99STejun Heo fail:
457329c91e99STejun Heo 	if (pool)
457429c91e99STejun Heo 		put_unbound_pool(pool);
457529c91e99STejun Heo 	return NULL;
457629c91e99STejun Heo }
457729c91e99STejun Heo 
45788864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
45798864b4e5STejun Heo {
45808864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
45818864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
45828864b4e5STejun Heo }
45838864b4e5STejun Heo 
45848864b4e5STejun Heo /*
4585967b494eSTejun Heo  * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero
4586967b494eSTejun Heo  * refcnt and needs to be destroyed.
45878864b4e5STejun Heo  */
4588687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work)
45898864b4e5STejun Heo {
45908864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
4591687a9aa5STejun Heo 						  release_work);
45928864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
45938864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
4594b42b0bddSYang Yingliang 	bool is_last = false;
45958864b4e5STejun Heo 
4596b42b0bddSYang Yingliang 	/*
4597687a9aa5STejun Heo 	 * When @pwq is not linked, it doesn't hold any reference to the
4598b42b0bddSYang Yingliang 	 * @wq, and @wq is invalid to access.
4599b42b0bddSYang Yingliang 	 */
4600b42b0bddSYang Yingliang 	if (!list_empty(&pwq->pwqs_node)) {
46013c25a55dSLai Jiangshan 		mutex_lock(&wq->mutex);
46028864b4e5STejun Heo 		list_del_rcu(&pwq->pwqs_node);
4603bc0caf09STejun Heo 		is_last = list_empty(&wq->pwqs);
46043c25a55dSLai Jiangshan 		mutex_unlock(&wq->mutex);
4605b42b0bddSYang Yingliang 	}
46068864b4e5STejun Heo 
4607687a9aa5STejun Heo 	if (wq->flags & WQ_UNBOUND) {
4608a892caccSTejun Heo 		mutex_lock(&wq_pool_mutex);
46098864b4e5STejun Heo 		put_unbound_pool(pool);
4610a892caccSTejun Heo 		mutex_unlock(&wq_pool_mutex);
4611687a9aa5STejun Heo 	}
4612a892caccSTejun Heo 
46135797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node)) {
46145797b1c1STejun Heo 		struct wq_node_nr_active *nna =
46155797b1c1STejun Heo 			wq_node_nr_active(pwq->wq, pwq->pool->node);
46165797b1c1STejun Heo 
46175797b1c1STejun Heo 		raw_spin_lock_irq(&nna->lock);
46185797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
46195797b1c1STejun Heo 		raw_spin_unlock_irq(&nna->lock);
46205797b1c1STejun Heo 	}
46215797b1c1STejun Heo 
462225b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
46238864b4e5STejun Heo 
46248864b4e5STejun Heo 	/*
46258864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
4626e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
46278864b4e5STejun Heo 	 */
4628669de8bdSBart Van Assche 	if (is_last) {
4629669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
463025b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
46316029a918STejun Heo 	}
4632669de8bdSBart Van Assche }
46338864b4e5STejun Heo 
463467dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */
4635f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
4636f147f29eSTejun Heo 		     struct worker_pool *pool)
4637d2c1d404STejun Heo {
4638d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
4639d2c1d404STejun Heo 
4640e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
4641e50aba9aSTejun Heo 
4642d2c1d404STejun Heo 	pwq->pool = pool;
4643d2c1d404STejun Heo 	pwq->wq = wq;
4644d2c1d404STejun Heo 	pwq->flush_color = -1;
46458864b4e5STejun Heo 	pwq->refcnt = 1;
4646f97a4a1aSLai Jiangshan 	INIT_LIST_HEAD(&pwq->inactive_works);
46475797b1c1STejun Heo 	INIT_LIST_HEAD(&pwq->pending_node);
46481befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
4649d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
4650687a9aa5STejun Heo 	kthread_init_work(&pwq->release_work, pwq_release_workfn);
4651f147f29eSTejun Heo }
4652d2c1d404STejun Heo 
4653f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
46541befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
4655f147f29eSTejun Heo {
4656f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
4657f147f29eSTejun Heo 
4658f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
465975ccf595STejun Heo 
46601befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
46611befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
46621befcf30STejun Heo 		return;
46631befcf30STejun Heo 
466429b1cb41SLai Jiangshan 	/* set the matching work_color */
466575ccf595STejun Heo 	pwq->work_color = wq->work_color;
4666983ca25eSTejun Heo 
4667983ca25eSTejun Heo 	/* link in @pwq */
46689e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
4669df2d5ae4STejun Heo }
46706029a918STejun Heo 
4671f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
4672f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
4673f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
4674f147f29eSTejun Heo {
4675f147f29eSTejun Heo 	struct worker_pool *pool;
4676f147f29eSTejun Heo 	struct pool_workqueue *pwq;
4677f147f29eSTejun Heo 
4678f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4679f147f29eSTejun Heo 
4680f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
4681f147f29eSTejun Heo 	if (!pool)
4682f147f29eSTejun Heo 		return NULL;
4683f147f29eSTejun Heo 
4684e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
4685f147f29eSTejun Heo 	if (!pwq) {
4686f147f29eSTejun Heo 		put_unbound_pool(pool);
4687f147f29eSTejun Heo 		return NULL;
4688f147f29eSTejun Heo 	}
4689f147f29eSTejun Heo 
4690f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
4691f147f29eSTejun Heo 	return pwq;
4692d2c1d404STejun Heo }
4693d2c1d404STejun Heo 
46944c16bd32STejun Heo /**
4695fef59c9cSTejun Heo  * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod
4696042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
469784193c07STejun Heo  * @cpu: the target CPU
46984c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
46994c16bd32STejun Heo  *
4700fef59c9cSTejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @pod. If
4701fef59c9cSTejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during calculation.
47029546b29eSTejun Heo  * The result is stored in @attrs->__pod_cpumask.
47034c16bd32STejun Heo  *
4704fef59c9cSTejun Heo  * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled
4705fef59c9cSTejun Heo  * and @pod has online CPUs requested by @attrs, the returned cpumask is the
4706fef59c9cSTejun Heo  * intersection of the possible CPUs of @pod and @attrs->cpumask.
47074c16bd32STejun Heo  *
4708fef59c9cSTejun Heo  * The caller is responsible for ensuring that the cpumask of @pod stays stable.
47094c16bd32STejun Heo  */
47109546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu,
47119546b29eSTejun Heo 				int cpu_going_down)
47124c16bd32STejun Heo {
471384193c07STejun Heo 	const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
471484193c07STejun Heo 	int pod = pt->cpu_pod[cpu];
47154c16bd32STejun Heo 
4716fef59c9cSTejun Heo 	/* does @pod have any online CPUs @attrs wants? */
47179546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask);
47189546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask);
47194c16bd32STejun Heo 	if (cpu_going_down >= 0)
47209546b29eSTejun Heo 		cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask);
47214c16bd32STejun Heo 
47229546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask)) {
47239546b29eSTejun Heo 		cpumask_copy(attrs->__pod_cpumask, attrs->cpumask);
472484193c07STejun Heo 		return;
472584193c07STejun Heo 	}
47264c16bd32STejun Heo 
4727fef59c9cSTejun Heo 	/* yeap, return possible CPUs in @pod that @attrs wants */
47289546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]);
47291ad0f0a7SMichael Bringmann 
47309546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask))
47311ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
47321ad0f0a7SMichael Bringmann 				"possible intersect\n");
47334c16bd32STejun Heo }
47344c16bd32STejun Heo 
47359f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */
4736636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq,
4737636b927eSTejun Heo 					int cpu, struct pool_workqueue *pwq)
47381befcf30STejun Heo {
47399f66cff2STejun Heo 	struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu);
47401befcf30STejun Heo 	struct pool_workqueue *old_pwq;
47411befcf30STejun Heo 
47425b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
47431befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
47441befcf30STejun Heo 
47451befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
47461befcf30STejun Heo 	link_pwq(pwq);
47471befcf30STejun Heo 
47489f66cff2STejun Heo 	old_pwq = rcu_access_pointer(*slot);
47499f66cff2STejun Heo 	rcu_assign_pointer(*slot, pwq);
47501befcf30STejun Heo 	return old_pwq;
47511befcf30STejun Heo }
47521befcf30STejun Heo 
47532d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
47542d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
47552d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
47562d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
4757042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
47582d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
47592d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
47602d5f0764SLai Jiangshan };
47612d5f0764SLai Jiangshan 
47622d5f0764SLai Jiangshan /* free the resources after success or abort */
47632d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
47642d5f0764SLai Jiangshan {
47652d5f0764SLai Jiangshan 	if (ctx) {
4766636b927eSTejun Heo 		int cpu;
47672d5f0764SLai Jiangshan 
4768636b927eSTejun Heo 		for_each_possible_cpu(cpu)
4769636b927eSTejun Heo 			put_pwq_unlocked(ctx->pwq_tbl[cpu]);
47702d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
47712d5f0764SLai Jiangshan 
47722d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
47732d5f0764SLai Jiangshan 
47742d5f0764SLai Jiangshan 		kfree(ctx);
47752d5f0764SLai Jiangshan 	}
47762d5f0764SLai Jiangshan }
47772d5f0764SLai Jiangshan 
47782d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
47792d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
47802d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
478199c621efSLai Jiangshan 		      const struct workqueue_attrs *attrs,
478299c621efSLai Jiangshan 		      const cpumask_var_t unbound_cpumask)
47832d5f0764SLai Jiangshan {
47842d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
47859546b29eSTejun Heo 	struct workqueue_attrs *new_attrs;
4786636b927eSTejun Heo 	int cpu;
47872d5f0764SLai Jiangshan 
47882d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
47892d5f0764SLai Jiangshan 
479084193c07STejun Heo 	if (WARN_ON(attrs->affn_scope < 0 ||
479184193c07STejun Heo 		    attrs->affn_scope >= WQ_AFFN_NR_TYPES))
479284193c07STejun Heo 		return ERR_PTR(-EINVAL);
479384193c07STejun Heo 
4794636b927eSTejun Heo 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL);
47952d5f0764SLai Jiangshan 
4796be69d00dSThomas Gleixner 	new_attrs = alloc_workqueue_attrs();
47979546b29eSTejun Heo 	if (!ctx || !new_attrs)
47982d5f0764SLai Jiangshan 		goto out_free;
47992d5f0764SLai Jiangshan 
4800042f7df1SLai Jiangshan 	/*
48012d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
48022d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
48032d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
48042d5f0764SLai Jiangshan 	 */
48050f36ee24STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
48060f36ee24STejun Heo 	wqattrs_actualize_cpumask(new_attrs, unbound_cpumask);
48079546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
48082d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
48092d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
48102d5f0764SLai Jiangshan 		goto out_free;
48112d5f0764SLai Jiangshan 
4812636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
4813af73f5c9STejun Heo 		if (new_attrs->ordered) {
48142d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
4815636b927eSTejun Heo 			ctx->pwq_tbl[cpu] = ctx->dfl_pwq;
4816636b927eSTejun Heo 		} else {
48179546b29eSTejun Heo 			wq_calc_pod_cpumask(new_attrs, cpu, -1);
48189546b29eSTejun Heo 			ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs);
4819636b927eSTejun Heo 			if (!ctx->pwq_tbl[cpu])
4820636b927eSTejun Heo 				goto out_free;
48212d5f0764SLai Jiangshan 		}
48222d5f0764SLai Jiangshan 	}
48232d5f0764SLai Jiangshan 
4824042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
4825042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
4826042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
48279546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
48282d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
4829042f7df1SLai Jiangshan 
48302d5f0764SLai Jiangshan 	ctx->wq = wq;
48312d5f0764SLai Jiangshan 	return ctx;
48322d5f0764SLai Jiangshan 
48332d5f0764SLai Jiangshan out_free:
48342d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
48352d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
483684193c07STejun Heo 	return ERR_PTR(-ENOMEM);
48372d5f0764SLai Jiangshan }
48382d5f0764SLai Jiangshan 
48392d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
48402d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
48412d5f0764SLai Jiangshan {
4842636b927eSTejun Heo 	int cpu;
48432d5f0764SLai Jiangshan 
48442d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
48452d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
48462d5f0764SLai Jiangshan 
48472d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
48482d5f0764SLai Jiangshan 
48499f66cff2STejun Heo 	/* save the previous pwqs and install the new ones */
4850636b927eSTejun Heo 	for_each_possible_cpu(cpu)
4851636b927eSTejun Heo 		ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu,
4852636b927eSTejun Heo 							ctx->pwq_tbl[cpu]);
48539f66cff2STejun Heo 	ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq);
48542d5f0764SLai Jiangshan 
48555797b1c1STejun Heo 	/* update node_nr_active->max */
48565797b1c1STejun Heo 	wq_update_node_max_active(ctx->wq, -1);
48575797b1c1STejun Heo 
48582d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
48592d5f0764SLai Jiangshan }
48602d5f0764SLai Jiangshan 
4861a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4862a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
4863a0111cf6SLai Jiangshan {
4864a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
4865a0111cf6SLai Jiangshan 
4866a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
4867a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4868a0111cf6SLai Jiangshan 		return -EINVAL;
4869a0111cf6SLai Jiangshan 
4870a0111cf6SLai Jiangshan 	/* creating multiple pwqs breaks ordering guarantee */
48710a94efb5STejun Heo 	if (!list_empty(&wq->pwqs)) {
48720a94efb5STejun Heo 		if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4873a0111cf6SLai Jiangshan 			return -EINVAL;
4874a0111cf6SLai Jiangshan 
48750a94efb5STejun Heo 		wq->flags &= ~__WQ_ORDERED;
48760a94efb5STejun Heo 	}
48770a94efb5STejun Heo 
487899c621efSLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask);
487984193c07STejun Heo 	if (IS_ERR(ctx))
488084193c07STejun Heo 		return PTR_ERR(ctx);
4881a0111cf6SLai Jiangshan 
4882a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
4883a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
4884a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
4885a0111cf6SLai Jiangshan 
48866201171eSwanghaibin 	return 0;
4887a0111cf6SLai Jiangshan }
4888a0111cf6SLai Jiangshan 
48899e8cd2f5STejun Heo /**
48909e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
48919e8cd2f5STejun Heo  * @wq: the target workqueue
48929e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
48939e8cd2f5STejun Heo  *
4894fef59c9cSTejun Heo  * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps
4895fef59c9cSTejun Heo  * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that
4896fef59c9cSTejun Heo  * work items are affine to the pod it was issued on. Older pwqs are released as
4897fef59c9cSTejun Heo  * in-flight work items finish. Note that a work item which repeatedly requeues
4898fef59c9cSTejun Heo  * itself back-to-back will stay on its current pwq.
48999e8cd2f5STejun Heo  *
4900d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
4901d185af30SYacine Belkadi  *
4902ffd8bea8SSebastian Andrzej Siewior  * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
4903509b3204SDaniel Jordan  *
4904d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
49059e8cd2f5STejun Heo  */
4906513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq,
49079e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
49089e8cd2f5STejun Heo {
4909a0111cf6SLai Jiangshan 	int ret;
49109e8cd2f5STejun Heo 
4911509b3204SDaniel Jordan 	lockdep_assert_cpus_held();
4912509b3204SDaniel Jordan 
4913509b3204SDaniel Jordan 	mutex_lock(&wq_pool_mutex);
4914a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
4915509b3204SDaniel Jordan 	mutex_unlock(&wq_pool_mutex);
49162d5f0764SLai Jiangshan 
49172d5f0764SLai Jiangshan 	return ret;
49189e8cd2f5STejun Heo }
49199e8cd2f5STejun Heo 
49204c16bd32STejun Heo /**
4921fef59c9cSTejun Heo  * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug
49224c16bd32STejun Heo  * @wq: the target workqueue
49234cbfd3deSTejun Heo  * @cpu: the CPU to update pool association for
49244cbfd3deSTejun Heo  * @hotplug_cpu: the CPU coming up or going down
49254c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
49264c16bd32STejun Heo  *
49274c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4928fef59c9cSTejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update pod affinity of
49294c16bd32STejun Heo  * @wq accordingly.
49304c16bd32STejun Heo  *
49314c16bd32STejun Heo  *
4932fef59c9cSTejun Heo  * If pod affinity can't be adjusted due to memory allocation failure, it falls
4933fef59c9cSTejun Heo  * back to @wq->dfl_pwq which may not be optimal but is always correct.
4934fef59c9cSTejun Heo  *
4935fef59c9cSTejun Heo  * Note that when the last allowed CPU of a pod goes offline for a workqueue
4936fef59c9cSTejun Heo  * with a cpumask spanning multiple pods, the workers which were already
4937fef59c9cSTejun Heo  * executing the work items for the workqueue will lose their CPU affinity and
4938fef59c9cSTejun Heo  * may execute on any CPU. This is similar to how per-cpu workqueues behave on
4939fef59c9cSTejun Heo  * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's
4940fef59c9cSTejun Heo  * responsibility to flush the work item from CPU_DOWN_PREPARE.
49414c16bd32STejun Heo  */
4942fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu,
49434cbfd3deSTejun Heo 			  int hotplug_cpu, bool online)
49444c16bd32STejun Heo {
49454cbfd3deSTejun Heo 	int off_cpu = online ? -1 : hotplug_cpu;
49464c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
49474c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
49484c16bd32STejun Heo 
49494c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
49504c16bd32STejun Heo 
495184193c07STejun Heo 	if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered)
49524c16bd32STejun Heo 		return;
49534c16bd32STejun Heo 
49544c16bd32STejun Heo 	/*
49554c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
49564c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
49574c16bd32STejun Heo 	 * CPU hotplug exclusion.
49584c16bd32STejun Heo 	 */
4959fef59c9cSTejun Heo 	target_attrs = wq_update_pod_attrs_buf;
49604c16bd32STejun Heo 
49614c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
49620f36ee24STejun Heo 	wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask);
49634c16bd32STejun Heo 
4964636b927eSTejun Heo 	/* nothing to do if the target cpumask matches the current pwq */
49659546b29eSTejun Heo 	wq_calc_pod_cpumask(target_attrs, cpu, off_cpu);
49669f66cff2STejun Heo 	if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs))
4967f7142ed4SLai Jiangshan 		return;
49684c16bd32STejun Heo 
49694c16bd32STejun Heo 	/* create a new pwq */
49704c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
49714c16bd32STejun Heo 	if (!pwq) {
4972fef59c9cSTejun Heo 		pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n",
49734c16bd32STejun Heo 			wq->name);
497477f300b1SDaeseok Youn 		goto use_dfl_pwq;
49754c16bd32STejun Heo 	}
49764c16bd32STejun Heo 
4977f7142ed4SLai Jiangshan 	/* Install the new pwq. */
49784c16bd32STejun Heo 	mutex_lock(&wq->mutex);
4979636b927eSTejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
49804c16bd32STejun Heo 	goto out_unlock;
49814c16bd32STejun Heo 
49824c16bd32STejun Heo use_dfl_pwq:
4983f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
49849f66cff2STejun Heo 	pwq = unbound_pwq(wq, -1);
49859f66cff2STejun Heo 	raw_spin_lock_irq(&pwq->pool->lock);
49869f66cff2STejun Heo 	get_pwq(pwq);
49879f66cff2STejun Heo 	raw_spin_unlock_irq(&pwq->pool->lock);
49889f66cff2STejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
49894c16bd32STejun Heo out_unlock:
49904c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
49914c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
49924c16bd32STejun Heo }
49934c16bd32STejun Heo 
499430cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
49951da177e4SLinus Torvalds {
499649e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
49978a2b7538STejun Heo 	int cpu, ret;
4998e1d8aa9fSFrederic Weisbecker 
4999687a9aa5STejun Heo 	wq->cpu_pwq = alloc_percpu(struct pool_workqueue *);
5000ee1ceef7STejun Heo 	if (!wq->cpu_pwq)
5001687a9aa5STejun Heo 		goto enomem;
500230cdf249STejun Heo 
5003636b927eSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
500430cdf249STejun Heo 		for_each_possible_cpu(cpu) {
5005687a9aa5STejun Heo 			struct pool_workqueue **pwq_p =
5006ee1ceef7STejun Heo 				per_cpu_ptr(wq->cpu_pwq, cpu);
5007687a9aa5STejun Heo 			struct worker_pool *pool =
5008687a9aa5STejun Heo 				&(per_cpu_ptr(cpu_worker_pools, cpu)[highpri]);
500930cdf249STejun Heo 
5010687a9aa5STejun Heo 			*pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL,
5011687a9aa5STejun Heo 						       pool->node);
5012687a9aa5STejun Heo 			if (!*pwq_p)
5013687a9aa5STejun Heo 				goto enomem;
5014687a9aa5STejun Heo 
5015687a9aa5STejun Heo 			init_pwq(*pwq_p, wq, pool);
5016f147f29eSTejun Heo 
5017f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
5018687a9aa5STejun Heo 			link_pwq(*pwq_p);
5019f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
502030cdf249STejun Heo 		}
502130cdf249STejun Heo 		return 0;
5022509b3204SDaniel Jordan 	}
5023509b3204SDaniel Jordan 
5024ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
5025509b3204SDaniel Jordan 	if (wq->flags & __WQ_ORDERED) {
50269f66cff2STejun Heo 		struct pool_workqueue *dfl_pwq;
50279f66cff2STejun Heo 
50288a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
50298a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
50309f66cff2STejun Heo 		dfl_pwq = rcu_access_pointer(wq->dfl_pwq);
50319f66cff2STejun Heo 		WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node ||
50329f66cff2STejun Heo 			      wq->pwqs.prev != &dfl_pwq->pwqs_node),
50338a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
50349e8cd2f5STejun Heo 	} else {
5035509b3204SDaniel Jordan 		ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
50369e8cd2f5STejun Heo 	}
5037ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
5038509b3204SDaniel Jordan 
503964344553SZqiang 	/* for unbound pwq, flush the pwq_release_worker ensures that the
504064344553SZqiang 	 * pwq_release_workfn() completes before calling kfree(wq).
504164344553SZqiang 	 */
504264344553SZqiang 	if (ret)
504364344553SZqiang 		kthread_flush_worker(pwq_release_worker);
504464344553SZqiang 
5045509b3204SDaniel Jordan 	return ret;
5046687a9aa5STejun Heo 
5047687a9aa5STejun Heo enomem:
5048687a9aa5STejun Heo 	if (wq->cpu_pwq) {
50497b42f401SZqiang 		for_each_possible_cpu(cpu) {
50507b42f401SZqiang 			struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
50517b42f401SZqiang 
50527b42f401SZqiang 			if (pwq)
50537b42f401SZqiang 				kmem_cache_free(pwq_cache, pwq);
50547b42f401SZqiang 		}
5055687a9aa5STejun Heo 		free_percpu(wq->cpu_pwq);
5056687a9aa5STejun Heo 		wq->cpu_pwq = NULL;
5057687a9aa5STejun Heo 	}
5058687a9aa5STejun Heo 	return -ENOMEM;
50590f900049STejun Heo }
50600f900049STejun Heo 
5061f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
5062f3421797STejun Heo 			       const char *name)
5063b71ab8c2STejun Heo {
5064636b927eSTejun Heo 	if (max_active < 1 || max_active > WQ_MAX_ACTIVE)
5065044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
5066636b927eSTejun Heo 			max_active, name, 1, WQ_MAX_ACTIVE);
5067b71ab8c2STejun Heo 
5068636b927eSTejun Heo 	return clamp_val(max_active, 1, WQ_MAX_ACTIVE);
5069b71ab8c2STejun Heo }
5070b71ab8c2STejun Heo 
5071983c7515STejun Heo /*
5072983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
5073983c7515STejun Heo  * to guarantee forward progress.
5074983c7515STejun Heo  */
5075983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
5076983c7515STejun Heo {
5077983c7515STejun Heo 	struct worker *rescuer;
5078b92b36eaSDan Carpenter 	int ret;
5079983c7515STejun Heo 
5080983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
5081983c7515STejun Heo 		return 0;
5082983c7515STejun Heo 
5083983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
50844c0736a7SPetr Mladek 	if (!rescuer) {
50854c0736a7SPetr Mladek 		pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n",
50864c0736a7SPetr Mladek 		       wq->name);
5087983c7515STejun Heo 		return -ENOMEM;
50884c0736a7SPetr Mladek 	}
5089983c7515STejun Heo 
5090983c7515STejun Heo 	rescuer->rescue_wq = wq;
5091b6a46f72SAaron Tomlin 	rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name);
5092f187b697SSean Fu 	if (IS_ERR(rescuer->task)) {
5093b92b36eaSDan Carpenter 		ret = PTR_ERR(rescuer->task);
50944c0736a7SPetr Mladek 		pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe",
50954c0736a7SPetr Mladek 		       wq->name, ERR_PTR(ret));
5096983c7515STejun Heo 		kfree(rescuer);
5097b92b36eaSDan Carpenter 		return ret;
5098983c7515STejun Heo 	}
5099983c7515STejun Heo 
5100983c7515STejun Heo 	wq->rescuer = rescuer;
510185f0ab43SJuri Lelli 	if (wq->flags & WQ_UNBOUND)
510285f0ab43SJuri Lelli 		kthread_bind_mask(rescuer->task, wq->unbound_attrs->cpumask);
510385f0ab43SJuri Lelli 	else
5104983c7515STejun Heo 		kthread_bind_mask(rescuer->task, cpu_possible_mask);
5105983c7515STejun Heo 	wake_up_process(rescuer->task);
5106983c7515STejun Heo 
5107983c7515STejun Heo 	return 0;
5108983c7515STejun Heo }
5109983c7515STejun Heo 
5110a045a272STejun Heo /**
5111a045a272STejun Heo  * wq_adjust_max_active - update a wq's max_active to the current setting
5112a045a272STejun Heo  * @wq: target workqueue
5113a045a272STejun Heo  *
5114a045a272STejun Heo  * If @wq isn't freezing, set @wq->max_active to the saved_max_active and
5115a045a272STejun Heo  * activate inactive work items accordingly. If @wq is freezing, clear
5116a045a272STejun Heo  * @wq->max_active to zero.
5117a045a272STejun Heo  */
5118a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq)
5119a045a272STejun Heo {
5120c5404d4eSTejun Heo 	bool activated;
51215797b1c1STejun Heo 	int new_max, new_min;
5122a045a272STejun Heo 
5123a045a272STejun Heo 	lockdep_assert_held(&wq->mutex);
5124a045a272STejun Heo 
5125a045a272STejun Heo 	if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) {
51265797b1c1STejun Heo 		new_max = 0;
51275797b1c1STejun Heo 		new_min = 0;
51285797b1c1STejun Heo 	} else {
51295797b1c1STejun Heo 		new_max = wq->saved_max_active;
51305797b1c1STejun Heo 		new_min = wq->saved_min_active;
5131a045a272STejun Heo 	}
5132a045a272STejun Heo 
51335797b1c1STejun Heo 	if (wq->max_active == new_max && wq->min_active == new_min)
5134a045a272STejun Heo 		return;
5135a045a272STejun Heo 
5136a045a272STejun Heo 	/*
51375797b1c1STejun Heo 	 * Update @wq->max/min_active and then kick inactive work items if more
5138a045a272STejun Heo 	 * active work items are allowed. This doesn't break work item ordering
5139a045a272STejun Heo 	 * because new work items are always queued behind existing inactive
5140a045a272STejun Heo 	 * work items if there are any.
5141a045a272STejun Heo 	 */
51425797b1c1STejun Heo 	WRITE_ONCE(wq->max_active, new_max);
51435797b1c1STejun Heo 	WRITE_ONCE(wq->min_active, new_min);
51445797b1c1STejun Heo 
51455797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
51465797b1c1STejun Heo 		wq_update_node_max_active(wq, -1);
51475797b1c1STejun Heo 
51485797b1c1STejun Heo 	if (new_max == 0)
51495797b1c1STejun Heo 		return;
5150a045a272STejun Heo 
5151c5404d4eSTejun Heo 	/*
5152c5404d4eSTejun Heo 	 * Round-robin through pwq's activating the first inactive work item
5153c5404d4eSTejun Heo 	 * until max_active is filled.
5154c5404d4eSTejun Heo 	 */
5155c5404d4eSTejun Heo 	do {
5156c5404d4eSTejun Heo 		struct pool_workqueue *pwq;
5157c5404d4eSTejun Heo 
5158c5404d4eSTejun Heo 		activated = false;
5159a045a272STejun Heo 		for_each_pwq(pwq, wq) {
5160a045a272STejun Heo 			unsigned long flags;
5161a045a272STejun Heo 
5162c5404d4eSTejun Heo 			/* can be called during early boot w/ irq disabled */
5163a045a272STejun Heo 			raw_spin_lock_irqsave(&pwq->pool->lock, flags);
51645797b1c1STejun Heo 			if (pwq_activate_first_inactive(pwq, true)) {
5165c5404d4eSTejun Heo 				activated = true;
5166a045a272STejun Heo 				kick_pool(pwq->pool);
5167c5404d4eSTejun Heo 			}
5168a045a272STejun Heo 			raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
5169a045a272STejun Heo 		}
5170c5404d4eSTejun Heo 	} while (activated);
5171a045a272STejun Heo }
5172a045a272STejun Heo 
5173a2775bbcSMathieu Malaterre __printf(1, 4)
5174669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
517597e37d7bSTejun Heo 					 unsigned int flags,
5176669de8bdSBart Van Assche 					 int max_active, ...)
51773af24433SOleg Nesterov {
5178ecf6881fSTejun Heo 	va_list args;
51793af24433SOleg Nesterov 	struct workqueue_struct *wq;
518091ccc6e7STejun Heo 	size_t wq_size;
518191ccc6e7STejun Heo 	int name_len;
5182b196be89STejun Heo 
51835c0338c6STejun Heo 	/*
5184fef59c9cSTejun Heo 	 * Unbound && max_active == 1 used to imply ordered, which is no longer
5185fef59c9cSTejun Heo 	 * the case on many machines due to per-pod pools. While
51865c0338c6STejun Heo 	 * alloc_ordered_workqueue() is the right way to create an ordered
5187fef59c9cSTejun Heo 	 * workqueue, keep the previous behavior to avoid subtle breakages.
51885c0338c6STejun Heo 	 */
51895c0338c6STejun Heo 	if ((flags & WQ_UNBOUND) && max_active == 1)
51905c0338c6STejun Heo 		flags |= __WQ_ORDERED;
51915c0338c6STejun Heo 
5192cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
5193cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
5194cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
5195cee22a15SViresh Kumar 
5196ecf6881fSTejun Heo 	/* allocate wq and format name */
519791ccc6e7STejun Heo 	if (flags & WQ_UNBOUND)
519891ccc6e7STejun Heo 		wq_size = struct_size(wq, node_nr_active, nr_node_ids + 1);
519991ccc6e7STejun Heo 	else
520091ccc6e7STejun Heo 		wq_size = sizeof(*wq);
520191ccc6e7STejun Heo 
520291ccc6e7STejun Heo 	wq = kzalloc(wq_size, GFP_KERNEL);
5203b196be89STejun Heo 	if (!wq)
5204d2c1d404STejun Heo 		return NULL;
5205b196be89STejun Heo 
52066029a918STejun Heo 	if (flags & WQ_UNBOUND) {
5207be69d00dSThomas Gleixner 		wq->unbound_attrs = alloc_workqueue_attrs();
52086029a918STejun Heo 		if (!wq->unbound_attrs)
52096029a918STejun Heo 			goto err_free_wq;
52106029a918STejun Heo 	}
52116029a918STejun Heo 
5212669de8bdSBart Van Assche 	va_start(args, max_active);
521391ccc6e7STejun Heo 	name_len = vsnprintf(wq->name, sizeof(wq->name), fmt, args);
5214b196be89STejun Heo 	va_end(args);
52153af24433SOleg Nesterov 
521691ccc6e7STejun Heo 	if (name_len >= WQ_NAME_LEN)
521791ccc6e7STejun Heo 		pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n",
521891ccc6e7STejun Heo 			     wq->name);
521931c89007SAudra Mitchell 
5220d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
5221b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
52223af24433SOleg Nesterov 
5223b196be89STejun Heo 	/* init wq */
522497e37d7bSTejun Heo 	wq->flags = flags;
5225a045a272STejun Heo 	wq->max_active = max_active;
52265797b1c1STejun Heo 	wq->min_active = min(max_active, WQ_DFL_MIN_ACTIVE);
52275797b1c1STejun Heo 	wq->saved_max_active = wq->max_active;
52285797b1c1STejun Heo 	wq->saved_min_active = wq->min_active;
52293c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
5230112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
523130cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
523273f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
523373f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
5234493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
52353af24433SOleg Nesterov 
5236669de8bdSBart Van Assche 	wq_init_lockdep(wq);
5237cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
52383af24433SOleg Nesterov 
523991ccc6e7STejun Heo 	if (flags & WQ_UNBOUND) {
524091ccc6e7STejun Heo 		if (alloc_node_nr_active(wq->node_nr_active) < 0)
524182efcab3SBart Van Assche 			goto err_unreg_lockdep;
524291ccc6e7STejun Heo 	}
524391ccc6e7STejun Heo 
524491ccc6e7STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
524591ccc6e7STejun Heo 		goto err_free_node_nr_active;
52461537663fSTejun Heo 
524740c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
5248d2c1d404STejun Heo 		goto err_destroy;
5249e22bee78STejun Heo 
5250226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
5251226223abSTejun Heo 		goto err_destroy;
5252226223abSTejun Heo 
52536af8bf3dSOleg Nesterov 	/*
525468e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
525568e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
525668e13a67SLai Jiangshan 	 * list.
52576af8bf3dSOleg Nesterov 	 */
525868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5259a0a1a5fdSTejun Heo 
5260a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5261a045a272STejun Heo 	wq_adjust_max_active(wq);
5262a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5263a0a1a5fdSTejun Heo 
5264e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
5265a0a1a5fdSTejun Heo 
526668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
52673af24433SOleg Nesterov 
52683af24433SOleg Nesterov 	return wq;
5269d2c1d404STejun Heo 
527091ccc6e7STejun Heo err_free_node_nr_active:
527191ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
527291ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
527382efcab3SBart Van Assche err_unreg_lockdep:
5274009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
5275009bb421SBart Van Assche 	wq_free_lockdep(wq);
527682efcab3SBart Van Assche err_free_wq:
52776029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
52784690c4abSTejun Heo 	kfree(wq);
5279d2c1d404STejun Heo 	return NULL;
5280d2c1d404STejun Heo err_destroy:
5281d2c1d404STejun Heo 	destroy_workqueue(wq);
52824690c4abSTejun Heo 	return NULL;
52831da177e4SLinus Torvalds }
5284669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
52851da177e4SLinus Torvalds 
5286c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq)
5287c29eb853STejun Heo {
5288c29eb853STejun Heo 	int i;
5289c29eb853STejun Heo 
5290c29eb853STejun Heo 	for (i = 0; i < WORK_NR_COLORS; i++)
5291c29eb853STejun Heo 		if (pwq->nr_in_flight[i])
5292c29eb853STejun Heo 			return true;
5293c29eb853STejun Heo 
52949f66cff2STejun Heo 	if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1))
5295c29eb853STejun Heo 		return true;
5296afa87ce8STejun Heo 	if (!pwq_is_empty(pwq))
5297c29eb853STejun Heo 		return true;
5298c29eb853STejun Heo 
5299c29eb853STejun Heo 	return false;
5300c29eb853STejun Heo }
5301c29eb853STejun Heo 
53023af24433SOleg Nesterov /**
53033af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
53043af24433SOleg Nesterov  * @wq: target workqueue
53053af24433SOleg Nesterov  *
53063af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
53073af24433SOleg Nesterov  */
53083af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
53093af24433SOleg Nesterov {
531049e3cf44STejun Heo 	struct pool_workqueue *pwq;
5311636b927eSTejun Heo 	int cpu;
53123af24433SOleg Nesterov 
5313def98c84STejun Heo 	/*
5314def98c84STejun Heo 	 * Remove it from sysfs first so that sanity check failure doesn't
5315def98c84STejun Heo 	 * lead to sysfs name conflicts.
5316def98c84STejun Heo 	 */
5317def98c84STejun Heo 	workqueue_sysfs_unregister(wq);
5318def98c84STejun Heo 
531933e3f0a3SRichard Clark 	/* mark the workqueue destruction is in progress */
532033e3f0a3SRichard Clark 	mutex_lock(&wq->mutex);
532133e3f0a3SRichard Clark 	wq->flags |= __WQ_DESTROYING;
532233e3f0a3SRichard Clark 	mutex_unlock(&wq->mutex);
532333e3f0a3SRichard Clark 
53249c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
53259c5a2ba7STejun Heo 	drain_workqueue(wq);
5326c8efcc25STejun Heo 
5327def98c84STejun Heo 	/* kill rescuer, if sanity checks fail, leave it w/o rescuer */
5328def98c84STejun Heo 	if (wq->rescuer) {
5329def98c84STejun Heo 		struct worker *rescuer = wq->rescuer;
5330def98c84STejun Heo 
5331def98c84STejun Heo 		/* this prevents new queueing */
5332a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
5333def98c84STejun Heo 		wq->rescuer = NULL;
5334a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
5335def98c84STejun Heo 
5336def98c84STejun Heo 		/* rescuer will empty maydays list before exiting */
5337def98c84STejun Heo 		kthread_stop(rescuer->task);
53388efe1223STejun Heo 		kfree(rescuer);
5339def98c84STejun Heo 	}
5340def98c84STejun Heo 
5341c29eb853STejun Heo 	/*
5342c29eb853STejun Heo 	 * Sanity checks - grab all the locks so that we wait for all
5343c29eb853STejun Heo 	 * in-flight operations which may do put_pwq().
5344c29eb853STejun Heo 	 */
5345c29eb853STejun Heo 	mutex_lock(&wq_pool_mutex);
5346b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
534749e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
5348a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
5349c29eb853STejun Heo 		if (WARN_ON(pwq_busy(pwq))) {
53501d9a6159SKefeng Wang 			pr_warn("%s: %s has the following busy pwq\n",
5351e66b39afSTejun Heo 				__func__, wq->name);
5352c29eb853STejun Heo 			show_pwq(pwq);
5353a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pwq->pool->lock);
5354b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
5355c29eb853STejun Heo 			mutex_unlock(&wq_pool_mutex);
535655df0933SImran Khan 			show_one_workqueue(wq);
53576183c009STejun Heo 			return;
535876af4d93STejun Heo 		}
5359a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
536076af4d93STejun Heo 	}
5361b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
53626183c009STejun Heo 
5363a0a1a5fdSTejun Heo 	/*
5364a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
5365a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
5366a0a1a5fdSTejun Heo 	 */
5367e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
536868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
53693af24433SOleg Nesterov 
53708864b4e5STejun Heo 	/*
5371636b927eSTejun Heo 	 * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq
5372636b927eSTejun Heo 	 * to put the base refs. @wq will be auto-destroyed from the last
5373636b927eSTejun Heo 	 * pwq_put. RCU read lock prevents @wq from going away from under us.
53748864b4e5STejun Heo 	 */
5375636b927eSTejun Heo 	rcu_read_lock();
5376636b927eSTejun Heo 
5377636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
53789f66cff2STejun Heo 		put_pwq_unlocked(unbound_pwq(wq, cpu));
53799f66cff2STejun Heo 		RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL);
53804c16bd32STejun Heo 	}
53814c16bd32STejun Heo 
53829f66cff2STejun Heo 	put_pwq_unlocked(unbound_pwq(wq, -1));
53839f66cff2STejun Heo 	RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL);
5384636b927eSTejun Heo 
5385636b927eSTejun Heo 	rcu_read_unlock();
53863af24433SOleg Nesterov }
53873af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
53883af24433SOleg Nesterov 
5389dcd989cbSTejun Heo /**
5390dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
5391dcd989cbSTejun Heo  * @wq: target workqueue
5392dcd989cbSTejun Heo  * @max_active: new max_active value.
5393dcd989cbSTejun Heo  *
53945797b1c1STejun Heo  * Set max_active of @wq to @max_active. See the alloc_workqueue() function
53955797b1c1STejun Heo  * comment.
5396dcd989cbSTejun Heo  *
5397dcd989cbSTejun Heo  * CONTEXT:
5398dcd989cbSTejun Heo  * Don't call from IRQ context.
5399dcd989cbSTejun Heo  */
5400dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
5401dcd989cbSTejun Heo {
54028719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
54030a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
54048719dceaSTejun Heo 		return;
54058719dceaSTejun Heo 
5406f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
5407dcd989cbSTejun Heo 
5408a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5409dcd989cbSTejun Heo 
54100a94efb5STejun Heo 	wq->flags &= ~__WQ_ORDERED;
5411dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
54125797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
54135797b1c1STejun Heo 		wq->saved_min_active = min(wq->saved_min_active, max_active);
54145797b1c1STejun Heo 
5415a045a272STejun Heo 	wq_adjust_max_active(wq);
5416dcd989cbSTejun Heo 
5417a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5418dcd989cbSTejun Heo }
5419dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
5420dcd989cbSTejun Heo 
5421dcd989cbSTejun Heo /**
542227d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
542327d4ee03SLukas Wunner  *
542427d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
542527d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
542627d4ee03SLukas Wunner  *
542727d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
542827d4ee03SLukas Wunner  */
542927d4ee03SLukas Wunner struct work_struct *current_work(void)
543027d4ee03SLukas Wunner {
543127d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
543227d4ee03SLukas Wunner 
543327d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
543427d4ee03SLukas Wunner }
543527d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
543627d4ee03SLukas Wunner 
543727d4ee03SLukas Wunner /**
5438e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
5439e6267616STejun Heo  *
5440e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
5441e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
5442d185af30SYacine Belkadi  *
5443d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
5444e6267616STejun Heo  */
5445e6267616STejun Heo bool current_is_workqueue_rescuer(void)
5446e6267616STejun Heo {
5447e6267616STejun Heo 	struct worker *worker = current_wq_worker();
5448e6267616STejun Heo 
54496a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
5450e6267616STejun Heo }
5451e6267616STejun Heo 
5452e6267616STejun Heo /**
5453dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
5454dcd989cbSTejun Heo  * @cpu: CPU in question
5455dcd989cbSTejun Heo  * @wq: target workqueue
5456dcd989cbSTejun Heo  *
5457dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
5458dcd989cbSTejun Heo  * no synchronization around this function and the test result is
5459dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5460dcd989cbSTejun Heo  *
5461d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
5462636b927eSTejun Heo  *
5463636b927eSTejun Heo  * With the exception of ordered workqueues, all workqueues have per-cpu
5464636b927eSTejun Heo  * pool_workqueues, each with its own congested state. A workqueue being
5465636b927eSTejun Heo  * congested on one CPU doesn't mean that the workqueue is contested on any
5466636b927eSTejun Heo  * other CPUs.
5467d3251859STejun Heo  *
5468d185af30SYacine Belkadi  * Return:
5469dcd989cbSTejun Heo  * %true if congested, %false otherwise.
5470dcd989cbSTejun Heo  */
5471d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
5472dcd989cbSTejun Heo {
54737fb98ea7STejun Heo 	struct pool_workqueue *pwq;
547476af4d93STejun Heo 	bool ret;
547576af4d93STejun Heo 
547624acfb71SThomas Gleixner 	rcu_read_lock();
547724acfb71SThomas Gleixner 	preempt_disable();
54787fb98ea7STejun Heo 
5479d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
5480d3251859STejun Heo 		cpu = smp_processor_id();
5481d3251859STejun Heo 
5482687a9aa5STejun Heo 	pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
5483f97a4a1aSLai Jiangshan 	ret = !list_empty(&pwq->inactive_works);
5484636b927eSTejun Heo 
548524acfb71SThomas Gleixner 	preempt_enable();
548624acfb71SThomas Gleixner 	rcu_read_unlock();
548776af4d93STejun Heo 
548876af4d93STejun Heo 	return ret;
5489dcd989cbSTejun Heo }
5490dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
5491dcd989cbSTejun Heo 
5492dcd989cbSTejun Heo /**
5493dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
5494dcd989cbSTejun Heo  * @work: the work to be tested
5495dcd989cbSTejun Heo  *
5496dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
5497dcd989cbSTejun Heo  * synchronization around this function and the test result is
5498dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5499dcd989cbSTejun Heo  *
5500d185af30SYacine Belkadi  * Return:
5501dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
5502dcd989cbSTejun Heo  */
5503dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
5504dcd989cbSTejun Heo {
5505fa1b54e6STejun Heo 	struct worker_pool *pool;
5506dcd989cbSTejun Heo 	unsigned long flags;
5507dcd989cbSTejun Heo 	unsigned int ret = 0;
5508dcd989cbSTejun Heo 
5509dcd989cbSTejun Heo 	if (work_pending(work))
5510dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
5511038366c5SLai Jiangshan 
551224acfb71SThomas Gleixner 	rcu_read_lock();
5513fa1b54e6STejun Heo 	pool = get_work_pool(work);
5514038366c5SLai Jiangshan 	if (pool) {
5515a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pool->lock, flags);
5516c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
5517dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
5518a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pool->lock, flags);
5519038366c5SLai Jiangshan 	}
552024acfb71SThomas Gleixner 	rcu_read_unlock();
5521dcd989cbSTejun Heo 
5522dcd989cbSTejun Heo 	return ret;
5523dcd989cbSTejun Heo }
5524dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
5525dcd989cbSTejun Heo 
55263d1cb205STejun Heo /**
55273d1cb205STejun Heo  * set_worker_desc - set description for the current work item
55283d1cb205STejun Heo  * @fmt: printf-style format string
55293d1cb205STejun Heo  * @...: arguments for the format string
55303d1cb205STejun Heo  *
55313d1cb205STejun Heo  * This function can be called by a running work function to describe what
55323d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
55333d1cb205STejun Heo  * information will be printed out together to help debugging.  The
55343d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
55353d1cb205STejun Heo  */
55363d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
55373d1cb205STejun Heo {
55383d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
55393d1cb205STejun Heo 	va_list args;
55403d1cb205STejun Heo 
55413d1cb205STejun Heo 	if (worker) {
55423d1cb205STejun Heo 		va_start(args, fmt);
55433d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
55443d1cb205STejun Heo 		va_end(args);
55453d1cb205STejun Heo 	}
55463d1cb205STejun Heo }
55475c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
55483d1cb205STejun Heo 
55493d1cb205STejun Heo /**
55503d1cb205STejun Heo  * print_worker_info - print out worker information and description
55513d1cb205STejun Heo  * @log_lvl: the log level to use when printing
55523d1cb205STejun Heo  * @task: target task
55533d1cb205STejun Heo  *
55543d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
55553d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
55563d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
55573d1cb205STejun Heo  *
55583d1cb205STejun Heo  * This function can be safely called on any task as long as the
55593d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
55603d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
55613d1cb205STejun Heo  */
55623d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
55633d1cb205STejun Heo {
55643d1cb205STejun Heo 	work_func_t *fn = NULL;
55653d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
55663d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
55673d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
55683d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
55693d1cb205STejun Heo 	struct worker *worker;
55703d1cb205STejun Heo 
55713d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
55723d1cb205STejun Heo 		return;
55733d1cb205STejun Heo 
55743d1cb205STejun Heo 	/*
55753d1cb205STejun Heo 	 * This function is called without any synchronization and @task
55763d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
55773d1cb205STejun Heo 	 */
5578e700591aSPetr Mladek 	worker = kthread_probe_data(task);
55793d1cb205STejun Heo 
55803d1cb205STejun Heo 	/*
55818bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
55828bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
55833d1cb205STejun Heo 	 */
5584fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
5585fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
5586fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
5587fe557319SChristoph Hellwig 	copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
5588fe557319SChristoph Hellwig 	copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
55893d1cb205STejun Heo 
55903d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
5591d75f773cSSakari Ailus 		printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
55928bf89593STejun Heo 		if (strcmp(name, desc))
55933d1cb205STejun Heo 			pr_cont(" (%s)", desc);
55943d1cb205STejun Heo 		pr_cont("\n");
55953d1cb205STejun Heo 	}
55963d1cb205STejun Heo }
55973d1cb205STejun Heo 
55983494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
55993494fc30STejun Heo {
56003494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
56013494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
56023494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
56033494fc30STejun Heo 	pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
56043494fc30STejun Heo }
56053494fc30STejun Heo 
5606c76feb0dSPaul E. McKenney struct pr_cont_work_struct {
5607c76feb0dSPaul E. McKenney 	bool comma;
5608c76feb0dSPaul E. McKenney 	work_func_t func;
5609c76feb0dSPaul E. McKenney 	long ctr;
5610c76feb0dSPaul E. McKenney };
5611c76feb0dSPaul E. McKenney 
5612c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp)
5613c76feb0dSPaul E. McKenney {
5614c76feb0dSPaul E. McKenney 	if (!pcwsp->ctr)
5615c76feb0dSPaul E. McKenney 		goto out_record;
5616c76feb0dSPaul E. McKenney 	if (func == pcwsp->func) {
5617c76feb0dSPaul E. McKenney 		pcwsp->ctr++;
5618c76feb0dSPaul E. McKenney 		return;
5619c76feb0dSPaul E. McKenney 	}
5620c76feb0dSPaul E. McKenney 	if (pcwsp->ctr == 1)
5621c76feb0dSPaul E. McKenney 		pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func);
5622c76feb0dSPaul E. McKenney 	else
5623c76feb0dSPaul E. McKenney 		pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func);
5624c76feb0dSPaul E. McKenney 	pcwsp->ctr = 0;
5625c76feb0dSPaul E. McKenney out_record:
5626c76feb0dSPaul E. McKenney 	if ((long)func == -1L)
5627c76feb0dSPaul E. McKenney 		return;
5628c76feb0dSPaul E. McKenney 	pcwsp->comma = comma;
5629c76feb0dSPaul E. McKenney 	pcwsp->func = func;
5630c76feb0dSPaul E. McKenney 	pcwsp->ctr = 1;
5631c76feb0dSPaul E. McKenney }
5632c76feb0dSPaul E. McKenney 
5633c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp)
56343494fc30STejun Heo {
56353494fc30STejun Heo 	if (work->func == wq_barrier_func) {
56363494fc30STejun Heo 		struct wq_barrier *barr;
56373494fc30STejun Heo 
56383494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
56393494fc30STejun Heo 
5640c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
56413494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
56423494fc30STejun Heo 			task_pid_nr(barr->task));
56433494fc30STejun Heo 	} else {
5644c76feb0dSPaul E. McKenney 		if (!comma)
5645c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
5646c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, work->func, pcwsp);
56473494fc30STejun Heo 	}
56483494fc30STejun Heo }
56493494fc30STejun Heo 
56503494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
56513494fc30STejun Heo {
5652c76feb0dSPaul E. McKenney 	struct pr_cont_work_struct pcws = { .ctr = 0, };
56533494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
56543494fc30STejun Heo 	struct work_struct *work;
56553494fc30STejun Heo 	struct worker *worker;
56563494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
56573494fc30STejun Heo 	int bkt;
56583494fc30STejun Heo 
56593494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
56603494fc30STejun Heo 	pr_cont_pool_info(pool);
56613494fc30STejun Heo 
5662a045a272STejun Heo 	pr_cont(" active=%d refcnt=%d%s\n",
5663a045a272STejun Heo 		pwq->nr_active, pwq->refcnt,
56643494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
56653494fc30STejun Heo 
56663494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
56673494fc30STejun Heo 		if (worker->current_pwq == pwq) {
56683494fc30STejun Heo 			has_in_flight = true;
56693494fc30STejun Heo 			break;
56703494fc30STejun Heo 		}
56713494fc30STejun Heo 	}
56723494fc30STejun Heo 	if (has_in_flight) {
56733494fc30STejun Heo 		bool comma = false;
56743494fc30STejun Heo 
56753494fc30STejun Heo 		pr_info("    in-flight:");
56763494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
56773494fc30STejun Heo 			if (worker->current_pwq != pwq)
56783494fc30STejun Heo 				continue;
56793494fc30STejun Heo 
5680d75f773cSSakari Ailus 			pr_cont("%s %d%s:%ps", comma ? "," : "",
56813494fc30STejun Heo 				task_pid_nr(worker->task),
568230ae2fc0STejun Heo 				worker->rescue_wq ? "(RESCUER)" : "",
56833494fc30STejun Heo 				worker->current_func);
56843494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
5685c76feb0dSPaul E. McKenney 				pr_cont_work(false, work, &pcws);
5686c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
56873494fc30STejun Heo 			comma = true;
56883494fc30STejun Heo 		}
56893494fc30STejun Heo 		pr_cont("\n");
56903494fc30STejun Heo 	}
56913494fc30STejun Heo 
56923494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
56933494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
56943494fc30STejun Heo 			has_pending = true;
56953494fc30STejun Heo 			break;
56963494fc30STejun Heo 		}
56973494fc30STejun Heo 	}
56983494fc30STejun Heo 	if (has_pending) {
56993494fc30STejun Heo 		bool comma = false;
57003494fc30STejun Heo 
57013494fc30STejun Heo 		pr_info("    pending:");
57023494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
57033494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
57043494fc30STejun Heo 				continue;
57053494fc30STejun Heo 
5706c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
57073494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
57083494fc30STejun Heo 		}
5709c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
57103494fc30STejun Heo 		pr_cont("\n");
57113494fc30STejun Heo 	}
57123494fc30STejun Heo 
5713f97a4a1aSLai Jiangshan 	if (!list_empty(&pwq->inactive_works)) {
57143494fc30STejun Heo 		bool comma = false;
57153494fc30STejun Heo 
5716f97a4a1aSLai Jiangshan 		pr_info("    inactive:");
5717f97a4a1aSLai Jiangshan 		list_for_each_entry(work, &pwq->inactive_works, entry) {
5718c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
57193494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
57203494fc30STejun Heo 		}
5721c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
57223494fc30STejun Heo 		pr_cont("\n");
57233494fc30STejun Heo 	}
57243494fc30STejun Heo }
57253494fc30STejun Heo 
57263494fc30STejun Heo /**
572755df0933SImran Khan  * show_one_workqueue - dump state of specified workqueue
572855df0933SImran Khan  * @wq: workqueue whose state will be printed
57293494fc30STejun Heo  */
573055df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq)
57313494fc30STejun Heo {
57323494fc30STejun Heo 	struct pool_workqueue *pwq;
57333494fc30STejun Heo 	bool idle = true;
573455df0933SImran Khan 	unsigned long flags;
57353494fc30STejun Heo 
57363494fc30STejun Heo 	for_each_pwq(pwq, wq) {
5737afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
57383494fc30STejun Heo 			idle = false;
57393494fc30STejun Heo 			break;
57403494fc30STejun Heo 		}
57413494fc30STejun Heo 	}
574255df0933SImran Khan 	if (idle) /* Nothing to print for idle workqueue */
574355df0933SImran Khan 		return;
57443494fc30STejun Heo 
57453494fc30STejun Heo 	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
57463494fc30STejun Heo 
57473494fc30STejun Heo 	for_each_pwq(pwq, wq) {
5748a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pwq->pool->lock, flags);
5749afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
575057116ce1SJohan Hovold 			/*
575157116ce1SJohan Hovold 			 * Defer printing to avoid deadlocks in console
575257116ce1SJohan Hovold 			 * drivers that queue work while holding locks
575357116ce1SJohan Hovold 			 * also taken in their write paths.
575457116ce1SJohan Hovold 			 */
575557116ce1SJohan Hovold 			printk_deferred_enter();
57563494fc30STejun Heo 			show_pwq(pwq);
575757116ce1SJohan Hovold 			printk_deferred_exit();
575857116ce1SJohan Hovold 		}
5759a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
576062635ea8SSergey Senozhatsky 		/*
576162635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
576255df0933SImran Khan 		 * sysrq-t -> show_all_workqueues(). Avoid triggering
576362635ea8SSergey Senozhatsky 		 * hard lockup.
576462635ea8SSergey Senozhatsky 		 */
576562635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
57663494fc30STejun Heo 	}
576755df0933SImran Khan 
57683494fc30STejun Heo }
57693494fc30STejun Heo 
577055df0933SImran Khan /**
577155df0933SImran Khan  * show_one_worker_pool - dump state of specified worker pool
577255df0933SImran Khan  * @pool: worker pool whose state will be printed
577355df0933SImran Khan  */
577455df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool)
577555df0933SImran Khan {
57763494fc30STejun Heo 	struct worker *worker;
57773494fc30STejun Heo 	bool first = true;
577855df0933SImran Khan 	unsigned long flags;
5779335a42ebSPetr Mladek 	unsigned long hung = 0;
57803494fc30STejun Heo 
5781a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irqsave(&pool->lock, flags);
57823494fc30STejun Heo 	if (pool->nr_workers == pool->nr_idle)
57833494fc30STejun Heo 		goto next_pool;
5784335a42ebSPetr Mladek 
5785335a42ebSPetr Mladek 	/* How long the first pending work is waiting for a worker. */
5786335a42ebSPetr Mladek 	if (!list_empty(&pool->worklist))
5787335a42ebSPetr Mladek 		hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000;
5788335a42ebSPetr Mladek 
578957116ce1SJohan Hovold 	/*
579057116ce1SJohan Hovold 	 * Defer printing to avoid deadlocks in console drivers that
579157116ce1SJohan Hovold 	 * queue work while holding locks also taken in their write
579257116ce1SJohan Hovold 	 * paths.
579357116ce1SJohan Hovold 	 */
579457116ce1SJohan Hovold 	printk_deferred_enter();
57953494fc30STejun Heo 	pr_info("pool %d:", pool->id);
57963494fc30STejun Heo 	pr_cont_pool_info(pool);
5797335a42ebSPetr Mladek 	pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers);
57983494fc30STejun Heo 	if (pool->manager)
57993494fc30STejun Heo 		pr_cont(" manager: %d",
58003494fc30STejun Heo 			task_pid_nr(pool->manager->task));
58013494fc30STejun Heo 	list_for_each_entry(worker, &pool->idle_list, entry) {
58023494fc30STejun Heo 		pr_cont(" %s%d", first ? "idle: " : "",
58033494fc30STejun Heo 			task_pid_nr(worker->task));
58043494fc30STejun Heo 		first = false;
58053494fc30STejun Heo 	}
58063494fc30STejun Heo 	pr_cont("\n");
580757116ce1SJohan Hovold 	printk_deferred_exit();
58083494fc30STejun Heo next_pool:
5809a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irqrestore(&pool->lock, flags);
581062635ea8SSergey Senozhatsky 	/*
581162635ea8SSergey Senozhatsky 	 * We could be printing a lot from atomic context, e.g.
581255df0933SImran Khan 	 * sysrq-t -> show_all_workqueues(). Avoid triggering
581362635ea8SSergey Senozhatsky 	 * hard lockup.
581462635ea8SSergey Senozhatsky 	 */
581562635ea8SSergey Senozhatsky 	touch_nmi_watchdog();
581655df0933SImran Khan 
58173494fc30STejun Heo }
58183494fc30STejun Heo 
581955df0933SImran Khan /**
582055df0933SImran Khan  * show_all_workqueues - dump workqueue state
582155df0933SImran Khan  *
5822704bc669SJungseung Lee  * Called from a sysrq handler and prints out all busy workqueues and pools.
582355df0933SImran Khan  */
582455df0933SImran Khan void show_all_workqueues(void)
582555df0933SImran Khan {
582655df0933SImran Khan 	struct workqueue_struct *wq;
582755df0933SImran Khan 	struct worker_pool *pool;
582855df0933SImran Khan 	int pi;
582955df0933SImran Khan 
583055df0933SImran Khan 	rcu_read_lock();
583155df0933SImran Khan 
583255df0933SImran Khan 	pr_info("Showing busy workqueues and worker pools:\n");
583355df0933SImran Khan 
583455df0933SImran Khan 	list_for_each_entry_rcu(wq, &workqueues, list)
583555df0933SImran Khan 		show_one_workqueue(wq);
583655df0933SImran Khan 
583755df0933SImran Khan 	for_each_pool(pool, pi)
583855df0933SImran Khan 		show_one_worker_pool(pool);
583955df0933SImran Khan 
584024acfb71SThomas Gleixner 	rcu_read_unlock();
58413494fc30STejun Heo }
58423494fc30STejun Heo 
5843704bc669SJungseung Lee /**
5844704bc669SJungseung Lee  * show_freezable_workqueues - dump freezable workqueue state
5845704bc669SJungseung Lee  *
5846704bc669SJungseung Lee  * Called from try_to_freeze_tasks() and prints out all freezable workqueues
5847704bc669SJungseung Lee  * still busy.
5848704bc669SJungseung Lee  */
5849704bc669SJungseung Lee void show_freezable_workqueues(void)
5850704bc669SJungseung Lee {
5851704bc669SJungseung Lee 	struct workqueue_struct *wq;
5852704bc669SJungseung Lee 
5853704bc669SJungseung Lee 	rcu_read_lock();
5854704bc669SJungseung Lee 
5855704bc669SJungseung Lee 	pr_info("Showing freezable workqueues that are still busy:\n");
5856704bc669SJungseung Lee 
5857704bc669SJungseung Lee 	list_for_each_entry_rcu(wq, &workqueues, list) {
5858704bc669SJungseung Lee 		if (!(wq->flags & WQ_FREEZABLE))
5859704bc669SJungseung Lee 			continue;
5860704bc669SJungseung Lee 		show_one_workqueue(wq);
5861704bc669SJungseung Lee 	}
5862704bc669SJungseung Lee 
5863704bc669SJungseung Lee 	rcu_read_unlock();
5864704bc669SJungseung Lee }
5865704bc669SJungseung Lee 
58666b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
58676b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
58686b59808bSTejun Heo {
58696b59808bSTejun Heo 	int off;
58706b59808bSTejun Heo 
58716b59808bSTejun Heo 	/* always show the actual comm */
58726b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
58736b59808bSTejun Heo 	if (off < 0)
58746b59808bSTejun Heo 		return;
58756b59808bSTejun Heo 
5876197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
58776b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
58786b59808bSTejun Heo 
5879197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
5880197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
5881197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
58826b59808bSTejun Heo 
58836b59808bSTejun Heo 		if (pool) {
5884a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock_irq(&pool->lock);
58856b59808bSTejun Heo 			/*
5886197f6accSTejun Heo 			 * ->desc tracks information (wq name or
5887197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
5888197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
58896b59808bSTejun Heo 			 */
58906b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
58916b59808bSTejun Heo 				if (worker->current_work)
58926b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
58936b59808bSTejun Heo 						  worker->desc);
58946b59808bSTejun Heo 				else
58956b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
58966b59808bSTejun Heo 						  worker->desc);
58976b59808bSTejun Heo 			}
5898a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pool->lock);
58996b59808bSTejun Heo 		}
5900197f6accSTejun Heo 	}
59016b59808bSTejun Heo 
59026b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
59036b59808bSTejun Heo }
59046b59808bSTejun Heo 
590566448bc2SMathieu Malaterre #ifdef CONFIG_SMP
590666448bc2SMathieu Malaterre 
5907db7bccf4STejun Heo /*
5908db7bccf4STejun Heo  * CPU hotplug.
5909db7bccf4STejun Heo  *
5910e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
5911112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
5912706026c2STejun Heo  * pool which make migrating pending and scheduled works very
5913e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
591494cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
5915e22bee78STejun Heo  * blocked draining impractical.
5916e22bee78STejun Heo  *
591724647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
5918628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
5919628c78e7STejun Heo  * cpu comes back online.
5920db7bccf4STejun Heo  */
5921db7bccf4STejun Heo 
5922e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
5923db7bccf4STejun Heo {
59244ce62e9eSTejun Heo 	struct worker_pool *pool;
5925db7bccf4STejun Heo 	struct worker *worker;
5926db7bccf4STejun Heo 
5927f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
59281258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
5929a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
5930e22bee78STejun Heo 
5931f2d5a0eeSTejun Heo 		/*
593292f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
593394cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
593411b45b0bSLai Jiangshan 		 * must be on the cpu.  After this, they may become diasporas.
5935b4ac9384SLai Jiangshan 		 * And the preemption disabled section in their sched callbacks
5936b4ac9384SLai Jiangshan 		 * are guaranteed to see WORKER_UNBOUND since the code here
5937b4ac9384SLai Jiangshan 		 * is on the same cpu.
5938f2d5a0eeSTejun Heo 		 */
5939da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
5940403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
5941db7bccf4STejun Heo 
594224647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
5943f2d5a0eeSTejun Heo 
5944e22bee78STejun Heo 		/*
5945989442d7SLai Jiangshan 		 * The handling of nr_running in sched callbacks are disabled
5946989442d7SLai Jiangshan 		 * now.  Zap nr_running.  After this, nr_running stays zero and
5947989442d7SLai Jiangshan 		 * need_more_worker() and keep_working() are always true as
5948989442d7SLai Jiangshan 		 * long as the worklist is not empty.  This pool now behaves as
5949989442d7SLai Jiangshan 		 * an unbound (in terms of concurrency management) pool which
5950eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
5951e22bee78STejun Heo 		 */
5952bc35f7efSLai Jiangshan 		pool->nr_running = 0;
5953eb283428SLai Jiangshan 
5954eb283428SLai Jiangshan 		/*
5955eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
5956eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
5957eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
5958eb283428SLai Jiangshan 		 */
59590219a352STejun Heo 		kick_pool(pool);
5960989442d7SLai Jiangshan 
5961a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
5962989442d7SLai Jiangshan 
5963793777bcSValentin Schneider 		for_each_pool_worker(worker, pool)
5964793777bcSValentin Schneider 			unbind_worker(worker);
5965989442d7SLai Jiangshan 
5966989442d7SLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
5967eb283428SLai Jiangshan 	}
5968db7bccf4STejun Heo }
5969db7bccf4STejun Heo 
5970bd7c089eSTejun Heo /**
5971bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
5972bd7c089eSTejun Heo  * @pool: pool of interest
5973bd7c089eSTejun Heo  *
5974a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
5975bd7c089eSTejun Heo  */
5976bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
5977bd7c089eSTejun Heo {
5978a9ab775bSTejun Heo 	struct worker *worker;
5979bd7c089eSTejun Heo 
59801258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
5981bd7c089eSTejun Heo 
5982bd7c089eSTejun Heo 	/*
5983a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
5984a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
5985402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
5986a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
5987a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
5988bd7c089eSTejun Heo 	 */
5989c63a2e52SValentin Schneider 	for_each_pool_worker(worker, pool) {
5990c63a2e52SValentin Schneider 		kthread_set_per_cpu(worker->task, pool->cpu);
5991c63a2e52SValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
59929546b29eSTejun Heo 						  pool_allowed_cpus(pool)) < 0);
5993c63a2e52SValentin Schneider 	}
5994a9ab775bSTejun Heo 
5995a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
5996f7c17d26SWanpeng Li 
59973de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
5998a9ab775bSTejun Heo 
5999da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
6000a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
6001a9ab775bSTejun Heo 
6002a9ab775bSTejun Heo 		/*
6003a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
6004a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
6005a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
6006a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
6007a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
6008a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
6009a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
6010a9ab775bSTejun Heo 		 *
6011c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
6012a9ab775bSTejun Heo 		 * tested without holding any lock in
60136d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
6014a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
6015a9ab775bSTejun Heo 		 * management operations.
6016bd7c089eSTejun Heo 		 */
6017a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
6018a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
6019a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
6020c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
6021bd7c089eSTejun Heo 	}
6022a9ab775bSTejun Heo 
6023a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
6024bd7c089eSTejun Heo }
6025bd7c089eSTejun Heo 
60267dbc725eSTejun Heo /**
60277dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
60287dbc725eSTejun Heo  * @pool: unbound pool of interest
60297dbc725eSTejun Heo  * @cpu: the CPU which is coming up
60307dbc725eSTejun Heo  *
60317dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
60327dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
60337dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
60347dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
60357dbc725eSTejun Heo  */
60367dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
60377dbc725eSTejun Heo {
60387dbc725eSTejun Heo 	static cpumask_t cpumask;
60397dbc725eSTejun Heo 	struct worker *worker;
60407dbc725eSTejun Heo 
60411258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
60427dbc725eSTejun Heo 
60437dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
60447dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
60457dbc725eSTejun Heo 		return;
60467dbc725eSTejun Heo 
60477dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
60487dbc725eSTejun Heo 
60497dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
6050da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
6051d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
60527dbc725eSTejun Heo }
60537dbc725eSTejun Heo 
60547ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
60551da177e4SLinus Torvalds {
60564ce62e9eSTejun Heo 	struct worker_pool *pool;
60571da177e4SLinus Torvalds 
6058f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
60593ce63377STejun Heo 		if (pool->nr_workers)
60603ce63377STejun Heo 			continue;
6061051e1850SLai Jiangshan 		if (!create_worker(pool))
60627ee681b2SThomas Gleixner 			return -ENOMEM;
60633af24433SOleg Nesterov 	}
60647ee681b2SThomas Gleixner 	return 0;
60657ee681b2SThomas Gleixner }
60661da177e4SLinus Torvalds 
60677ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
60687ee681b2SThomas Gleixner {
60697ee681b2SThomas Gleixner 	struct worker_pool *pool;
60707ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
60717ee681b2SThomas Gleixner 	int pi;
60727ee681b2SThomas Gleixner 
607368e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
60747dbc725eSTejun Heo 
60757dbc725eSTejun Heo 	for_each_pool(pool, pi) {
60761258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
607794cf58bbSTejun Heo 
6078f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
607994cf58bbSTejun Heo 			rebind_workers(pool);
6080f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
60817dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
608294cf58bbSTejun Heo 
60831258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
608494cf58bbSTejun Heo 	}
60857dbc725eSTejun Heo 
6086fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
60874cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
608884193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
608984193c07STejun Heo 
609084193c07STejun Heo 		if (attrs) {
609184193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
60924cbfd3deSTejun Heo 			int tcpu;
60934cbfd3deSTejun Heo 
609484193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6095fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, true);
60965797b1c1STejun Heo 
60975797b1c1STejun Heo 			mutex_lock(&wq->mutex);
60985797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
60995797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
61004cbfd3deSTejun Heo 		}
61014cbfd3deSTejun Heo 	}
61024c16bd32STejun Heo 
610368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
61047ee681b2SThomas Gleixner 	return 0;
610565758202STejun Heo }
610665758202STejun Heo 
61077ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
610865758202STejun Heo {
61094c16bd32STejun Heo 	struct workqueue_struct *wq;
61108db25e78STejun Heo 
61114c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
6112e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
6113e8b3f8dbSLai Jiangshan 		return -1;
6114e8b3f8dbSLai Jiangshan 
6115e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
61164c16bd32STejun Heo 
6117fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
61184c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
61194cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
612084193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
612184193c07STejun Heo 
612284193c07STejun Heo 		if (attrs) {
612384193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
61244cbfd3deSTejun Heo 			int tcpu;
61254cbfd3deSTejun Heo 
612684193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6127fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, false);
61285797b1c1STejun Heo 
61295797b1c1STejun Heo 			mutex_lock(&wq->mutex);
61305797b1c1STejun Heo 			wq_update_node_max_active(wq, cpu);
61315797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
61324cbfd3deSTejun Heo 		}
61334cbfd3deSTejun Heo 	}
61344c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
61354c16bd32STejun Heo 
61367ee681b2SThomas Gleixner 	return 0;
613765758202STejun Heo }
613865758202STejun Heo 
61392d3854a3SRusty Russell struct work_for_cpu {
6140ed48ece2STejun Heo 	struct work_struct work;
61412d3854a3SRusty Russell 	long (*fn)(void *);
61422d3854a3SRusty Russell 	void *arg;
61432d3854a3SRusty Russell 	long ret;
61442d3854a3SRusty Russell };
61452d3854a3SRusty Russell 
6146ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
61472d3854a3SRusty Russell {
6148ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
6149ed48ece2STejun Heo 
61502d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
61512d3854a3SRusty Russell }
61522d3854a3SRusty Russell 
61532d3854a3SRusty Russell /**
6154265f3ed0SFrederic Weisbecker  * work_on_cpu_key - run a function in thread context on a particular cpu
61552d3854a3SRusty Russell  * @cpu: the cpu to run on
61562d3854a3SRusty Russell  * @fn: the function to run
61572d3854a3SRusty Russell  * @arg: the function arg
6158265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
61592d3854a3SRusty Russell  *
616031ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
61616b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
6162d185af30SYacine Belkadi  *
6163d185af30SYacine Belkadi  * Return: The value @fn returns.
61642d3854a3SRusty Russell  */
6165265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *),
6166265f3ed0SFrederic Weisbecker 		     void *arg, struct lock_class_key *key)
61672d3854a3SRusty Russell {
6168ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
61692d3854a3SRusty Russell 
6170265f3ed0SFrederic Weisbecker 	INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key);
6171ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
617212997d1aSBjorn Helgaas 	flush_work(&wfc.work);
6173440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
61742d3854a3SRusty Russell 	return wfc.ret;
61752d3854a3SRusty Russell }
6176265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key);
61770e8d6a93SThomas Gleixner 
61780e8d6a93SThomas Gleixner /**
6179265f3ed0SFrederic Weisbecker  * work_on_cpu_safe_key - run a function in thread context on a particular cpu
61800e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
61810e8d6a93SThomas Gleixner  * @fn:  the function to run
61820e8d6a93SThomas Gleixner  * @arg: the function argument
6183265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
61840e8d6a93SThomas Gleixner  *
61850e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
61860e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
61870e8d6a93SThomas Gleixner  *
61880e8d6a93SThomas Gleixner  * Return: The value @fn returns.
61890e8d6a93SThomas Gleixner  */
6190265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *),
6191265f3ed0SFrederic Weisbecker 			  void *arg, struct lock_class_key *key)
61920e8d6a93SThomas Gleixner {
61930e8d6a93SThomas Gleixner 	long ret = -ENODEV;
61940e8d6a93SThomas Gleixner 
6195ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
61960e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
6197265f3ed0SFrederic Weisbecker 		ret = work_on_cpu_key(cpu, fn, arg, key);
6198ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
61990e8d6a93SThomas Gleixner 	return ret;
62000e8d6a93SThomas Gleixner }
6201265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key);
62022d3854a3SRusty Russell #endif /* CONFIG_SMP */
62032d3854a3SRusty Russell 
6204a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
6205e7577c50SRusty Russell 
6206a0a1a5fdSTejun Heo /**
6207a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
6208a0a1a5fdSTejun Heo  *
620958a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
6210f97a4a1aSLai Jiangshan  * workqueues will queue new works to their inactive_works list instead of
6211706026c2STejun Heo  * pool->worklist.
6212a0a1a5fdSTejun Heo  *
6213a0a1a5fdSTejun Heo  * CONTEXT:
6214a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6215a0a1a5fdSTejun Heo  */
6216a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
6217a0a1a5fdSTejun Heo {
621824b8a847STejun Heo 	struct workqueue_struct *wq;
6219a0a1a5fdSTejun Heo 
622068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6221a0a1a5fdSTejun Heo 
62226183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
6223a0a1a5fdSTejun Heo 	workqueue_freezing = true;
6224a0a1a5fdSTejun Heo 
622524b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6226a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6227a045a272STejun Heo 		wq_adjust_max_active(wq);
6228a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
6229a1056305STejun Heo 	}
62305bcab335STejun Heo 
623168e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6232a0a1a5fdSTejun Heo }
6233a0a1a5fdSTejun Heo 
6234a0a1a5fdSTejun Heo /**
623558a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
6236a0a1a5fdSTejun Heo  *
6237a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
6238a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
6239a0a1a5fdSTejun Heo  *
6240a0a1a5fdSTejun Heo  * CONTEXT:
624168e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
6242a0a1a5fdSTejun Heo  *
6243d185af30SYacine Belkadi  * Return:
624458a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
624558a69cb4STejun Heo  * is complete.
6246a0a1a5fdSTejun Heo  */
6247a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
6248a0a1a5fdSTejun Heo {
6249a0a1a5fdSTejun Heo 	bool busy = false;
625024b8a847STejun Heo 	struct workqueue_struct *wq;
625124b8a847STejun Heo 	struct pool_workqueue *pwq;
6252a0a1a5fdSTejun Heo 
625368e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6254a0a1a5fdSTejun Heo 
62556183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
6256a0a1a5fdSTejun Heo 
625724b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
625824b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
625924b8a847STejun Heo 			continue;
6260a0a1a5fdSTejun Heo 		/*
6261a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
6262a0a1a5fdSTejun Heo 		 * to peek without lock.
6263a0a1a5fdSTejun Heo 		 */
626424acfb71SThomas Gleixner 		rcu_read_lock();
626524b8a847STejun Heo 		for_each_pwq(pwq, wq) {
62666183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
6267112202d9STejun Heo 			if (pwq->nr_active) {
6268a0a1a5fdSTejun Heo 				busy = true;
626924acfb71SThomas Gleixner 				rcu_read_unlock();
6270a0a1a5fdSTejun Heo 				goto out_unlock;
6271a0a1a5fdSTejun Heo 			}
6272a0a1a5fdSTejun Heo 		}
627324acfb71SThomas Gleixner 		rcu_read_unlock();
6274a0a1a5fdSTejun Heo 	}
6275a0a1a5fdSTejun Heo out_unlock:
627668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6277a0a1a5fdSTejun Heo 	return busy;
6278a0a1a5fdSTejun Heo }
6279a0a1a5fdSTejun Heo 
6280a0a1a5fdSTejun Heo /**
6281a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
6282a0a1a5fdSTejun Heo  *
6283a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
6284706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
6285a0a1a5fdSTejun Heo  *
6286a0a1a5fdSTejun Heo  * CONTEXT:
6287a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6288a0a1a5fdSTejun Heo  */
6289a0a1a5fdSTejun Heo void thaw_workqueues(void)
6290a0a1a5fdSTejun Heo {
629124b8a847STejun Heo 	struct workqueue_struct *wq;
6292a0a1a5fdSTejun Heo 
629368e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6294a0a1a5fdSTejun Heo 
6295a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
6296a0a1a5fdSTejun Heo 		goto out_unlock;
6297a0a1a5fdSTejun Heo 
629874b414eaSLai Jiangshan 	workqueue_freezing = false;
629924b8a847STejun Heo 
630024b8a847STejun Heo 	/* restore max_active and repopulate worklist */
630124b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6302a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6303a045a272STejun Heo 		wq_adjust_max_active(wq);
6304a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
630524b8a847STejun Heo 	}
630624b8a847STejun Heo 
6307a0a1a5fdSTejun Heo out_unlock:
630868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6309a0a1a5fdSTejun Heo }
6310a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
6311a0a1a5fdSTejun Heo 
631299c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask)
6313042f7df1SLai Jiangshan {
6314042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
6315042f7df1SLai Jiangshan 	int ret = 0;
6316042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
6317042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
6318042f7df1SLai Jiangshan 
6319042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6320042f7df1SLai Jiangshan 
6321042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
6322042f7df1SLai Jiangshan 		if (!(wq->flags & WQ_UNBOUND))
6323042f7df1SLai Jiangshan 			continue;
6324ca10d851SWaiman Long 
6325042f7df1SLai Jiangshan 		/* creating multiple pwqs breaks ordering guarantee */
6326ca10d851SWaiman Long 		if (!list_empty(&wq->pwqs)) {
6327ca10d851SWaiman Long 			if (wq->flags & __WQ_ORDERED_EXPLICIT)
6328042f7df1SLai Jiangshan 				continue;
6329ca10d851SWaiman Long 			wq->flags &= ~__WQ_ORDERED;
6330ca10d851SWaiman Long 		}
6331042f7df1SLai Jiangshan 
633299c621efSLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask);
633384193c07STejun Heo 		if (IS_ERR(ctx)) {
633484193c07STejun Heo 			ret = PTR_ERR(ctx);
6335042f7df1SLai Jiangshan 			break;
6336042f7df1SLai Jiangshan 		}
6337042f7df1SLai Jiangshan 
6338042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
6339042f7df1SLai Jiangshan 	}
6340042f7df1SLai Jiangshan 
6341042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
6342042f7df1SLai Jiangshan 		if (!ret)
6343042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
6344042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
6345042f7df1SLai Jiangshan 	}
6346042f7df1SLai Jiangshan 
634799c621efSLai Jiangshan 	if (!ret) {
634899c621efSLai Jiangshan 		mutex_lock(&wq_pool_attach_mutex);
634999c621efSLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, unbound_cpumask);
635099c621efSLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
635199c621efSLai Jiangshan 	}
6352042f7df1SLai Jiangshan 	return ret;
6353042f7df1SLai Jiangshan }
6354042f7df1SLai Jiangshan 
6355042f7df1SLai Jiangshan /**
6356fe28f631SWaiman Long  * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask
6357fe28f631SWaiman Long  * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask
6358fe28f631SWaiman Long  *
6359fe28f631SWaiman Long  * This function can be called from cpuset code to provide a set of isolated
6360fe28f631SWaiman Long  * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold
6361fe28f631SWaiman Long  * either cpus_read_lock or cpus_write_lock.
6362fe28f631SWaiman Long  */
6363fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask)
6364fe28f631SWaiman Long {
6365fe28f631SWaiman Long 	cpumask_var_t cpumask;
6366fe28f631SWaiman Long 	int ret = 0;
6367fe28f631SWaiman Long 
6368fe28f631SWaiman Long 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6369fe28f631SWaiman Long 		return -ENOMEM;
6370fe28f631SWaiman Long 
6371fe28f631SWaiman Long 	lockdep_assert_cpus_held();
6372fe28f631SWaiman Long 	mutex_lock(&wq_pool_mutex);
6373fe28f631SWaiman Long 
6374fe28f631SWaiman Long 	/* Save the current isolated cpumask & export it via sysfs */
6375fe28f631SWaiman Long 	cpumask_copy(wq_isolated_cpumask, exclude_cpumask);
6376fe28f631SWaiman Long 
6377fe28f631SWaiman Long 	/*
6378fe28f631SWaiman Long 	 * If the operation fails, it will fall back to
6379fe28f631SWaiman Long 	 * wq_requested_unbound_cpumask which is initially set to
6380fe28f631SWaiman Long 	 * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten
6381fe28f631SWaiman Long 	 * by any subsequent write to workqueue/cpumask sysfs file.
6382fe28f631SWaiman Long 	 */
6383fe28f631SWaiman Long 	if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask))
6384fe28f631SWaiman Long 		cpumask_copy(cpumask, wq_requested_unbound_cpumask);
6385fe28f631SWaiman Long 	if (!cpumask_equal(cpumask, wq_unbound_cpumask))
6386fe28f631SWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
6387fe28f631SWaiman Long 
6388fe28f631SWaiman Long 	mutex_unlock(&wq_pool_mutex);
6389fe28f631SWaiman Long 	free_cpumask_var(cpumask);
6390fe28f631SWaiman Long 	return ret;
6391fe28f631SWaiman Long }
6392fe28f631SWaiman Long 
639363c5484eSTejun Heo static int parse_affn_scope(const char *val)
639463c5484eSTejun Heo {
639563c5484eSTejun Heo 	int i;
639663c5484eSTejun Heo 
639763c5484eSTejun Heo 	for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) {
639863c5484eSTejun Heo 		if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i])))
639963c5484eSTejun Heo 			return i;
640063c5484eSTejun Heo 	}
640163c5484eSTejun Heo 	return -EINVAL;
640263c5484eSTejun Heo }
640363c5484eSTejun Heo 
640463c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp)
640563c5484eSTejun Heo {
6406523a301eSTejun Heo 	struct workqueue_struct *wq;
6407523a301eSTejun Heo 	int affn, cpu;
640863c5484eSTejun Heo 
640963c5484eSTejun Heo 	affn = parse_affn_scope(val);
641063c5484eSTejun Heo 	if (affn < 0)
641163c5484eSTejun Heo 		return affn;
6412523a301eSTejun Heo 	if (affn == WQ_AFFN_DFL)
6413523a301eSTejun Heo 		return -EINVAL;
6414523a301eSTejun Heo 
6415523a301eSTejun Heo 	cpus_read_lock();
6416523a301eSTejun Heo 	mutex_lock(&wq_pool_mutex);
641763c5484eSTejun Heo 
641863c5484eSTejun Heo 	wq_affn_dfl = affn;
6419523a301eSTejun Heo 
6420523a301eSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6421523a301eSTejun Heo 		for_each_online_cpu(cpu) {
6422523a301eSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
6423523a301eSTejun Heo 		}
6424523a301eSTejun Heo 	}
6425523a301eSTejun Heo 
6426523a301eSTejun Heo 	mutex_unlock(&wq_pool_mutex);
6427523a301eSTejun Heo 	cpus_read_unlock();
6428523a301eSTejun Heo 
642963c5484eSTejun Heo 	return 0;
643063c5484eSTejun Heo }
643163c5484eSTejun Heo 
643263c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp)
643363c5484eSTejun Heo {
643463c5484eSTejun Heo 	return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]);
643563c5484eSTejun Heo }
643663c5484eSTejun Heo 
643763c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = {
643863c5484eSTejun Heo 	.set	= wq_affn_dfl_set,
643963c5484eSTejun Heo 	.get	= wq_affn_dfl_get,
644063c5484eSTejun Heo };
644163c5484eSTejun Heo 
644263c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644);
644363c5484eSTejun Heo 
64446ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
64456ba94429SFrederic Weisbecker /*
64466ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
64476ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
64486ba94429SFrederic Weisbecker  * following attributes.
64496ba94429SFrederic Weisbecker  *
64506ba94429SFrederic Weisbecker  *  per_cpu		RO bool	: whether the workqueue is per-cpu or unbound
64516ba94429SFrederic Weisbecker  *  max_active		RW int	: maximum number of in-flight work items
64526ba94429SFrederic Weisbecker  *
64536ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
64546ba94429SFrederic Weisbecker  *
64556ba94429SFrederic Weisbecker  *  nice		RW int	: nice value of the workers
64566ba94429SFrederic Weisbecker  *  cpumask		RW mask	: bitmask of allowed CPUs for the workers
645763c5484eSTejun Heo  *  affinity_scope	RW str  : worker CPU affinity scope (cache, numa, none)
64588639ecebSTejun Heo  *  affinity_strict	RW bool : worker CPU affinity is strict
64596ba94429SFrederic Weisbecker  */
64606ba94429SFrederic Weisbecker struct wq_device {
64616ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
64626ba94429SFrederic Weisbecker 	struct device			dev;
64636ba94429SFrederic Weisbecker };
64646ba94429SFrederic Weisbecker 
64656ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
64666ba94429SFrederic Weisbecker {
64676ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
64686ba94429SFrederic Weisbecker 
64696ba94429SFrederic Weisbecker 	return wq_dev->wq;
64706ba94429SFrederic Weisbecker }
64716ba94429SFrederic Weisbecker 
64726ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
64736ba94429SFrederic Weisbecker 			    char *buf)
64746ba94429SFrederic Weisbecker {
64756ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
64766ba94429SFrederic Weisbecker 
64776ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
64786ba94429SFrederic Weisbecker }
64796ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
64806ba94429SFrederic Weisbecker 
64816ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
64826ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
64836ba94429SFrederic Weisbecker {
64846ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
64856ba94429SFrederic Weisbecker 
64866ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
64876ba94429SFrederic Weisbecker }
64886ba94429SFrederic Weisbecker 
64896ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
64906ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
64916ba94429SFrederic Weisbecker 				size_t count)
64926ba94429SFrederic Weisbecker {
64936ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
64946ba94429SFrederic Weisbecker 	int val;
64956ba94429SFrederic Weisbecker 
64966ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
64976ba94429SFrederic Weisbecker 		return -EINVAL;
64986ba94429SFrederic Weisbecker 
64996ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
65006ba94429SFrederic Weisbecker 	return count;
65016ba94429SFrederic Weisbecker }
65026ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
65036ba94429SFrederic Weisbecker 
65046ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
65056ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
65066ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
65076ba94429SFrederic Weisbecker 	NULL,
65086ba94429SFrederic Weisbecker };
65096ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
65106ba94429SFrederic Weisbecker 
651149277a5bSWaiman Long static void apply_wqattrs_lock(void)
651249277a5bSWaiman Long {
651349277a5bSWaiman Long 	/* CPUs should stay stable across pwq creations and installations */
651449277a5bSWaiman Long 	cpus_read_lock();
651549277a5bSWaiman Long 	mutex_lock(&wq_pool_mutex);
651649277a5bSWaiman Long }
651749277a5bSWaiman Long 
651849277a5bSWaiman Long static void apply_wqattrs_unlock(void)
651949277a5bSWaiman Long {
652049277a5bSWaiman Long 	mutex_unlock(&wq_pool_mutex);
652149277a5bSWaiman Long 	cpus_read_unlock();
652249277a5bSWaiman Long }
652349277a5bSWaiman Long 
65246ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
65256ba94429SFrederic Weisbecker 			    char *buf)
65266ba94429SFrederic Weisbecker {
65276ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
65286ba94429SFrederic Weisbecker 	int written;
65296ba94429SFrederic Weisbecker 
65306ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
65316ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
65326ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
65336ba94429SFrederic Weisbecker 
65346ba94429SFrederic Weisbecker 	return written;
65356ba94429SFrederic Weisbecker }
65366ba94429SFrederic Weisbecker 
65376ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
65386ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
65396ba94429SFrederic Weisbecker {
65406ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
65416ba94429SFrederic Weisbecker 
6542899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6543899a94feSLai Jiangshan 
6544be69d00dSThomas Gleixner 	attrs = alloc_workqueue_attrs();
65456ba94429SFrederic Weisbecker 	if (!attrs)
65466ba94429SFrederic Weisbecker 		return NULL;
65476ba94429SFrederic Weisbecker 
65486ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
65496ba94429SFrederic Weisbecker 	return attrs;
65506ba94429SFrederic Weisbecker }
65516ba94429SFrederic Weisbecker 
65526ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
65536ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
65546ba94429SFrederic Weisbecker {
65556ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
65566ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6557d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6558d4d3e257SLai Jiangshan 
6559d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
65606ba94429SFrederic Weisbecker 
65616ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
65626ba94429SFrederic Weisbecker 	if (!attrs)
6563d4d3e257SLai Jiangshan 		goto out_unlock;
65646ba94429SFrederic Weisbecker 
65656ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
65666ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
6567d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
65686ba94429SFrederic Weisbecker 	else
65696ba94429SFrederic Weisbecker 		ret = -EINVAL;
65706ba94429SFrederic Weisbecker 
6571d4d3e257SLai Jiangshan out_unlock:
6572d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
65736ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
65746ba94429SFrederic Weisbecker 	return ret ?: count;
65756ba94429SFrederic Weisbecker }
65766ba94429SFrederic Weisbecker 
65776ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
65786ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
65796ba94429SFrederic Weisbecker {
65806ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
65816ba94429SFrederic Weisbecker 	int written;
65826ba94429SFrederic Weisbecker 
65836ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
65846ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
65856ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
65866ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
65876ba94429SFrederic Weisbecker 	return written;
65886ba94429SFrederic Weisbecker }
65896ba94429SFrederic Weisbecker 
65906ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
65916ba94429SFrederic Weisbecker 				struct device_attribute *attr,
65926ba94429SFrederic Weisbecker 				const char *buf, size_t count)
65936ba94429SFrederic Weisbecker {
65946ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
65956ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6596d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6597d4d3e257SLai Jiangshan 
6598d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
65996ba94429SFrederic Weisbecker 
66006ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
66016ba94429SFrederic Weisbecker 	if (!attrs)
6602d4d3e257SLai Jiangshan 		goto out_unlock;
66036ba94429SFrederic Weisbecker 
66046ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
66056ba94429SFrederic Weisbecker 	if (!ret)
6606d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
66076ba94429SFrederic Weisbecker 
6608d4d3e257SLai Jiangshan out_unlock:
6609d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
66106ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
66116ba94429SFrederic Weisbecker 	return ret ?: count;
66126ba94429SFrederic Weisbecker }
66136ba94429SFrederic Weisbecker 
661463c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev,
661563c5484eSTejun Heo 				  struct device_attribute *attr, char *buf)
661663c5484eSTejun Heo {
661763c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
661863c5484eSTejun Heo 	int written;
661963c5484eSTejun Heo 
662063c5484eSTejun Heo 	mutex_lock(&wq->mutex);
6621523a301eSTejun Heo 	if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL)
6622523a301eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n",
6623523a301eSTejun Heo 				    wq_affn_names[WQ_AFFN_DFL],
6624523a301eSTejun Heo 				    wq_affn_names[wq_affn_dfl]);
6625523a301eSTejun Heo 	else
662663c5484eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s\n",
662763c5484eSTejun Heo 				    wq_affn_names[wq->unbound_attrs->affn_scope]);
662863c5484eSTejun Heo 	mutex_unlock(&wq->mutex);
662963c5484eSTejun Heo 
663063c5484eSTejun Heo 	return written;
663163c5484eSTejun Heo }
663263c5484eSTejun Heo 
663363c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev,
663463c5484eSTejun Heo 				   struct device_attribute *attr,
663563c5484eSTejun Heo 				   const char *buf, size_t count)
663663c5484eSTejun Heo {
663763c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
663863c5484eSTejun Heo 	struct workqueue_attrs *attrs;
663963c5484eSTejun Heo 	int affn, ret = -ENOMEM;
664063c5484eSTejun Heo 
664163c5484eSTejun Heo 	affn = parse_affn_scope(buf);
664263c5484eSTejun Heo 	if (affn < 0)
664363c5484eSTejun Heo 		return affn;
664463c5484eSTejun Heo 
664563c5484eSTejun Heo 	apply_wqattrs_lock();
664663c5484eSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
664763c5484eSTejun Heo 	if (attrs) {
664863c5484eSTejun Heo 		attrs->affn_scope = affn;
664963c5484eSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
665063c5484eSTejun Heo 	}
665163c5484eSTejun Heo 	apply_wqattrs_unlock();
665263c5484eSTejun Heo 	free_workqueue_attrs(attrs);
665363c5484eSTejun Heo 	return ret ?: count;
665463c5484eSTejun Heo }
665563c5484eSTejun Heo 
66568639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev,
66578639ecebSTejun Heo 				       struct device_attribute *attr, char *buf)
66588639ecebSTejun Heo {
66598639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
66608639ecebSTejun Heo 
66618639ecebSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n",
66628639ecebSTejun Heo 			 wq->unbound_attrs->affn_strict);
66638639ecebSTejun Heo }
66648639ecebSTejun Heo 
66658639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev,
66668639ecebSTejun Heo 					struct device_attribute *attr,
66678639ecebSTejun Heo 					const char *buf, size_t count)
66688639ecebSTejun Heo {
66698639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
66708639ecebSTejun Heo 	struct workqueue_attrs *attrs;
66718639ecebSTejun Heo 	int v, ret = -ENOMEM;
66728639ecebSTejun Heo 
66738639ecebSTejun Heo 	if (sscanf(buf, "%d", &v) != 1)
66748639ecebSTejun Heo 		return -EINVAL;
66758639ecebSTejun Heo 
66768639ecebSTejun Heo 	apply_wqattrs_lock();
66778639ecebSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
66788639ecebSTejun Heo 	if (attrs) {
66798639ecebSTejun Heo 		attrs->affn_strict = (bool)v;
66808639ecebSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
66818639ecebSTejun Heo 	}
66828639ecebSTejun Heo 	apply_wqattrs_unlock();
66838639ecebSTejun Heo 	free_workqueue_attrs(attrs);
66848639ecebSTejun Heo 	return ret ?: count;
66858639ecebSTejun Heo }
66868639ecebSTejun Heo 
66876ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
66886ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
66896ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
669063c5484eSTejun Heo 	__ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store),
66918639ecebSTejun Heo 	__ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store),
66926ba94429SFrederic Weisbecker 	__ATTR_NULL,
66936ba94429SFrederic Weisbecker };
66946ba94429SFrederic Weisbecker 
6695*d412ace1SRicardo B. Marliere static const struct bus_type wq_subsys = {
66966ba94429SFrederic Weisbecker 	.name				= "workqueue",
66976ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
66986ba94429SFrederic Weisbecker };
66996ba94429SFrederic Weisbecker 
670049277a5bSWaiman Long /**
670149277a5bSWaiman Long  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
670249277a5bSWaiman Long  *  @cpumask: the cpumask to set
670349277a5bSWaiman Long  *
670449277a5bSWaiman Long  *  The low-level workqueues cpumask is a global cpumask that limits
670549277a5bSWaiman Long  *  the affinity of all unbound workqueues.  This function check the @cpumask
670649277a5bSWaiman Long  *  and apply it to all unbound workqueues and updates all pwqs of them.
670749277a5bSWaiman Long  *
670849277a5bSWaiman Long  *  Return:	0	- Success
670949277a5bSWaiman Long  *		-EINVAL	- Invalid @cpumask
671049277a5bSWaiman Long  *		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
671149277a5bSWaiman Long  */
671249277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
671349277a5bSWaiman Long {
671449277a5bSWaiman Long 	int ret = -EINVAL;
671549277a5bSWaiman Long 
671649277a5bSWaiman Long 	/*
671749277a5bSWaiman Long 	 * Not excluding isolated cpus on purpose.
671849277a5bSWaiman Long 	 * If the user wishes to include them, we allow that.
671949277a5bSWaiman Long 	 */
672049277a5bSWaiman Long 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
672149277a5bSWaiman Long 	if (!cpumask_empty(cpumask)) {
672249277a5bSWaiman Long 		apply_wqattrs_lock();
672349277a5bSWaiman Long 		cpumask_copy(wq_requested_unbound_cpumask, cpumask);
672449277a5bSWaiman Long 		if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
672549277a5bSWaiman Long 			ret = 0;
672649277a5bSWaiman Long 			goto out_unlock;
672749277a5bSWaiman Long 		}
672849277a5bSWaiman Long 
672949277a5bSWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
673049277a5bSWaiman Long 
673149277a5bSWaiman Long out_unlock:
673249277a5bSWaiman Long 		apply_wqattrs_unlock();
673349277a5bSWaiman Long 	}
673449277a5bSWaiman Long 
673549277a5bSWaiman Long 	return ret;
673649277a5bSWaiman Long }
673749277a5bSWaiman Long 
6738fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev,
6739fe28f631SWaiman Long 		struct device_attribute *attr, char *buf, cpumask_var_t mask)
6740b05a7928SFrederic Weisbecker {
6741b05a7928SFrederic Weisbecker 	int written;
6742b05a7928SFrederic Weisbecker 
6743042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6744fe28f631SWaiman Long 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
6745042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6746b05a7928SFrederic Weisbecker 
6747b05a7928SFrederic Weisbecker 	return written;
6748b05a7928SFrederic Weisbecker }
6749b05a7928SFrederic Weisbecker 
6750fe28f631SWaiman Long static ssize_t wq_unbound_cpumask_show(struct device *dev,
6751fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
6752fe28f631SWaiman Long {
6753fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask);
6754fe28f631SWaiman Long }
6755fe28f631SWaiman Long 
6756fe28f631SWaiman Long static ssize_t wq_requested_cpumask_show(struct device *dev,
6757fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
6758fe28f631SWaiman Long {
6759fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask);
6760fe28f631SWaiman Long }
6761fe28f631SWaiman Long 
6762fe28f631SWaiman Long static ssize_t wq_isolated_cpumask_show(struct device *dev,
6763fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
6764fe28f631SWaiman Long {
6765fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask);
6766fe28f631SWaiman Long }
6767fe28f631SWaiman Long 
6768042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
6769042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
6770042f7df1SLai Jiangshan {
6771042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
6772042f7df1SLai Jiangshan 	int ret;
6773042f7df1SLai Jiangshan 
6774042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6775042f7df1SLai Jiangshan 		return -ENOMEM;
6776042f7df1SLai Jiangshan 
6777042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
6778042f7df1SLai Jiangshan 	if (!ret)
6779042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
6780042f7df1SLai Jiangshan 
6781042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
6782042f7df1SLai Jiangshan 	return ret ? ret : count;
6783042f7df1SLai Jiangshan }
6784042f7df1SLai Jiangshan 
6785fe28f631SWaiman Long static struct device_attribute wq_sysfs_cpumask_attrs[] = {
6786042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
6787fe28f631SWaiman Long 	       wq_unbound_cpumask_store),
6788fe28f631SWaiman Long 	__ATTR(cpumask_requested, 0444, wq_requested_cpumask_show, NULL),
6789fe28f631SWaiman Long 	__ATTR(cpumask_isolated, 0444, wq_isolated_cpumask_show, NULL),
6790fe28f631SWaiman Long 	__ATTR_NULL,
6791fe28f631SWaiman Long };
6792b05a7928SFrederic Weisbecker 
67936ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
67946ba94429SFrederic Weisbecker {
6795686f6697SGreg Kroah-Hartman 	struct device *dev_root;
6796b05a7928SFrederic Weisbecker 	int err;
6797b05a7928SFrederic Weisbecker 
6798b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
6799b05a7928SFrederic Weisbecker 	if (err)
6800b05a7928SFrederic Weisbecker 		return err;
6801b05a7928SFrederic Weisbecker 
6802686f6697SGreg Kroah-Hartman 	dev_root = bus_get_dev_root(&wq_subsys);
6803686f6697SGreg Kroah-Hartman 	if (dev_root) {
6804fe28f631SWaiman Long 		struct device_attribute *attr;
6805fe28f631SWaiman Long 
6806fe28f631SWaiman Long 		for (attr = wq_sysfs_cpumask_attrs; attr->attr.name; attr++) {
6807fe28f631SWaiman Long 			err = device_create_file(dev_root, attr);
6808fe28f631SWaiman Long 			if (err)
6809fe28f631SWaiman Long 				break;
6810fe28f631SWaiman Long 		}
6811686f6697SGreg Kroah-Hartman 		put_device(dev_root);
6812686f6697SGreg Kroah-Hartman 	}
6813686f6697SGreg Kroah-Hartman 	return err;
68146ba94429SFrederic Weisbecker }
68156ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
68166ba94429SFrederic Weisbecker 
68176ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
68186ba94429SFrederic Weisbecker {
68196ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
68206ba94429SFrederic Weisbecker 
68216ba94429SFrederic Weisbecker 	kfree(wq_dev);
68226ba94429SFrederic Weisbecker }
68236ba94429SFrederic Weisbecker 
68246ba94429SFrederic Weisbecker /**
68256ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
68266ba94429SFrederic Weisbecker  * @wq: the workqueue to register
68276ba94429SFrederic Weisbecker  *
68286ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
68296ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
68306ba94429SFrederic Weisbecker  * which is the preferred method.
68316ba94429SFrederic Weisbecker  *
68326ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
68336ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
68346ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
68356ba94429SFrederic Weisbecker  * attributes.
68366ba94429SFrederic Weisbecker  *
68376ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
68386ba94429SFrederic Weisbecker  */
68396ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
68406ba94429SFrederic Weisbecker {
68416ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
68426ba94429SFrederic Weisbecker 	int ret;
68436ba94429SFrederic Weisbecker 
68446ba94429SFrederic Weisbecker 	/*
6845402dd89dSShailendra Verma 	 * Adjusting max_active or creating new pwqs by applying
68466ba94429SFrederic Weisbecker 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
68476ba94429SFrederic Weisbecker 	 * workqueues.
68486ba94429SFrederic Weisbecker 	 */
68490a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
68506ba94429SFrederic Weisbecker 		return -EINVAL;
68516ba94429SFrederic Weisbecker 
68526ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
68536ba94429SFrederic Weisbecker 	if (!wq_dev)
68546ba94429SFrederic Weisbecker 		return -ENOMEM;
68556ba94429SFrederic Weisbecker 
68566ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
68576ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
68586ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
685923217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
68606ba94429SFrederic Weisbecker 
68616ba94429SFrederic Weisbecker 	/*
68626ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
68636ba94429SFrederic Weisbecker 	 * everything is ready.
68646ba94429SFrederic Weisbecker 	 */
68656ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
68666ba94429SFrederic Weisbecker 
68676ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
68686ba94429SFrederic Weisbecker 	if (ret) {
6869537f4146SArvind Yadav 		put_device(&wq_dev->dev);
68706ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
68716ba94429SFrederic Weisbecker 		return ret;
68726ba94429SFrederic Weisbecker 	}
68736ba94429SFrederic Weisbecker 
68746ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
68756ba94429SFrederic Weisbecker 		struct device_attribute *attr;
68766ba94429SFrederic Weisbecker 
68776ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
68786ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
68796ba94429SFrederic Weisbecker 			if (ret) {
68806ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
68816ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
68826ba94429SFrederic Weisbecker 				return ret;
68836ba94429SFrederic Weisbecker 			}
68846ba94429SFrederic Weisbecker 		}
68856ba94429SFrederic Weisbecker 	}
68866ba94429SFrederic Weisbecker 
68876ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
68886ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
68896ba94429SFrederic Weisbecker 	return 0;
68906ba94429SFrederic Weisbecker }
68916ba94429SFrederic Weisbecker 
68926ba94429SFrederic Weisbecker /**
68936ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
68946ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
68956ba94429SFrederic Weisbecker  *
68966ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
68976ba94429SFrederic Weisbecker  */
68986ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
68996ba94429SFrederic Weisbecker {
69006ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
69016ba94429SFrederic Weisbecker 
69026ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
69036ba94429SFrederic Weisbecker 		return;
69046ba94429SFrederic Weisbecker 
69056ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
69066ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
69076ba94429SFrederic Weisbecker }
69086ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
69096ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
69106ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
69116ba94429SFrederic Weisbecker 
691282607adcSTejun Heo /*
691382607adcSTejun Heo  * Workqueue watchdog.
691482607adcSTejun Heo  *
691582607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
691682607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
691782607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
691882607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
691982607adcSTejun Heo  * largely opaque.
692082607adcSTejun Heo  *
692182607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
692282607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
692382607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
692482607adcSTejun Heo  *
692582607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
692682607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
692782607adcSTejun Heo  * corresponding sysfs parameter file.
692882607adcSTejun Heo  */
692982607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
693082607adcSTejun Heo 
693182607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
69325cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
693382607adcSTejun Heo 
693482607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
693582607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
693682607adcSTejun Heo 
6937cd2440d6SPetr Mladek /*
6938cd2440d6SPetr Mladek  * Show workers that might prevent the processing of pending work items.
6939cd2440d6SPetr Mladek  * The only candidates are CPU-bound workers in the running state.
6940cd2440d6SPetr Mladek  * Pending work items should be handled by another idle worker
6941cd2440d6SPetr Mladek  * in all other situations.
6942cd2440d6SPetr Mladek  */
6943cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool)
6944cd2440d6SPetr Mladek {
6945cd2440d6SPetr Mladek 	struct worker *worker;
6946cd2440d6SPetr Mladek 	unsigned long flags;
6947cd2440d6SPetr Mladek 	int bkt;
6948cd2440d6SPetr Mladek 
6949cd2440d6SPetr Mladek 	raw_spin_lock_irqsave(&pool->lock, flags);
6950cd2440d6SPetr Mladek 
6951cd2440d6SPetr Mladek 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
6952cd2440d6SPetr Mladek 		if (task_is_running(worker->task)) {
6953cd2440d6SPetr Mladek 			/*
6954cd2440d6SPetr Mladek 			 * Defer printing to avoid deadlocks in console
6955cd2440d6SPetr Mladek 			 * drivers that queue work while holding locks
6956cd2440d6SPetr Mladek 			 * also taken in their write paths.
6957cd2440d6SPetr Mladek 			 */
6958cd2440d6SPetr Mladek 			printk_deferred_enter();
6959cd2440d6SPetr Mladek 
6960cd2440d6SPetr Mladek 			pr_info("pool %d:\n", pool->id);
6961cd2440d6SPetr Mladek 			sched_show_task(worker->task);
6962cd2440d6SPetr Mladek 
6963cd2440d6SPetr Mladek 			printk_deferred_exit();
6964cd2440d6SPetr Mladek 		}
6965cd2440d6SPetr Mladek 	}
6966cd2440d6SPetr Mladek 
6967cd2440d6SPetr Mladek 	raw_spin_unlock_irqrestore(&pool->lock, flags);
6968cd2440d6SPetr Mladek }
6969cd2440d6SPetr Mladek 
6970cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void)
6971cd2440d6SPetr Mladek {
6972cd2440d6SPetr Mladek 	struct worker_pool *pool;
6973cd2440d6SPetr Mladek 	int pi;
6974cd2440d6SPetr Mladek 
6975cd2440d6SPetr Mladek 	pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n");
6976cd2440d6SPetr Mladek 
6977cd2440d6SPetr Mladek 	rcu_read_lock();
6978cd2440d6SPetr Mladek 
6979cd2440d6SPetr Mladek 	for_each_pool(pool, pi) {
6980cd2440d6SPetr Mladek 		if (pool->cpu_stall)
6981cd2440d6SPetr Mladek 			show_cpu_pool_hog(pool);
6982cd2440d6SPetr Mladek 
6983cd2440d6SPetr Mladek 	}
6984cd2440d6SPetr Mladek 
6985cd2440d6SPetr Mladek 	rcu_read_unlock();
6986cd2440d6SPetr Mladek }
6987cd2440d6SPetr Mladek 
698882607adcSTejun Heo static void wq_watchdog_reset_touched(void)
698982607adcSTejun Heo {
699082607adcSTejun Heo 	int cpu;
699182607adcSTejun Heo 
699282607adcSTejun Heo 	wq_watchdog_touched = jiffies;
699382607adcSTejun Heo 	for_each_possible_cpu(cpu)
699482607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
699582607adcSTejun Heo }
699682607adcSTejun Heo 
69975cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
699882607adcSTejun Heo {
699982607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
700082607adcSTejun Heo 	bool lockup_detected = false;
7001cd2440d6SPetr Mladek 	bool cpu_pool_stall = false;
7002940d71c6SSergey Senozhatsky 	unsigned long now = jiffies;
700382607adcSTejun Heo 	struct worker_pool *pool;
700482607adcSTejun Heo 	int pi;
700582607adcSTejun Heo 
700682607adcSTejun Heo 	if (!thresh)
700782607adcSTejun Heo 		return;
700882607adcSTejun Heo 
700982607adcSTejun Heo 	rcu_read_lock();
701082607adcSTejun Heo 
701182607adcSTejun Heo 	for_each_pool(pool, pi) {
701282607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
701382607adcSTejun Heo 
7014cd2440d6SPetr Mladek 		pool->cpu_stall = false;
701582607adcSTejun Heo 		if (list_empty(&pool->worklist))
701682607adcSTejun Heo 			continue;
701782607adcSTejun Heo 
7018940d71c6SSergey Senozhatsky 		/*
7019940d71c6SSergey Senozhatsky 		 * If a virtual machine is stopped by the host it can look to
7020940d71c6SSergey Senozhatsky 		 * the watchdog like a stall.
7021940d71c6SSergey Senozhatsky 		 */
7022940d71c6SSergey Senozhatsky 		kvm_check_and_clear_guest_paused();
7023940d71c6SSergey Senozhatsky 
702482607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
702589e28ce6SWang Qing 		if (pool->cpu >= 0)
702689e28ce6SWang Qing 			touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
702789e28ce6SWang Qing 		else
702882607adcSTejun Heo 			touched = READ_ONCE(wq_watchdog_touched);
702989e28ce6SWang Qing 		pool_ts = READ_ONCE(pool->watchdog_ts);
703082607adcSTejun Heo 
703182607adcSTejun Heo 		if (time_after(pool_ts, touched))
703282607adcSTejun Heo 			ts = pool_ts;
703382607adcSTejun Heo 		else
703482607adcSTejun Heo 			ts = touched;
703582607adcSTejun Heo 
703682607adcSTejun Heo 		/* did we stall? */
7037940d71c6SSergey Senozhatsky 		if (time_after(now, ts + thresh)) {
703882607adcSTejun Heo 			lockup_detected = true;
7039cd2440d6SPetr Mladek 			if (pool->cpu >= 0) {
7040cd2440d6SPetr Mladek 				pool->cpu_stall = true;
7041cd2440d6SPetr Mladek 				cpu_pool_stall = true;
7042cd2440d6SPetr Mladek 			}
704382607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
704482607adcSTejun Heo 			pr_cont_pool_info(pool);
704582607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
7046940d71c6SSergey Senozhatsky 				jiffies_to_msecs(now - pool_ts) / 1000);
704782607adcSTejun Heo 		}
7048cd2440d6SPetr Mladek 
7049cd2440d6SPetr Mladek 
705082607adcSTejun Heo 	}
705182607adcSTejun Heo 
705282607adcSTejun Heo 	rcu_read_unlock();
705382607adcSTejun Heo 
705482607adcSTejun Heo 	if (lockup_detected)
705555df0933SImran Khan 		show_all_workqueues();
705682607adcSTejun Heo 
7057cd2440d6SPetr Mladek 	if (cpu_pool_stall)
7058cd2440d6SPetr Mladek 		show_cpu_pools_hogs();
7059cd2440d6SPetr Mladek 
706082607adcSTejun Heo 	wq_watchdog_reset_touched();
706182607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
706282607adcSTejun Heo }
706382607adcSTejun Heo 
7064cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
706582607adcSTejun Heo {
706682607adcSTejun Heo 	if (cpu >= 0)
706782607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
706889e28ce6SWang Qing 
706982607adcSTejun Heo 	wq_watchdog_touched = jiffies;
707082607adcSTejun Heo }
707182607adcSTejun Heo 
707282607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
707382607adcSTejun Heo {
707482607adcSTejun Heo 	wq_watchdog_thresh = 0;
707582607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
707682607adcSTejun Heo 
707782607adcSTejun Heo 	if (thresh) {
707882607adcSTejun Heo 		wq_watchdog_thresh = thresh;
707982607adcSTejun Heo 		wq_watchdog_reset_touched();
708082607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
708182607adcSTejun Heo 	}
708282607adcSTejun Heo }
708382607adcSTejun Heo 
708482607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
708582607adcSTejun Heo 					const struct kernel_param *kp)
708682607adcSTejun Heo {
708782607adcSTejun Heo 	unsigned long thresh;
708882607adcSTejun Heo 	int ret;
708982607adcSTejun Heo 
709082607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
709182607adcSTejun Heo 	if (ret)
709282607adcSTejun Heo 		return ret;
709382607adcSTejun Heo 
709482607adcSTejun Heo 	if (system_wq)
709582607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
709682607adcSTejun Heo 	else
709782607adcSTejun Heo 		wq_watchdog_thresh = thresh;
709882607adcSTejun Heo 
709982607adcSTejun Heo 	return 0;
710082607adcSTejun Heo }
710182607adcSTejun Heo 
710282607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
710382607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
710482607adcSTejun Heo 	.get	= param_get_ulong,
710582607adcSTejun Heo };
710682607adcSTejun Heo 
710782607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
710882607adcSTejun Heo 		0644);
710982607adcSTejun Heo 
711082607adcSTejun Heo static void wq_watchdog_init(void)
711182607adcSTejun Heo {
71125cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
711382607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
711482607adcSTejun Heo }
711582607adcSTejun Heo 
711682607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
711782607adcSTejun Heo 
711882607adcSTejun Heo static inline void wq_watchdog_init(void) { }
711982607adcSTejun Heo 
712082607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
712182607adcSTejun Heo 
71224a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask)
71234a6c5607STejun Heo {
71244a6c5607STejun Heo 	if (!cpumask_intersects(wq_unbound_cpumask, mask)) {
71254a6c5607STejun Heo 		pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n",
71264a6c5607STejun Heo 			cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask));
71274a6c5607STejun Heo 		return;
71284a6c5607STejun Heo 	}
71294a6c5607STejun Heo 
71304a6c5607STejun Heo 	cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask);
71314a6c5607STejun Heo }
71324a6c5607STejun Heo 
71333347fa09STejun Heo /**
71343347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
71353347fa09STejun Heo  *
71362930155bSTejun Heo  * This is the first step of three-staged workqueue subsystem initialization and
71372930155bSTejun Heo  * invoked as soon as the bare basics - memory allocation, cpumasks and idr are
71382930155bSTejun Heo  * up. It sets up all the data structures and system workqueues and allows early
71392930155bSTejun Heo  * boot code to create workqueues and queue/cancel work items. Actual work item
71402930155bSTejun Heo  * execution starts only after kthreads can be created and scheduled right
71412930155bSTejun Heo  * before early initcalls.
71423347fa09STejun Heo  */
71432333e829SYu Chen void __init workqueue_init_early(void)
71441da177e4SLinus Torvalds {
714584193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM];
71467a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
71477a4e344cSTejun Heo 	int i, cpu;
7148c34056a3STejun Heo 
714910cdb157SLai Jiangshan 	BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
7150e904e6c2STejun Heo 
7151b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
7152fe28f631SWaiman Long 	BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL));
7153fe28f631SWaiman Long 	BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL));
7154b05a7928SFrederic Weisbecker 
71554a6c5607STejun Heo 	cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
71564a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ));
71574a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN));
7158ace3c549Stiozhang 	if (!cpumask_empty(&wq_cmdline_cpumask))
71594a6c5607STejun Heo 		restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask);
7160ace3c549Stiozhang 
7161fe28f631SWaiman Long 	cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask);
71628b03ae3cSTejun Heo 
71638b03ae3cSTejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
7164e22bee78STejun Heo 
71652930155bSTejun Heo 	wq_update_pod_attrs_buf = alloc_workqueue_attrs();
71662930155bSTejun Heo 	BUG_ON(!wq_update_pod_attrs_buf);
71672930155bSTejun Heo 
71687bd20b6bSMarcelo Tosatti 	/*
71697bd20b6bSMarcelo Tosatti 	 * If nohz_full is enabled, set power efficient workqueue as unbound.
71707bd20b6bSMarcelo Tosatti 	 * This allows workqueue items to be moved to HK CPUs.
71717bd20b6bSMarcelo Tosatti 	 */
71727bd20b6bSMarcelo Tosatti 	if (housekeeping_enabled(HK_TYPE_TICK))
71737bd20b6bSMarcelo Tosatti 		wq_power_efficient = true;
71747bd20b6bSMarcelo Tosatti 
717584193c07STejun Heo 	/* initialize WQ_AFFN_SYSTEM pods */
717684193c07STejun Heo 	pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
717784193c07STejun Heo 	pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL);
717884193c07STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
717984193c07STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod);
718084193c07STejun Heo 
718184193c07STejun Heo 	BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE));
718284193c07STejun Heo 
718384193c07STejun Heo 	pt->nr_pods = 1;
718484193c07STejun Heo 	cpumask_copy(pt->pod_cpus[0], cpu_possible_mask);
718584193c07STejun Heo 	pt->pod_node[0] = NUMA_NO_NODE;
718684193c07STejun Heo 	pt->cpu_pod[0] = 0;
718784193c07STejun Heo 
7188f02ae73aSTejun Heo 	/* initialize CPU pools */
718924647570STejun Heo 	for_each_possible_cpu(cpu) {
7190ebf44d16STejun Heo 		struct worker_pool *pool;
7191e22bee78STejun Heo 
71924ce62e9eSTejun Heo 		i = 0;
7193e22bee78STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
719429c91e99STejun Heo 			BUG_ON(init_worker_pool(pool));
719529c91e99STejun Heo 			pool->cpu = cpu;
719629c91e99STejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
71979546b29eSTejun Heo 			cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu));
71981da177e4SLinus Torvalds 			pool->attrs->nice = std_nice[i++];
71998639ecebSTejun Heo 			pool->attrs->affn_strict = true;
72001da177e4SLinus Torvalds 			pool->node = cpu_to_node(cpu);
72011da177e4SLinus Torvalds 
72021da177e4SLinus Torvalds 			/* alloc pool ID */
72031da177e4SLinus Torvalds 			mutex_lock(&wq_pool_mutex);
72041da177e4SLinus Torvalds 			BUG_ON(worker_pool_assign_id(pool));
72051da177e4SLinus Torvalds 			mutex_unlock(&wq_pool_mutex);
720629c91e99STejun Heo 		}
720729c91e99STejun Heo 	}
720829c91e99STejun Heo 
72098a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
721029c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
721129c91e99STejun Heo 		struct workqueue_attrs *attrs;
721229c91e99STejun Heo 
7213be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
721429c91e99STejun Heo 		attrs->nice = std_nice[i];
721529c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
72168a2b7538STejun Heo 
72178a2b7538STejun Heo 		/*
72188a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
72198a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
72208a2b7538STejun Heo 		 */
7221be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
72228a2b7538STejun Heo 		attrs->nice = std_nice[i];
7223af73f5c9STejun Heo 		attrs->ordered = true;
72248a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
722529c91e99STejun Heo 	}
722629c91e99STejun Heo 
72271da177e4SLinus Torvalds 	system_wq = alloc_workqueue("events", 0, 0);
72281aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
72291da177e4SLinus Torvalds 	system_long_wq = alloc_workqueue("events_long", 0, 0);
72301da177e4SLinus Torvalds 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
7231636b927eSTejun Heo 					    WQ_MAX_ACTIVE);
72321da177e4SLinus Torvalds 	system_freezable_wq = alloc_workqueue("events_freezable",
72331da177e4SLinus Torvalds 					      WQ_FREEZABLE, 0);
72340668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
72350668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
72368318d6a6SAudra Mitchell 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient",
72370668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
72380668106cSViresh Kumar 					      0);
72391aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
72400668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
72410668106cSViresh Kumar 	       !system_power_efficient_wq ||
72420668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
72433347fa09STejun Heo }
72443347fa09STejun Heo 
7245aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void)
7246aa6fde93STejun Heo {
7247aa6fde93STejun Heo 	unsigned long thresh;
7248aa6fde93STejun Heo 	unsigned long bogo;
7249aa6fde93STejun Heo 
7250dd64c873SZqiang 	pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release");
7251dd64c873SZqiang 	BUG_ON(IS_ERR(pwq_release_worker));
7252dd64c873SZqiang 
7253aa6fde93STejun Heo 	/* if the user set it to a specific value, keep it */
7254aa6fde93STejun Heo 	if (wq_cpu_intensive_thresh_us != ULONG_MAX)
7255aa6fde93STejun Heo 		return;
7256aa6fde93STejun Heo 
7257aa6fde93STejun Heo 	/*
7258aa6fde93STejun Heo 	 * The default of 10ms is derived from the fact that most modern (as of
7259aa6fde93STejun Heo 	 * 2023) processors can do a lot in 10ms and that it's just below what
7260aa6fde93STejun Heo 	 * most consider human-perceivable. However, the kernel also runs on a
7261aa6fde93STejun Heo 	 * lot slower CPUs including microcontrollers where the threshold is way
7262aa6fde93STejun Heo 	 * too low.
7263aa6fde93STejun Heo 	 *
7264aa6fde93STejun Heo 	 * Let's scale up the threshold upto 1 second if BogoMips is below 4000.
7265aa6fde93STejun Heo 	 * This is by no means accurate but it doesn't have to be. The mechanism
7266aa6fde93STejun Heo 	 * is still useful even when the threshold is fully scaled up. Also, as
7267aa6fde93STejun Heo 	 * the reports would usually be applicable to everyone, some machines
7268aa6fde93STejun Heo 	 * operating on longer thresholds won't significantly diminish their
7269aa6fde93STejun Heo 	 * usefulness.
7270aa6fde93STejun Heo 	 */
7271aa6fde93STejun Heo 	thresh = 10 * USEC_PER_MSEC;
7272aa6fde93STejun Heo 
7273aa6fde93STejun Heo 	/* see init/calibrate.c for lpj -> BogoMIPS calculation */
7274aa6fde93STejun Heo 	bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1);
7275aa6fde93STejun Heo 	if (bogo < 4000)
7276aa6fde93STejun Heo 		thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC);
7277aa6fde93STejun Heo 
7278aa6fde93STejun Heo 	pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n",
7279aa6fde93STejun Heo 		 loops_per_jiffy, bogo, thresh);
7280aa6fde93STejun Heo 
7281aa6fde93STejun Heo 	wq_cpu_intensive_thresh_us = thresh;
7282aa6fde93STejun Heo }
7283aa6fde93STejun Heo 
72843347fa09STejun Heo /**
72853347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
72863347fa09STejun Heo  *
72872930155bSTejun Heo  * This is the second step of three-staged workqueue subsystem initialization
72882930155bSTejun Heo  * and invoked as soon as kthreads can be created and scheduled. Workqueues have
72892930155bSTejun Heo  * been created and work items queued on them, but there are no kworkers
72902930155bSTejun Heo  * executing the work items yet. Populate the worker pools with the initial
72912930155bSTejun Heo  * workers and enable future kworker creations.
72923347fa09STejun Heo  */
72932333e829SYu Chen void __init workqueue_init(void)
72943347fa09STejun Heo {
72952186d9f9STejun Heo 	struct workqueue_struct *wq;
72963347fa09STejun Heo 	struct worker_pool *pool;
72973347fa09STejun Heo 	int cpu, bkt;
72983347fa09STejun Heo 
7299aa6fde93STejun Heo 	wq_cpu_intensive_thresh_init();
7300aa6fde93STejun Heo 
73012186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
73022186d9f9STejun Heo 
73032930155bSTejun Heo 	/*
73042930155bSTejun Heo 	 * Per-cpu pools created earlier could be missing node hint. Fix them
73052930155bSTejun Heo 	 * up. Also, create a rescuer for workqueues that requested it.
73062930155bSTejun Heo 	 */
73072186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
73082186d9f9STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
73092186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
73102186d9f9STejun Heo 		}
73112186d9f9STejun Heo 	}
73122186d9f9STejun Heo 
731340c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
731440c17f75STejun Heo 		WARN(init_rescuer(wq),
731540c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
731640c17f75STejun Heo 		     wq->name);
731740c17f75STejun Heo 	}
73182186d9f9STejun Heo 
73192186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
73202186d9f9STejun Heo 
73213347fa09STejun Heo 	/* create the initial workers */
73223347fa09STejun Heo 	for_each_online_cpu(cpu) {
73233347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
73243347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
73253347fa09STejun Heo 			BUG_ON(!create_worker(pool));
73263347fa09STejun Heo 		}
73273347fa09STejun Heo 	}
73283347fa09STejun Heo 
73293347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
73303347fa09STejun Heo 		BUG_ON(!create_worker(pool));
73313347fa09STejun Heo 
73323347fa09STejun Heo 	wq_online = true;
733382607adcSTejun Heo 	wq_watchdog_init();
73341da177e4SLinus Torvalds }
7335c4f135d6STetsuo Handa 
7336025e1684STejun Heo /*
7337025e1684STejun Heo  * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to
7338025e1684STejun Heo  * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique
7339025e1684STejun Heo  * and consecutive pod ID. The rest of @pt is initialized accordingly.
7340025e1684STejun Heo  */
7341025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt,
7342025e1684STejun Heo 				 bool (*cpus_share_pod)(int, int))
7343025e1684STejun Heo {
7344025e1684STejun Heo 	int cur, pre, cpu, pod;
7345025e1684STejun Heo 
7346025e1684STejun Heo 	pt->nr_pods = 0;
7347025e1684STejun Heo 
7348025e1684STejun Heo 	/* init @pt->cpu_pod[] according to @cpus_share_pod() */
7349025e1684STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
7350025e1684STejun Heo 	BUG_ON(!pt->cpu_pod);
7351025e1684STejun Heo 
7352025e1684STejun Heo 	for_each_possible_cpu(cur) {
7353025e1684STejun Heo 		for_each_possible_cpu(pre) {
7354025e1684STejun Heo 			if (pre >= cur) {
7355025e1684STejun Heo 				pt->cpu_pod[cur] = pt->nr_pods++;
7356025e1684STejun Heo 				break;
7357025e1684STejun Heo 			}
7358025e1684STejun Heo 			if (cpus_share_pod(cur, pre)) {
7359025e1684STejun Heo 				pt->cpu_pod[cur] = pt->cpu_pod[pre];
7360025e1684STejun Heo 				break;
7361025e1684STejun Heo 			}
7362025e1684STejun Heo 		}
7363025e1684STejun Heo 	}
7364025e1684STejun Heo 
7365025e1684STejun Heo 	/* init the rest to match @pt->cpu_pod[] */
7366025e1684STejun Heo 	pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
7367025e1684STejun Heo 	pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL);
7368025e1684STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node);
7369025e1684STejun Heo 
7370025e1684STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++)
7371025e1684STejun Heo 		BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL));
7372025e1684STejun Heo 
7373025e1684STejun Heo 	for_each_possible_cpu(cpu) {
7374025e1684STejun Heo 		cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]);
7375025e1684STejun Heo 		pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu);
7376025e1684STejun Heo 	}
7377025e1684STejun Heo }
7378025e1684STejun Heo 
737963c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1)
738063c5484eSTejun Heo {
738163c5484eSTejun Heo 	return false;
738263c5484eSTejun Heo }
738363c5484eSTejun Heo 
738463c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1)
738563c5484eSTejun Heo {
738663c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT
738763c5484eSTejun Heo 	return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1));
738863c5484eSTejun Heo #else
738963c5484eSTejun Heo 	return false;
739063c5484eSTejun Heo #endif
739163c5484eSTejun Heo }
739263c5484eSTejun Heo 
7393025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1)
7394025e1684STejun Heo {
7395025e1684STejun Heo 	return cpu_to_node(cpu0) == cpu_to_node(cpu1);
7396025e1684STejun Heo }
7397025e1684STejun Heo 
73982930155bSTejun Heo /**
73992930155bSTejun Heo  * workqueue_init_topology - initialize CPU pods for unbound workqueues
74002930155bSTejun Heo  *
74012930155bSTejun Heo  * This is the third step of there-staged workqueue subsystem initialization and
74022930155bSTejun Heo  * invoked after SMP and topology information are fully initialized. It
74032930155bSTejun Heo  * initializes the unbound CPU pods accordingly.
74042930155bSTejun Heo  */
74052930155bSTejun Heo void __init workqueue_init_topology(void)
7406a86feae6STejun Heo {
74072930155bSTejun Heo 	struct workqueue_struct *wq;
7408025e1684STejun Heo 	int cpu;
7409a86feae6STejun Heo 
741063c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share);
741163c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt);
741263c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache);
7413025e1684STejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa);
7414a86feae6STejun Heo 
7415c5f8cd6cSTejun Heo 	wq_topo_initialized = true;
7416c5f8cd6cSTejun Heo 
74172930155bSTejun Heo 	mutex_lock(&wq_pool_mutex);
7418a86feae6STejun Heo 
7419a86feae6STejun Heo 	/*
74202930155bSTejun Heo 	 * Workqueues allocated earlier would have all CPUs sharing the default
74212930155bSTejun Heo 	 * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU
74222930155bSTejun Heo 	 * combinations to apply per-pod sharing.
74232930155bSTejun Heo 	 */
74242930155bSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
74255797b1c1STejun Heo 		for_each_online_cpu(cpu)
74262930155bSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
74275797b1c1STejun Heo 		if (wq->flags & WQ_UNBOUND) {
74285797b1c1STejun Heo 			mutex_lock(&wq->mutex);
74295797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
74305797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
74312930155bSTejun Heo 		}
74322930155bSTejun Heo 	}
74332930155bSTejun Heo 
74342930155bSTejun Heo 	mutex_unlock(&wq_pool_mutex);
7435a86feae6STejun Heo }
7436a86feae6STejun Heo 
743720bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void)
743820bdedafSTetsuo Handa {
743920bdedafSTetsuo Handa 	pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n");
744020bdedafSTetsuo Handa 	dump_stack();
744120bdedafSTetsuo Handa }
7442c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq);
7443ace3c549Stiozhang 
7444ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str)
7445ace3c549Stiozhang {
7446ace3c549Stiozhang 	if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) {
7447ace3c549Stiozhang 		cpumask_clear(&wq_cmdline_cpumask);
7448ace3c549Stiozhang 		pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n");
7449ace3c549Stiozhang 	}
7450ace3c549Stiozhang 
7451ace3c549Stiozhang 	return 1;
7452ace3c549Stiozhang }
7453ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup);
7454