blob: b19d759e55a5d897e8d283f1b646c13d7e740466 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Tejun Heoc54fce62010-09-10 16:51:36 +02003 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Tejun Heoc54fce62010-09-10 16:51:36 +02005 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
Tejun Heoc54fce62010-09-10 16:51:36 +02007 * Derived from the taskqueue/keventd code by:
8 * David Woodhouse <dwmw2@infradead.org>
9 * Andrew Morton
10 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
11 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080012 *
Christoph Lametercde53532008-07-04 09:59:22 -070013 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020014 *
15 * Copyright (C) 2010 SUSE Linux Products GmbH
16 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
17 *
18 * This is the generic async execution mechanism. Work items as are
19 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080020 * automatically managed. There are two worker pools for each CPU (one for
21 * normal work items and the other for high priority ones) and some extra
22 * pools for workqueues which are not bound to any specific CPU - the
23 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020024 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070025 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 */
27
Paul Gortmaker9984de12011-05-23 14:51:41 -040028#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/kernel.h>
30#include <linux/sched.h>
31#include <linux/init.h>
32#include <linux/signal.h>
33#include <linux/completion.h>
34#include <linux/workqueue.h>
35#include <linux/slab.h>
36#include <linux/cpu.h>
37#include <linux/notifier.h>
38#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060039#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070040#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080041#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080042#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020051#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090052#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020053
Tejun Heoea138442013-01-18 14:05:55 -080054#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Tejun Heoc8e55f32010-06-29 10:07:12 +020056enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 /*
Tejun Heo24647572013-01-24 11:01:33 -080058 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 *
Tejun Heo24647572013-01-24 11:01:33 -080060 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070061 * While associated (!DISASSOCIATED), all workers are bound to the
62 * CPU and none has %WORKER_UNBOUND set and concurrency management
63 * is in effect.
64 *
65 * While DISASSOCIATED, the cpu may be offline and all workers have
66 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080067 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070068 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070069 * Note that DISASSOCIATED should be flipped only while holding
Tejun Heo1258fae2018-05-18 08:47:13 -070070 * wq_pool_attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080071 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070072 */
Tejun Heo692b4822017-10-09 08:04:13 -070073 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080074 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020075
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020077 WORKER_DIE = 1 << 1, /* die die die */
78 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020079 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020080 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020081 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070082 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020083
Tejun Heoa9ab7752013-03-19 13:45:21 -070084 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
85 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020086
Tejun Heoe34cdddb2013-01-24 11:01:33 -080087 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070088
Tejun Heo29c91e92013-03-12 11:30:03 -070089 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020090 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020091
Tejun Heoe22bee72010-06-29 10:07:14 +020092 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
93 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
94
Tejun Heo3233cdb2011-02-16 18:10:19 +010095 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
96 /* call for help after 10ms
97 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020098 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
99 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +0200100
101 /*
102 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800103 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200104 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800105 RESCUER_NICE_LEVEL = MIN_NICE,
106 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700107
108 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200109};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200112 * Structure fields follow one of the following exclusion rules.
113 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200114 * I: Modifiable by initialization/destruction paths and read-only for
115 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200116 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200117 * P: Preemption protected. Disabling preemption is enough and should
118 * only be modified and accessed from the local cpu.
119 *
Tejun Heod565ed62013-01-24 11:01:33 -0800120 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200121 *
Tejun Heod565ed62013-01-24 11:01:33 -0800122 * X: During normal operation, modification requires pool->lock and should
123 * be done only from local cpu. Either disabling preemption on local
124 * cpu or grabbing pool->lock is enough for read access. If
125 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200126 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700127 * A: wq_pool_attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700128 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700129 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700130 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100131 * PR: wq_pool_mutex protected for writes. RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700132 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800133 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
134 *
135 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100136 * RCU for reads.
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800137 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700138 * WQ: wq->mutex protected.
139 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100140 * WR: wq->mutex protected for writes. RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700141 *
142 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200143 */
144
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800145/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200146
Tejun Heobd7bdd42012-07-12 14:46:37 -0700147struct worker_pool {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200148 raw_spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700149 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700150 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800151 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700152 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700153
Tejun Heo82607adc2015-12-08 11:28:04 -0500154 unsigned long watchdog_ts; /* L: watchdog timestamp */
155
Tejun Heobd7bdd42012-07-12 14:46:37 -0700156 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700157
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800158 int nr_workers; /* L: total number of workers */
159 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700160
161 struct list_head idle_list; /* X: list of idle workers */
162 struct timer_list idle_timer; /* L: worker idle timeout */
163 struct timer_list mayday_timer; /* L: SOS timer for workers */
164
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700165 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800166 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
167 /* L: hash of busy workers */
168
Tejun Heo2607d7a2015-03-09 09:22:28 -0400169 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800170 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800171 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800172
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800173 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800174
Tejun Heo7a4e3442013-03-12 11:30:00 -0700175 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700176 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
177 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700178
Tejun Heoe19e3972013-01-24 11:39:44 -0800179 /*
180 * The current concurrency level. As it's likely to be accessed
181 * from other CPUs during try_to_wake_up(), put it in a separate
182 * cacheline.
183 */
184 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700185
186 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100187 * Destruction of pool is RCU protected to allow dereferences
Tejun Heo29c91e92013-03-12 11:30:03 -0700188 * from get_work_pool().
189 */
190 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200191} ____cacheline_aligned_in_smp;
192
193/*
Tejun Heo112202d2013-02-13 19:29:12 -0800194 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
195 * of work_struct->data are used for flags and the remaining high bits
196 * point to the pwq; thus, pwqs need to be aligned at two's power of the
197 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 */
Tejun Heo112202d2013-02-13 19:29:12 -0800199struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700200 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200201 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200202 int work_color; /* L: current color */
203 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700204 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200205 int nr_in_flight[WORK_NR_COLORS];
206 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200207 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200208 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200209 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700210 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700211 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700212
213 /*
214 * Release of unbound pwq is punted to system_wq. See put_pwq()
215 * and pwq_unbound_release_workfn() for details. pool_workqueue
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100216 * itself is also RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700217 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700218 */
219 struct work_struct unbound_release_work;
220 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700221} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200224 * Structure used to wait for workqueue flush.
225 */
226struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700227 struct list_head list; /* WQ: list of flushers */
228 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200229 struct completion done; /* flush completion */
230};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Tejun Heo226223a2013-03-12 11:30:05 -0700232struct wq_device;
233
Tejun Heo73f53c42010-06-29 10:07:11 +0200234/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700235 * The externally visible workqueue. It relays the issued work items to
236 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
238struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700239 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400240 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200241
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700242 struct mutex mutex; /* protects this wq */
243 int work_color; /* WQ: current work color */
244 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800245 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700246 struct wq_flusher *first_flusher; /* WQ: first flusher */
247 struct list_head flusher_queue; /* WQ: flush waiters */
248 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200249
Tejun Heo2e109a22013-03-13 19:47:40 -0700250 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heo30ae2fc2019-09-20 14:09:14 -0700251 struct worker *rescuer; /* MD: rescue worker */
Tejun Heoe22bee72010-06-29 10:07:14 +0200252
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700253 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700254 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700255
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800256 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
257 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700258
Tejun Heo226223a2013-03-12 11:30:05 -0700259#ifdef CONFIG_SYSFS
260 struct wq_device *wq_dev; /* I: for sysfs interface */
261#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700262#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800263 char *lock_name;
264 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200265 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700266#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700267 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700268
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400269 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100270 * Destruction of workqueue_struct is RCU protected to allow walking
271 * the workqueues list without grabbing wq_pool_mutex.
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400272 * This is used to dump all workqueues from sysrq.
273 */
274 struct rcu_head rcu;
275
Tejun Heo2728fd22013-04-01 11:23:35 -0700276 /* hot fields used during command issue, aligned to cacheline */
277 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
278 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800279 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280};
281
Tejun Heoe904e6c2013-03-12 11:29:57 -0700282static struct kmem_cache *pwq_cache;
283
Tejun Heobce90382013-04-01 11:23:32 -0700284static cpumask_var_t *wq_numa_possible_cpumask;
285 /* possible CPUs of each node */
286
Tejun Heod55262c2013-04-01 11:23:38 -0700287static bool wq_disable_numa;
288module_param_named(disable_numa, wq_disable_numa, bool, 0444);
289
Viresh Kumarcee22a12013-04-08 16:45:40 +0530290/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930291static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530292module_param_named(power_efficient, wq_power_efficient, bool, 0444);
293
Tejun Heo863b7102016-09-16 15:49:34 -0400294static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400295
Tejun Heobce90382013-04-01 11:23:32 -0700296static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
297
Tejun Heo4c16bd32013-04-01 11:23:36 -0700298/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
299static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
300
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700301static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700302static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200303static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +0200304/* wait for manager to go away */
305static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
Tejun Heo5bcab332013-03-13 19:47:40 -0700306
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400307static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700309
Mike Galbraithef5571802016-02-09 17:59:38 -0500310/* PL: allowable cpus for unbound wqs and work items */
311static cpumask_var_t wq_unbound_cpumask;
312
313/* CPU where unbound work was last round robin scheduled from this CPU */
314static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800315
Tejun Heof303fccb2016-02-09 17:59:38 -0500316/*
317 * Local execution of unbound work items is no longer guaranteed. The
318 * following always forces round-robin CPU selection on unbound work items
319 * to uncover usages which depend on it.
320 */
321#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
322static bool wq_debug_force_rr_cpu = true;
323#else
324static bool wq_debug_force_rr_cpu = false;
325#endif
326module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
327
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700328/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700329static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700330
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700331static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700332
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700333/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700334static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
335
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700336/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700337static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
338
Tejun Heo8a2b7532013-09-05 12:30:04 -0400339/* I: attributes used when instantiating ordered pools on demand */
340static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
341
Tejun Heod320c032010-06-29 10:07:14 +0200342struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400343EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900345EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300346struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200347EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300348struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200349EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300350struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100351EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530352struct workqueue_struct *system_power_efficient_wq __read_mostly;
353EXPORT_SYMBOL_GPL(system_power_efficient_wq);
354struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
355EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200356
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700357static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800358static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heoc29eb852019-09-23 11:08:58 -0700359static void show_pwq(struct pool_workqueue *pwq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700360
Tejun Heo97bd2342010-10-05 10:41:14 +0200361#define CREATE_TRACE_POINTS
362#include <trace/events/workqueue.h>
363
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700364#define assert_rcu_or_pool_mutex() \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100365 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700366 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100367 "RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700368
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800369#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100370 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700371 !lockdep_is_held(&wq->mutex) && \
372 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100373 "RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800374
Tejun Heof02ae732013-03-12 11:30:03 -0700375#define for_each_cpu_worker_pool(pool, cpu) \
376 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
377 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700378 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700379
Tejun Heo49e3cf42013-03-12 11:29:58 -0700380/**
Tejun Heo17116962013-03-12 11:29:58 -0700381 * for_each_pool - iterate through all worker_pools in the system
382 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700383 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700384 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100385 * This must be called either with wq_pool_mutex held or RCU read
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700386 * locked. If the pool needs to be used beyond the locking in effect, the
387 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700388 *
389 * The if/else clause exists only for the lockdep assertion and can be
390 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700391 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700392#define for_each_pool(pool, pi) \
393 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700394 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700395 else
Tejun Heo17116962013-03-12 11:29:58 -0700396
397/**
Tejun Heo822d8402013-03-19 13:45:21 -0700398 * for_each_pool_worker - iterate through all workers of a worker_pool
399 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700400 * @pool: worker_pool to iterate workers of
401 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700402 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700403 *
404 * The if/else clause exists only for the lockdep assertion and can be
405 * ignored.
406 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800407#define for_each_pool_worker(worker, pool) \
408 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700409 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700410 else
411
412/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700413 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
414 * @pwq: iteration cursor
415 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700416 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100417 * This must be called either with wq->mutex held or RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700418 * If the pwq needs to be used beyond the locking in effect, the caller is
419 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700420 *
421 * The if/else clause exists only for the lockdep assertion and can be
422 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700423 */
424#define for_each_pwq(pwq, wq) \
Sebastian Andrzej Siewior49e9d1a2019-11-15 19:01:25 +0100425 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
Joel Fernandes (Google)5a644662019-08-15 10:18:42 -0400426 lockdep_is_held(&(wq->mutex)))
Tejun Heof3421792010-07-02 10:03:51 +0200427
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900428#ifdef CONFIG_DEBUG_OBJECTS_WORK
429
Stephen Boydf9e62f32020-08-14 17:40:27 -0700430static const struct debug_obj_descr work_debug_descr;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900431
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100432static void *work_debug_hint(void *addr)
433{
434 return ((struct work_struct *) addr)->func;
435}
436
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700437static bool work_is_static_object(void *addr)
438{
439 struct work_struct *work = addr;
440
441 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
442}
443
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900444/*
445 * fixup_init is called when:
446 * - an active object is initialized
447 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700448static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900449{
450 struct work_struct *work = addr;
451
452 switch (state) {
453 case ODEBUG_STATE_ACTIVE:
454 cancel_work_sync(work);
455 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700456 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900457 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700458 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900459 }
460}
461
462/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900463 * fixup_free is called when:
464 * - an active object is freed
465 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700466static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900467{
468 struct work_struct *work = addr;
469
470 switch (state) {
471 case ODEBUG_STATE_ACTIVE:
472 cancel_work_sync(work);
473 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700474 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900475 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700476 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900477 }
478}
479
Stephen Boydf9e62f32020-08-14 17:40:27 -0700480static const struct debug_obj_descr work_debug_descr = {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900481 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100482 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700483 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900484 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900485 .fixup_free = work_fixup_free,
486};
487
488static inline void debug_work_activate(struct work_struct *work)
489{
490 debug_object_activate(work, &work_debug_descr);
491}
492
493static inline void debug_work_deactivate(struct work_struct *work)
494{
495 debug_object_deactivate(work, &work_debug_descr);
496}
497
498void __init_work(struct work_struct *work, int onstack)
499{
500 if (onstack)
501 debug_object_init_on_stack(work, &work_debug_descr);
502 else
503 debug_object_init(work, &work_debug_descr);
504}
505EXPORT_SYMBOL_GPL(__init_work);
506
507void destroy_work_on_stack(struct work_struct *work)
508{
509 debug_object_free(work, &work_debug_descr);
510}
511EXPORT_SYMBOL_GPL(destroy_work_on_stack);
512
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000513void destroy_delayed_work_on_stack(struct delayed_work *work)
514{
515 destroy_timer_on_stack(&work->timer);
516 debug_object_free(&work->work, &work_debug_descr);
517}
518EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
519
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900520#else
521static inline void debug_work_activate(struct work_struct *work) { }
522static inline void debug_work_deactivate(struct work_struct *work) { }
523#endif
524
Li Bin4e8b22b2013-09-10 09:52:35 +0800525/**
526 * worker_pool_assign_id - allocate ID and assing it to @pool
527 * @pool: the pool pointer of interest
528 *
529 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
530 * successfully, -errno on failure.
531 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800532static int worker_pool_assign_id(struct worker_pool *pool)
533{
534 int ret;
535
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700536 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700537
Li Bin4e8b22b2013-09-10 09:52:35 +0800538 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
539 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700540 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700541 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700542 return 0;
543 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800544 return ret;
545}
546
Tejun Heo76af4d92013-03-12 11:30:00 -0700547/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700548 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
549 * @wq: the target workqueue
550 * @node: the node ID
551 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100552 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800553 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700554 * If the pwq needs to be used beyond the locking in effect, the caller is
555 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700556 *
557 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700558 */
559static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
560 int node)
561{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800562 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500563
564 /*
565 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
566 * delayed item is pending. The plan is to keep CPU -> NODE
567 * mapping valid and stable across CPU on/offlines. Once that
568 * happens, this workaround can be removed.
569 */
570 if (unlikely(node == NUMA_NO_NODE))
571 return wq->dfl_pwq;
572
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700573 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
574}
575
Tejun Heo73f53c42010-06-29 10:07:11 +0200576static unsigned int work_color_to_flags(int color)
577{
578 return color << WORK_STRUCT_COLOR_SHIFT;
579}
580
581static int get_work_color(struct work_struct *work)
582{
583 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
584 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
585}
586
587static int work_next_color(int color)
588{
589 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700590}
591
David Howells4594bf12006-12-07 11:33:26 +0000592/*
Tejun Heo112202d2013-02-13 19:29:12 -0800593 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
594 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800595 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200596 *
Tejun Heo112202d2013-02-13 19:29:12 -0800597 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
598 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700599 * work->data. These functions should only be called while the work is
600 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200601 *
Tejun Heo112202d2013-02-13 19:29:12 -0800602 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800603 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800604 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800605 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700606 *
607 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
608 * canceled. While being canceled, a work item may have its PENDING set
609 * but stay off timer and worklist for arbitrarily long and nobody should
610 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000611 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200612static inline void set_work_data(struct work_struct *work, unsigned long data,
613 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000614{
Tejun Heo6183c002013-03-12 11:29:57 -0700615 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200616 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000617}
David Howells365970a2006-11-22 14:54:49 +0000618
Tejun Heo112202d2013-02-13 19:29:12 -0800619static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200620 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200621{
Tejun Heo112202d2013-02-13 19:29:12 -0800622 set_work_data(work, (unsigned long)pwq,
623 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200624}
625
Lai Jiangshan4468a002013-02-06 18:04:53 -0800626static void set_work_pool_and_keep_pending(struct work_struct *work,
627 int pool_id)
628{
629 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
630 WORK_STRUCT_PENDING);
631}
632
Tejun Heo7c3eed52013-01-24 11:01:33 -0800633static void set_work_pool_and_clear_pending(struct work_struct *work,
634 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000635{
Tejun Heo23657bb2012-08-13 17:08:19 -0700636 /*
637 * The following wmb is paired with the implied mb in
638 * test_and_set_bit(PENDING) and ensures all updates to @work made
639 * here are visible to and precede any updates by the next PENDING
640 * owner.
641 */
642 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800643 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200644 /*
645 * The following mb guarantees that previous clear of a PENDING bit
646 * will not be reordered with any speculative LOADS or STORES from
647 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800648 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200649 * the same @work. E.g. consider this case:
650 *
651 * CPU#0 CPU#1
652 * ---------------------------- --------------------------------
653 *
654 * 1 STORE event_indicated
655 * 2 queue_work_on() {
656 * 3 test_and_set_bit(PENDING)
657 * 4 } set_..._and_clear_pending() {
658 * 5 set_work_data() # clear bit
659 * 6 smp_mb()
660 * 7 work->current_func() {
661 * 8 LOAD event_indicated
662 * }
663 *
664 * Without an explicit full barrier speculative LOAD on line 8 can
665 * be executed before CPU#0 does STORE on line 1. If that happens,
666 * CPU#0 observes the PENDING bit is still set and new execution of
667 * a @work is not queued in a hope, that CPU#1 will eventually
668 * finish the queued @work. Meanwhile CPU#1 does not see
669 * event_indicated is set, because speculative LOAD was executed
670 * before actual STORE.
671 */
672 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200673}
674
675static void clear_work_data(struct work_struct *work)
676{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800677 smp_wmb(); /* see set_work_pool_and_clear_pending() */
678 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200679}
680
Tejun Heo112202d2013-02-13 19:29:12 -0800681static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200682{
Tejun Heoe1201532010-07-22 14:14:25 +0200683 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200684
Tejun Heo112202d2013-02-13 19:29:12 -0800685 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200686 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
687 else
688 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200689}
690
Tejun Heo7c3eed52013-01-24 11:01:33 -0800691/**
692 * get_work_pool - return the worker_pool a given work was associated with
693 * @work: the work item of interest
694 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700695 * Pools are created and destroyed under wq_pool_mutex, and allows read
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100696 * access under RCU read lock. As such, this function should be
697 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700698 *
699 * All fields of the returned pool are accessible as long as the above
700 * mentioned locking is in effect. If the returned pool needs to be used
701 * beyond the critical section, the caller is responsible for ensuring the
702 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700703 *
704 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800705 */
706static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200707{
Tejun Heoe1201532010-07-22 14:14:25 +0200708 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800709 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200710
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700711 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700712
Tejun Heo112202d2013-02-13 19:29:12 -0800713 if (data & WORK_STRUCT_PWQ)
714 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800715 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200716
Tejun Heo7c3eed52013-01-24 11:01:33 -0800717 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
718 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200719 return NULL;
720
Tejun Heofa1b54e2013-03-12 11:30:00 -0700721 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800722}
723
724/**
725 * get_work_pool_id - return the worker pool ID a given work is associated with
726 * @work: the work item of interest
727 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700728 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800729 * %WORK_OFFQ_POOL_NONE if none.
730 */
731static int get_work_pool_id(struct work_struct *work)
732{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800733 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800734
Tejun Heo112202d2013-02-13 19:29:12 -0800735 if (data & WORK_STRUCT_PWQ)
736 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800737 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
738
739 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800740}
741
Tejun Heobbb68df2012-08-03 10:30:46 -0700742static void mark_work_canceling(struct work_struct *work)
743{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800744 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700745
Tejun Heo7c3eed52013-01-24 11:01:33 -0800746 pool_id <<= WORK_OFFQ_POOL_SHIFT;
747 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700748}
749
750static bool work_is_canceling(struct work_struct *work)
751{
752 unsigned long data = atomic_long_read(&work->data);
753
Tejun Heo112202d2013-02-13 19:29:12 -0800754 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700755}
756
David Howells365970a2006-11-22 14:54:49 +0000757/*
Tejun Heo32704762012-07-13 22:16:45 -0700758 * Policy functions. These define the policies on how the global worker
759 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800760 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000761 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200762
Tejun Heo63d95a92012-07-12 14:46:37 -0700763static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000764{
Tejun Heoe19e3972013-01-24 11:39:44 -0800765 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000766}
767
Tejun Heoe22bee72010-06-29 10:07:14 +0200768/*
769 * Need to wake up a worker? Called from anything but currently
770 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700771 *
772 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800773 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700774 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200775 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700776static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000777{
Tejun Heo63d95a92012-07-12 14:46:37 -0700778 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000779}
780
Tejun Heoe22bee72010-06-29 10:07:14 +0200781/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700782static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200783{
Tejun Heo63d95a92012-07-12 14:46:37 -0700784 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200785}
786
787/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700788static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200789{
Tejun Heoe19e3972013-01-24 11:39:44 -0800790 return !list_empty(&pool->worklist) &&
791 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200792}
793
794/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700795static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200796{
Tejun Heo63d95a92012-07-12 14:46:37 -0700797 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200798}
799
Tejun Heoe22bee72010-06-29 10:07:14 +0200800/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700801static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200802{
Tejun Heo692b4822017-10-09 08:04:13 -0700803 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700804 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
805 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200806
807 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
808}
809
810/*
811 * Wake up functions.
812 */
813
Lai Jiangshan1037de32014-05-22 16:44:07 +0800814/* Return the first idle worker. Safe with preemption disabled */
815static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200816{
Tejun Heo63d95a92012-07-12 14:46:37 -0700817 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200818 return NULL;
819
Tejun Heo63d95a92012-07-12 14:46:37 -0700820 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200821}
822
823/**
824 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700825 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200826 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700827 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200828 *
829 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200830 * raw_spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200831 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700832static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200833{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800834 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200835
836 if (likely(worker))
837 wake_up_process(worker->task);
838}
839
Tejun Heo4690c4a2010-06-29 10:07:10 +0200840/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100841 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100844 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200845 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100846void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200847{
848 struct worker *worker = kthread_data(task);
849
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100850 if (!worker->sleeping)
851 return;
852 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800853 atomic_inc(&worker->pool->nr_running);
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100854 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200855}
856
857/**
858 * wq_worker_sleeping - a worker is going to sleep
859 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200860 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100861 * This function is called from schedule() when a busy worker is
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100862 * going to sleep. Preemption needs to be disabled to protect ->sleeping
863 * assignment.
Tejun Heoe22bee72010-06-29 10:07:14 +0200864 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100865void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200866{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100867 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800868 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200869
Tejun Heo111c2252013-01-17 17:16:24 -0800870 /*
871 * Rescuers, which may not have all the fields set up like normal
872 * workers, also reach here, let's not access anything before
873 * checking NOT_RUNNING.
874 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500875 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100876 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200877
Tejun Heo111c2252013-01-17 17:16:24 -0800878 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800879
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100880 /* Return if preempted before wq_worker_running() was reached */
881 if (worker->sleeping)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100882 return;
883
884 worker->sleeping = 1;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200885 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200886
887 /*
888 * The counterpart of the following dec_and_test, implied mb,
889 * worklist not empty test sequence is in insert_work().
890 * Please read comment there.
891 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700892 * NOT_RUNNING is clear. This means that we're bound to and
893 * running on the local cpu w/ rq lock held and preemption
894 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800895 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700896 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200897 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800898 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100899 !list_empty(&pool->worklist)) {
900 next = first_idle_worker(pool);
901 if (next)
902 wake_up_process(next->task);
903 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200904 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200905}
906
907/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800908 * wq_worker_last_func - retrieve worker's last work function
Bart Van Assche8194fe92019-03-19 10:45:09 -0700909 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800910 *
911 * Determine the last function a worker executed. This is called from
912 * the scheduler to get a worker's last known identity.
913 *
914 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200915 * raw_spin_lock_irq(rq->lock)
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800916 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800917 * This function is called during schedule() when a kworker is going
918 * to sleep. It's used by psi to identify aggregation workers during
919 * dequeuing, to allow periodic aggregation to shut-off when that
920 * worker is the last task in the system or cgroup to go to sleep.
921 *
922 * As this function doesn't involve any workqueue-related locking, it
923 * only returns stable values when called from inside the scheduler's
924 * queuing and dequeuing paths, when @task, which must be a kworker,
925 * is guaranteed to not be processing any works.
926 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800927 * Return:
928 * The last work function %current executed as a worker, NULL if it
929 * hasn't executed any work yet.
930 */
931work_func_t wq_worker_last_func(struct task_struct *task)
932{
933 struct worker *worker = kthread_data(task);
934
935 return worker->last_func;
936}
937
938/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200939 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200940 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200941 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200942 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800943 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200944 *
Tejun Heocb444762010-07-02 10:03:50 +0200945 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200946 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200947 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800948static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200949{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700950 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200951
Tejun Heocb444762010-07-02 10:03:50 +0200952 WARN_ON_ONCE(worker->task != current);
953
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800954 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200955 if ((flags & WORKER_NOT_RUNNING) &&
956 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800957 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200958 }
959
Tejun Heod302f012010-06-29 10:07:13 +0200960 worker->flags |= flags;
961}
962
963/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200964 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200965 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200966 * @flags: flags to clear
967 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200968 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200969 *
Tejun Heocb444762010-07-02 10:03:50 +0200970 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200971 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200972 */
973static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
974{
Tejun Heo63d95a92012-07-12 14:46:37 -0700975 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200976 unsigned int oflags = worker->flags;
977
Tejun Heocb444762010-07-02 10:03:50 +0200978 WARN_ON_ONCE(worker->task != current);
979
Tejun Heod302f012010-06-29 10:07:13 +0200980 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200981
Tejun Heo42c025f2011-01-11 15:58:49 +0100982 /*
983 * If transitioning out of NOT_RUNNING, increment nr_running. Note
984 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
985 * of multiple flags, not a single flag.
986 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200987 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
988 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800989 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200990}
991
992/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200993 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800994 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200995 * @work: work to find worker for
996 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800997 * Find a worker which is executing @work on @pool by searching
998 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800999 * to match, its current execution should match the address of @work and
1000 * its work function. This is to avoid unwanted dependency between
1001 * unrelated work executions through a work item being recycled while still
1002 * being executed.
1003 *
1004 * This is a bit tricky. A work item may be freed once its execution
1005 * starts and nothing prevents the freed area from being recycled for
1006 * another work item. If the same work item address ends up being reused
1007 * before the original execution finishes, workqueue will identify the
1008 * recycled work item as currently executing and make it wait until the
1009 * current execution finishes, introducing an unwanted dependency.
1010 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001011 * This function checks the work item address and work function to avoid
1012 * false positives. Note that this isn't complete as one may construct a
1013 * work function which can introduce dependency onto itself through a
1014 * recycled work item. Well, if somebody wants to shoot oneself in the
1015 * foot that badly, there's only so much we can do, and if such deadlock
1016 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001017 *
1018 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001019 * raw_spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001020 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001021 * Return:
1022 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001023 * otherwise.
1024 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001025static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001026 struct work_struct *work)
1027{
Sasha Levin42f85702012-12-17 10:01:23 -05001028 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001029
Sasha Levinb67bfe02013-02-27 17:06:00 -08001030 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001031 (unsigned long)work)
1032 if (worker->current_work == work &&
1033 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001034 return worker;
1035
1036 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001037}
1038
1039/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001040 * move_linked_works - move linked works to a list
1041 * @work: start of series of works to be scheduled
1042 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301043 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001044 *
1045 * Schedule linked works starting from @work to @head. Work series to
1046 * be scheduled starts at @work and includes any consecutive work with
1047 * WORK_STRUCT_LINKED set in its predecessor.
1048 *
1049 * If @nextp is not NULL, it's updated to point to the next work of
1050 * the last scheduled work. This allows move_linked_works() to be
1051 * nested inside outer list_for_each_entry_safe().
1052 *
1053 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001054 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001055 */
1056static void move_linked_works(struct work_struct *work, struct list_head *head,
1057 struct work_struct **nextp)
1058{
1059 struct work_struct *n;
1060
1061 /*
1062 * Linked worklist will always end before the end of the list,
1063 * use NULL for list head.
1064 */
1065 list_for_each_entry_safe_from(work, n, NULL, entry) {
1066 list_move_tail(&work->entry, head);
1067 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1068 break;
1069 }
1070
1071 /*
1072 * If we're already inside safe list traversal and have moved
1073 * multiple works to the scheduled queue, the next position
1074 * needs to be updated.
1075 */
1076 if (nextp)
1077 *nextp = n;
1078}
1079
Tejun Heo8864b4e2013-03-12 11:30:04 -07001080/**
1081 * get_pwq - get an extra reference on the specified pool_workqueue
1082 * @pwq: pool_workqueue to get
1083 *
1084 * Obtain an extra reference on @pwq. The caller should guarantee that
1085 * @pwq has positive refcnt and be holding the matching pool->lock.
1086 */
1087static void get_pwq(struct pool_workqueue *pwq)
1088{
1089 lockdep_assert_held(&pwq->pool->lock);
1090 WARN_ON_ONCE(pwq->refcnt <= 0);
1091 pwq->refcnt++;
1092}
1093
1094/**
1095 * put_pwq - put a pool_workqueue reference
1096 * @pwq: pool_workqueue to put
1097 *
1098 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1099 * destruction. The caller should be holding the matching pool->lock.
1100 */
1101static void put_pwq(struct pool_workqueue *pwq)
1102{
1103 lockdep_assert_held(&pwq->pool->lock);
1104 if (likely(--pwq->refcnt))
1105 return;
1106 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1107 return;
1108 /*
1109 * @pwq can't be released under pool->lock, bounce to
1110 * pwq_unbound_release_workfn(). This never recurses on the same
1111 * pool->lock as this path is taken only for unbound workqueues and
1112 * the release work item is scheduled on a per-cpu workqueue. To
1113 * avoid lockdep warning, unbound pool->locks are given lockdep
1114 * subclass of 1 in get_unbound_pool().
1115 */
1116 schedule_work(&pwq->unbound_release_work);
1117}
1118
Tejun Heodce90d42013-04-01 11:23:35 -07001119/**
1120 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1121 * @pwq: pool_workqueue to put (can be %NULL)
1122 *
1123 * put_pwq() with locking. This function also allows %NULL @pwq.
1124 */
1125static void put_pwq_unlocked(struct pool_workqueue *pwq)
1126{
1127 if (pwq) {
1128 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001129 * As both pwqs and pools are RCU protected, the
Tejun Heodce90d42013-04-01 11:23:35 -07001130 * following lock operations are safe.
1131 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001132 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001133 put_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001134 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001135 }
1136}
1137
Tejun Heo112202d2013-02-13 19:29:12 -08001138static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001139{
Tejun Heo112202d2013-02-13 19:29:12 -08001140 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001141
1142 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001143 if (list_empty(&pwq->pool->worklist))
1144 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001145 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001146 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001147 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001148}
1149
Tejun Heo112202d2013-02-13 19:29:12 -08001150static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001151{
Tejun Heo112202d2013-02-13 19:29:12 -08001152 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001153 struct work_struct, entry);
1154
Tejun Heo112202d2013-02-13 19:29:12 -08001155 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001156}
1157
Tejun Heobf4ede02012-08-03 10:30:46 -07001158/**
Tejun Heo112202d2013-02-13 19:29:12 -08001159 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1160 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001161 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001162 *
1163 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001164 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001165 *
1166 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001167 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001168 */
Tejun Heo112202d2013-02-13 19:29:12 -08001169static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001170{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001171 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001172 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001173 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001174
Tejun Heo112202d2013-02-13 19:29:12 -08001175 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001176
Tejun Heo112202d2013-02-13 19:29:12 -08001177 pwq->nr_active--;
1178 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001179 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001180 if (pwq->nr_active < pwq->max_active)
1181 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001182 }
1183
1184 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001185 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001186 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001187
1188 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001189 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001190 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001191
Tejun Heo112202d2013-02-13 19:29:12 -08001192 /* this pwq is done, clear flush_color */
1193 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001194
1195 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001196 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001197 * will handle the rest.
1198 */
Tejun Heo112202d2013-02-13 19:29:12 -08001199 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1200 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001201out_put:
1202 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001203}
1204
Tejun Heo36e227d2012-08-03 10:30:46 -07001205/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001206 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001207 * @work: work item to steal
1208 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001209 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001210 *
1211 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001212 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001213 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001214 * Return:
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001215 *
1216 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001217 * 1 if @work was pending and we successfully stole PENDING
1218 * 0 if @work was idle and we claimed PENDING
1219 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001220 * -ENOENT if someone else is canceling @work, this state may persist
1221 * for arbitrarily long
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001222 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001223 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001224 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001225 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001226 * interrupted while holding PENDING and @work off queue, irq must be
1227 * disabled on entry. This, combined with delayed_work->timer being
1228 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001229 *
1230 * On successful return, >= 0, irq is disabled and the caller is
1231 * responsible for releasing it using local_irq_restore(*@flags).
1232 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001233 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001234 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001235static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1236 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001237{
Tejun Heod565ed62013-01-24 11:01:33 -08001238 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001239 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001240
Tejun Heobbb68df2012-08-03 10:30:46 -07001241 local_irq_save(*flags);
1242
Tejun Heo36e227d2012-08-03 10:30:46 -07001243 /* try to steal the timer if it exists */
1244 if (is_dwork) {
1245 struct delayed_work *dwork = to_delayed_work(work);
1246
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001247 /*
1248 * dwork->timer is irqsafe. If del_timer() fails, it's
1249 * guaranteed that the timer is not queued anywhere and not
1250 * running on the local CPU.
1251 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001252 if (likely(del_timer(&dwork->timer)))
1253 return 1;
1254 }
1255
1256 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001257 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1258 return 0;
1259
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001260 rcu_read_lock();
Tejun Heobf4ede02012-08-03 10:30:46 -07001261 /*
1262 * The queueing is in progress, or it is already queued. Try to
1263 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1264 */
Tejun Heod565ed62013-01-24 11:01:33 -08001265 pool = get_work_pool(work);
1266 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001267 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001268
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001269 raw_spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001270 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001271 * work->data is guaranteed to point to pwq only while the work
1272 * item is queued on pwq->wq, and both updating work->data to point
1273 * to pwq on queueing and to pool on dequeueing are done under
1274 * pwq->pool->lock. This in turn guarantees that, if work->data
1275 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001276 * item is currently queued on that pool.
1277 */
Tejun Heo112202d2013-02-13 19:29:12 -08001278 pwq = get_work_pwq(work);
1279 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001280 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001281
Tejun Heo16062832013-02-06 18:04:53 -08001282 /*
1283 * A delayed work item cannot be grabbed directly because
1284 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001285 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001286 * management later on and cause stall. Make sure the work
1287 * item is activated before grabbing.
1288 */
1289 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001290 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001291
Tejun Heo16062832013-02-06 18:04:53 -08001292 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001293 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001294
Tejun Heo112202d2013-02-13 19:29:12 -08001295 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001296 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001297
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001298 raw_spin_unlock(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001299 rcu_read_unlock();
Tejun Heo16062832013-02-06 18:04:53 -08001300 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001301 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001302 raw_spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001303fail:
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001304 rcu_read_unlock();
Tejun Heobbb68df2012-08-03 10:30:46 -07001305 local_irq_restore(*flags);
1306 if (work_is_canceling(work))
1307 return -ENOENT;
1308 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001309 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001310}
1311
1312/**
Tejun Heo706026c2013-01-24 11:01:34 -08001313 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001314 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001315 * @work: work to insert
1316 * @head: insertion point
1317 * @extra_flags: extra WORK_STRUCT_* flags to set
1318 *
Tejun Heo112202d2013-02-13 19:29:12 -08001319 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001320 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001321 *
1322 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001323 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001324 */
Tejun Heo112202d2013-02-13 19:29:12 -08001325static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1326 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001327{
Tejun Heo112202d2013-02-13 19:29:12 -08001328 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001329
Walter Wue89a85d2020-12-14 19:09:09 -08001330 /* record the work call stack in order to print it in KASAN reports */
1331 kasan_record_aux_stack(work);
1332
Tejun Heo4690c4a2010-06-29 10:07:10 +02001333 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001334 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001335 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001336 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001337
1338 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001339 * Ensure either wq_worker_sleeping() sees the above
1340 * list_add_tail() or we see zero nr_running to avoid workers lying
1341 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001342 */
1343 smp_mb();
1344
Tejun Heo63d95a92012-07-12 14:46:37 -07001345 if (__need_more_worker(pool))
1346 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001347}
1348
Tejun Heoc8efcc22010-12-20 19:32:04 +01001349/*
1350 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001351 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001352 */
1353static bool is_chained_work(struct workqueue_struct *wq)
1354{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001355 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001356
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001357 worker = current_wq_worker();
1358 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001359 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001360 * I'm @worker, it's safe to dereference it without locking.
1361 */
Tejun Heo112202d2013-02-13 19:29:12 -08001362 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001363}
1364
Mike Galbraithef5571802016-02-09 17:59:38 -05001365/*
1366 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1367 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1368 * avoid perturbing sensitive tasks.
1369 */
1370static int wq_select_unbound_cpu(int cpu)
1371{
Tejun Heof303fccb2016-02-09 17:59:38 -05001372 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001373 int new_cpu;
1374
Tejun Heof303fccb2016-02-09 17:59:38 -05001375 if (likely(!wq_debug_force_rr_cpu)) {
1376 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1377 return cpu;
1378 } else if (!printed_dbg_warning) {
1379 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1380 printed_dbg_warning = true;
1381 }
1382
Mike Galbraithef5571802016-02-09 17:59:38 -05001383 if (cpumask_empty(wq_unbound_cpumask))
1384 return cpu;
1385
1386 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1387 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1388 if (unlikely(new_cpu >= nr_cpu_ids)) {
1389 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1390 if (unlikely(new_cpu >= nr_cpu_ids))
1391 return cpu;
1392 }
1393 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1394
1395 return new_cpu;
1396}
1397
Tejun Heod84ff052013-03-12 11:29:59 -07001398static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 struct work_struct *work)
1400{
Tejun Heo112202d2013-02-13 19:29:12 -08001401 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001402 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001403 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001404 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001405 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001406
1407 /*
1408 * While a work item is PENDING && off queue, a task trying to
1409 * steal the PENDING will busy-loop waiting for it to either get
1410 * queued or lose PENDING. Grabbing PENDING and queueing should
1411 * happen with IRQ disabled.
1412 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001413 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001415
Li Bin9ef28a72013-09-09 13:13:58 +08001416 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001417 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001418 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001419 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001420 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001421retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001422 /* pwq which will be used unless @work is executing elsewhere */
Hillf Dantonaa202f12020-01-24 20:14:45 -05001423 if (wq->flags & WQ_UNBOUND) {
1424 if (req_cpu == WORK_CPU_UNBOUND)
1425 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001426 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Dantonaa202f12020-01-24 20:14:45 -05001427 } else {
1428 if (req_cpu == WORK_CPU_UNBOUND)
1429 cpu = raw_smp_processor_id();
1430 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1431 }
Tejun Heodbf25762012-08-20 14:51:23 -07001432
Tejun Heoc9178082013-03-12 11:30:04 -07001433 /*
1434 * If @work was previously on a different pool, it might still be
1435 * running there, in which case the work needs to be queued on that
1436 * pool to guarantee non-reentrancy.
1437 */
1438 last_pool = get_work_pool(work);
1439 if (last_pool && last_pool != pwq->pool) {
1440 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001441
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001442 raw_spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001443
Tejun Heoc9178082013-03-12 11:30:04 -07001444 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001445
Tejun Heoc9178082013-03-12 11:30:04 -07001446 if (worker && worker->current_pwq->wq == wq) {
1447 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001448 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001449 /* meh... not running there, queue here */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001450 raw_spin_unlock(&last_pool->lock);
1451 raw_spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001452 }
Tejun Heof3421792010-07-02 10:03:51 +02001453 } else {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001454 raw_spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001455 }
1456
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001457 /*
1458 * pwq is determined and locked. For unbound pools, we could have
1459 * raced with pwq release and it could already be dead. If its
1460 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001461 * without another pwq replacing it in the numa_pwq_tbl or while
1462 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001463 * make forward-progress.
1464 */
1465 if (unlikely(!pwq->refcnt)) {
1466 if (wq->flags & WQ_UNBOUND) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001467 raw_spin_unlock(&pwq->pool->lock);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001468 cpu_relax();
1469 goto retry;
1470 }
1471 /* oops */
1472 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1473 wq->name, cpu);
1474 }
1475
Tejun Heo112202d2013-02-13 19:29:12 -08001476 /* pwq determined, queue */
1477 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001478
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001479 if (WARN_ON(!list_empty(&work->entry)))
1480 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001481
Tejun Heo112202d2013-02-13 19:29:12 -08001482 pwq->nr_in_flight[pwq->work_color]++;
1483 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001484
Tejun Heo112202d2013-02-13 19:29:12 -08001485 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001486 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001487 pwq->nr_active++;
1488 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001489 if (list_empty(worklist))
1490 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001491 } else {
1492 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001493 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001494 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001495
Zqiang0687c662021-02-18 11:16:49 +08001496 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001497 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001498
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001499out:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001500 raw_spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001501 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502}
1503
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001504/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001505 * queue_work_on - queue work on specific cpu
1506 * @cpu: CPU number to execute work on
1507 * @wq: workqueue to use
1508 * @work: work to queue
1509 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001510 * We queue the work to a specific CPU, the caller must ensure it
1511 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001512 *
1513 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001514 */
Tejun Heod4283e92012-08-03 10:30:44 -07001515bool queue_work_on(int cpu, struct workqueue_struct *wq,
1516 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001517{
Tejun Heod4283e92012-08-03 10:30:44 -07001518 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001519 unsigned long flags;
1520
1521 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001522
Tejun Heo22df02b2010-06-29 10:07:10 +02001523 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001524 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001525 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001526 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001527
1528 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001529 return ret;
1530}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001531EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001532
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001533/**
1534 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1535 * @node: NUMA node ID that we want to select a CPU from
1536 *
1537 * This function will attempt to find a "random" cpu available on a given
1538 * node. If there are no CPUs available on the given node it will return
1539 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1540 * available CPU if we need to schedule this work.
1541 */
1542static int workqueue_select_cpu_near(int node)
1543{
1544 int cpu;
1545
1546 /* No point in doing this if NUMA isn't enabled for workqueues */
1547 if (!wq_numa_enabled)
1548 return WORK_CPU_UNBOUND;
1549
1550 /* Delay binding to CPU if node is not valid or online */
1551 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1552 return WORK_CPU_UNBOUND;
1553
1554 /* Use local node/cpu if we are already there */
1555 cpu = raw_smp_processor_id();
1556 if (node == cpu_to_node(cpu))
1557 return cpu;
1558
1559 /* Use "random" otherwise know as "first" online CPU of node */
1560 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1561
1562 /* If CPU is valid return that, otherwise just defer */
1563 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1564}
1565
1566/**
1567 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1568 * @node: NUMA node that we are targeting the work for
1569 * @wq: workqueue to use
1570 * @work: work to queue
1571 *
1572 * We queue the work to a "random" CPU within a given NUMA node. The basic
1573 * idea here is to provide a way to somehow associate work with a given
1574 * NUMA node.
1575 *
1576 * This function will only make a best effort attempt at getting this onto
1577 * the right NUMA node. If no node is requested or the requested node is
1578 * offline then we just fall back to standard queue_work behavior.
1579 *
1580 * Currently the "random" CPU ends up being the first available CPU in the
1581 * intersection of cpu_online_mask and the cpumask of the node, unless we
1582 * are running on the node. In that case we just use the current CPU.
1583 *
1584 * Return: %false if @work was already on a queue, %true otherwise.
1585 */
1586bool queue_work_node(int node, struct workqueue_struct *wq,
1587 struct work_struct *work)
1588{
1589 unsigned long flags;
1590 bool ret = false;
1591
1592 /*
1593 * This current implementation is specific to unbound workqueues.
1594 * Specifically we only return the first available CPU for a given
1595 * node instead of cycling through individual CPUs within the node.
1596 *
1597 * If this is used with a per-cpu workqueue then the logic in
1598 * workqueue_select_cpu_near would need to be updated to allow for
1599 * some round robin type logic.
1600 */
1601 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1602
1603 local_irq_save(flags);
1604
1605 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1606 int cpu = workqueue_select_cpu_near(node);
1607
1608 __queue_work(cpu, wq, work);
1609 ret = true;
1610 }
1611
1612 local_irq_restore(flags);
1613 return ret;
1614}
1615EXPORT_SYMBOL_GPL(queue_work_node);
1616
Kees Cook8c20feb2017-10-04 16:27:07 -07001617void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618{
Kees Cook8c20feb2017-10-04 16:27:07 -07001619 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001621 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001622 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001624EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001626static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1627 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001629 struct timer_list *timer = &dwork->timer;
1630 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Tejun Heo637fdba2017-03-06 15:33:42 -05001632 WARN_ON_ONCE(!wq);
Sami Tolvanen98173112021-04-08 11:28:30 -07001633 WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001634 WARN_ON_ONCE(timer_pending(timer));
1635 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001636
Tejun Heo8852aac2012-12-01 16:23:42 -08001637 /*
1638 * If @delay is 0, queue @dwork->work immediately. This is for
1639 * both optimization and correctness. The earliest @timer can
1640 * expire is on the closest next tick and delayed_work users depend
1641 * on that there's no such delay when @delay is 0.
1642 */
1643 if (!delay) {
1644 __queue_work(cpu, wq, &dwork->work);
1645 return;
1646 }
1647
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001648 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001649 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001650 timer->expires = jiffies + delay;
1651
Tejun Heo041bd122016-02-09 16:11:26 -05001652 if (unlikely(cpu != WORK_CPU_UNBOUND))
1653 add_timer_on(timer, cpu);
1654 else
1655 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656}
1657
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001658/**
1659 * queue_delayed_work_on - queue work on specific CPU after delay
1660 * @cpu: CPU number to execute work on
1661 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001662 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001663 * @delay: number of jiffies to wait before queueing
1664 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001665 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001666 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1667 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001668 */
Tejun Heod4283e92012-08-03 10:30:44 -07001669bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1670 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001671{
David Howells52bad642006-11-22 14:54:01 +00001672 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001673 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001674 unsigned long flags;
1675
1676 /* read the comment in __queue_work() */
1677 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001678
Tejun Heo22df02b2010-06-29 10:07:10 +02001679 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001680 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001681 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001682 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001683
1684 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001685 return ret;
1686}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001687EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
Tejun Heoc8e55f32010-06-29 10:07:12 +02001689/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001690 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1691 * @cpu: CPU number to execute work on
1692 * @wq: workqueue to use
1693 * @dwork: work to queue
1694 * @delay: number of jiffies to wait before queueing
1695 *
1696 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1697 * modify @dwork's timer so that it expires after @delay. If @delay is
1698 * zero, @work is guaranteed to be scheduled immediately regardless of its
1699 * current state.
1700 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001701 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001702 * pending and its timer was modified.
1703 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001704 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001705 * See try_to_grab_pending() for details.
1706 */
1707bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1708 struct delayed_work *dwork, unsigned long delay)
1709{
1710 unsigned long flags;
1711 int ret;
1712
1713 do {
1714 ret = try_to_grab_pending(&dwork->work, true, &flags);
1715 } while (unlikely(ret == -EAGAIN));
1716
1717 if (likely(ret >= 0)) {
1718 __queue_delayed_work(cpu, wq, dwork, delay);
1719 local_irq_restore(flags);
1720 }
1721
1722 /* -ENOENT from try_to_grab_pending() becomes %true */
1723 return ret;
1724}
1725EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1726
Tejun Heo05f0fe62018-03-14 12:45:13 -07001727static void rcu_work_rcufn(struct rcu_head *rcu)
1728{
1729 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1730
1731 /* read the comment in __queue_work() */
1732 local_irq_disable();
1733 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1734 local_irq_enable();
1735}
1736
1737/**
1738 * queue_rcu_work - queue work after a RCU grace period
1739 * @wq: workqueue to use
1740 * @rwork: work to queue
1741 *
1742 * Return: %false if @rwork was already pending, %true otherwise. Note
1743 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001744 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001745 * execution may happen before a full RCU grace period has passed.
1746 */
1747bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1748{
1749 struct work_struct *work = &rwork->work;
1750
1751 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1752 rwork->wq = wq;
1753 call_rcu(&rwork->rcu, rcu_work_rcufn);
1754 return true;
1755 }
1756
1757 return false;
1758}
1759EXPORT_SYMBOL(queue_rcu_work);
1760
Tejun Heo8376fe22012-08-03 10:30:47 -07001761/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001762 * worker_enter_idle - enter idle state
1763 * @worker: worker which is entering idle state
1764 *
1765 * @worker is entering idle state. Update stats and idle timer if
1766 * necessary.
1767 *
1768 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001769 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001770 */
1771static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001773 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Tejun Heo6183c002013-03-12 11:29:57 -07001775 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1776 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1777 (worker->hentry.next || worker->hentry.pprev)))
1778 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Lai Jiangshan051e1852014-07-22 13:03:02 +08001780 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001781 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001782 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001783 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001784
Tejun Heoc8e55f32010-06-29 10:07:12 +02001785 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001786 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001787
Tejun Heo628c78e2012-07-17 12:39:27 -07001788 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1789 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001790
Tejun Heo544ecf32012-05-14 15:04:50 -07001791 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001792 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001793 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001794 * nr_running, the warning may trigger spuriously. Check iff
1795 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001796 */
Tejun Heo24647572013-01-24 11:01:33 -08001797 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001798 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001799 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800}
1801
Tejun Heoc8e55f32010-06-29 10:07:12 +02001802/**
1803 * worker_leave_idle - leave idle state
1804 * @worker: worker which is leaving idle state
1805 *
1806 * @worker is leaving idle state. Update stats.
1807 *
1808 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001809 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001810 */
1811static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001813 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
Tejun Heo6183c002013-03-12 11:29:57 -07001815 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1816 return;
Tejun Heod302f012010-06-29 10:07:13 +02001817 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001818 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001819 list_del_init(&worker->entry);
1820}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001822static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001823{
1824 struct worker *worker;
1825
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001826 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001827 if (worker) {
1828 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001829 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001830 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001831 /* on creation a worker is in !idle && prep state */
1832 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001833 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001834 return worker;
1835}
1836
1837/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001838 * worker_attach_to_pool() - attach a worker to a pool
1839 * @worker: worker to be attached
1840 * @pool: the target pool
1841 *
1842 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1843 * cpu-binding of @worker are kept coordinated with the pool across
1844 * cpu-[un]hotplugs.
1845 */
1846static void worker_attach_to_pool(struct worker *worker,
1847 struct worker_pool *pool)
1848{
Tejun Heo1258fae2018-05-18 08:47:13 -07001849 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001850
1851 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001852 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1853 * stable across this function. See the comments above the flag
1854 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001855 */
1856 if (pool->flags & POOL_DISASSOCIATED)
1857 worker->flags |= WORKER_UNBOUND;
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001858 else
1859 kthread_set_per_cpu(worker->task, pool->cpu);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001860
Peter Zijlstra640f17c2021-01-15 19:08:36 +01001861 if (worker->rescue_wq)
1862 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1863
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001864 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001865 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001866
Tejun Heo1258fae2018-05-18 08:47:13 -07001867 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001868}
1869
1870/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001871 * worker_detach_from_pool() - detach a worker from its pool
1872 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001873 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001874 * Undo the attaching which had been done in worker_attach_to_pool(). The
1875 * caller worker shouldn't access to the pool after detached except it has
1876 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001877 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001878static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001879{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001880 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001881 struct completion *detach_completion = NULL;
1882
Tejun Heo1258fae2018-05-18 08:47:13 -07001883 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001884
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001885 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshanda028462014-05-20 17:46:31 +08001886 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001887 worker->pool = NULL;
1888
Lai Jiangshanda028462014-05-20 17:46:31 +08001889 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001890 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001891 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001892
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001893 /* clear leftover flags without pool->lock after it is detached */
1894 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1895
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001896 if (detach_completion)
1897 complete(detach_completion);
1898}
1899
1900/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001901 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001902 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001903 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001904 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001905 *
1906 * CONTEXT:
1907 * Might sleep. Does GFP_KERNEL allocations.
1908 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001909 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001910 * Pointer to the newly created worker.
1911 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001912static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001913{
Tejun Heoc34056a2010-06-29 10:07:11 +02001914 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001915 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001916 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001917
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001918 /* ID is needed to determine kthread name */
1919 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001920 if (id < 0)
1921 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001922
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001923 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001924 if (!worker)
1925 goto fail;
1926
Tejun Heoc34056a2010-06-29 10:07:11 +02001927 worker->id = id;
1928
Tejun Heo29c91e92013-03-12 11:30:03 -07001929 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001930 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1931 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001932 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001933 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1934
Tejun Heof3f90ad2013-04-01 11:23:34 -07001935 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001936 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001937 if (IS_ERR(worker->task))
1938 goto fail;
1939
Oleg Nesterov91151222013-11-14 12:56:18 +01001940 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001941 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001942
Lai Jiangshanda028462014-05-20 17:46:31 +08001943 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001944 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001945
Lai Jiangshan051e1852014-07-22 13:03:02 +08001946 /* start the newly created worker */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001947 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001948 worker->pool->nr_workers++;
1949 worker_enter_idle(worker);
1950 wake_up_process(worker->task);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001951 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001952
Tejun Heoc34056a2010-06-29 10:07:11 +02001953 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001954
Tejun Heoc34056a2010-06-29 10:07:11 +02001955fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001956 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001957 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001958 kfree(worker);
1959 return NULL;
1960}
1961
1962/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001963 * destroy_worker - destroy a workqueue worker
1964 * @worker: worker to be destroyed
1965 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001966 * Destroy @worker and adjust @pool stats accordingly. The worker should
1967 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001968 *
1969 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001970 * raw_spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001971 */
1972static void destroy_worker(struct worker *worker)
1973{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001974 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001975
Tejun Heocd549682013-03-13 19:47:39 -07001976 lockdep_assert_held(&pool->lock);
1977
Tejun Heoc34056a2010-06-29 10:07:11 +02001978 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001979 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001980 WARN_ON(!list_empty(&worker->scheduled)) ||
1981 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001982 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001983
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001984 pool->nr_workers--;
1985 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001986
Tejun Heoc8e55f32010-06-29 10:07:12 +02001987 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001988 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001989 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001990}
1991
Kees Cook32a6c722017-10-16 15:58:25 -07001992static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001993{
Kees Cook32a6c722017-10-16 15:58:25 -07001994 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001995
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001996 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001997
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001998 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 struct worker *worker;
2000 unsigned long expires;
2001
2002 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07002003 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2005
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002006 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002007 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002008 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002010
2011 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 }
2013
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002014 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002015}
2016
Tejun Heo493a1722013-03-12 11:29:59 -07002017static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002018{
Tejun Heo112202d2013-02-13 19:29:12 -08002019 struct pool_workqueue *pwq = get_work_pwq(work);
2020 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002021
Tejun Heo2e109a22013-03-13 19:47:40 -07002022 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002023
Tejun Heo493008a2013-03-12 11:30:03 -07002024 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002025 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002026
2027 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002028 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002029 /*
2030 * If @pwq is for an unbound wq, its base ref may be put at
2031 * any time due to an attribute change. Pin @pwq until the
2032 * rescuer is done with it.
2033 */
2034 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002035 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002036 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002037 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002038}
2039
Kees Cook32a6c722017-10-16 15:58:25 -07002040static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002041{
Kees Cook32a6c722017-10-16 15:58:25 -07002042 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002043 struct work_struct *work;
2044
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002045 raw_spin_lock_irq(&pool->lock);
2046 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002047
Tejun Heo63d95a92012-07-12 14:46:37 -07002048 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002049 /*
2050 * We've been trying to create a new worker but
2051 * haven't been successful. We might be hitting an
2052 * allocation deadlock. Send distress signals to
2053 * rescuers.
2054 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002055 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002056 send_mayday(work);
2057 }
2058
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002059 raw_spin_unlock(&wq_mayday_lock);
2060 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002061
Tejun Heo63d95a92012-07-12 14:46:37 -07002062 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002063}
2064
2065/**
2066 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002067 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002068 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002069 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002070 * have at least one idle worker on return from this function. If
2071 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002072 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002073 * possible allocation deadlock.
2074 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002075 * On return, need_to_create_worker() is guaranteed to be %false and
2076 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002077 *
2078 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002079 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002080 * multiple times. Does GFP_KERNEL allocations. Called only from
2081 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002082 */
Tejun Heo29187a92015-01-16 14:21:16 -05002083static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002084__releases(&pool->lock)
2085__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002086{
Tejun Heoe22bee72010-06-29 10:07:14 +02002087restart:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002088 raw_spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002089
Tejun Heoe22bee72010-06-29 10:07:14 +02002090 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002091 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002092
2093 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002094 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002095 break;
2096
Lai Jiangshane212f362014-06-03 15:32:17 +08002097 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002098
Tejun Heo63d95a92012-07-12 14:46:37 -07002099 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002100 break;
2101 }
2102
Tejun Heo63d95a92012-07-12 14:46:37 -07002103 del_timer_sync(&pool->mayday_timer);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002104 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002105 /*
2106 * This is necessary even after a new worker was just successfully
2107 * created as @pool->lock was dropped and the new worker might have
2108 * already become busy.
2109 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002110 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002111 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002112}
2113
2114/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002115 * manage_workers - manage worker pool
2116 * @worker: self
2117 *
Tejun Heo706026c2013-01-24 11:01:34 -08002118 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002119 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002120 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002121 *
2122 * The caller can safely start processing works on false return. On
2123 * true return, it's guaranteed that need_to_create_worker() is false
2124 * and may_start_working() is true.
2125 *
2126 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002127 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002128 * multiple times. Does GFP_KERNEL allocations.
2129 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002130 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002131 * %false if the pool doesn't need management and the caller can safely
2132 * start processing works, %true if management function was performed and
2133 * the conditions that the caller verified before calling the function may
2134 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002135 */
2136static bool manage_workers(struct worker *worker)
2137{
Tejun Heo63d95a92012-07-12 14:46:37 -07002138 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002139
Tejun Heo692b4822017-10-09 08:04:13 -07002140 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002141 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002142
2143 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002144 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002145
Tejun Heo29187a92015-01-16 14:21:16 -05002146 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002147
Tejun Heo2607d7a2015-03-09 09:22:28 -04002148 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002149 pool->flags &= ~POOL_MANAGER_ACTIVE;
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02002150 rcuwait_wake_up(&manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002151 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002152}
2153
Tejun Heoa62428c2010-06-29 10:07:10 +02002154/**
2155 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002156 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002157 * @work: work to process
2158 *
2159 * Process @work. This function contains all the logics necessary to
2160 * process a single work including synchronization against and
2161 * interaction with other workers on the same cpu, queueing and
2162 * flushing. As long as context requirement is met, any worker can
2163 * call this function to process a work.
2164 *
2165 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002166 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002167 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002168static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002169__releases(&pool->lock)
2170__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002171{
Tejun Heo112202d2013-02-13 19:29:12 -08002172 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002173 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002174 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002175 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002176 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002177#ifdef CONFIG_LOCKDEP
2178 /*
2179 * It is permissible to free the struct work_struct from
2180 * inside the function that is called from it, this we need to
2181 * take into account for lockdep too. To avoid bogus "held
2182 * lock freed" warnings as well as problems when looking into
2183 * work->lockdep_map, make a copy and use that here.
2184 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002185 struct lockdep_map lockdep_map;
2186
2187 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002188#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002189 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002190 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002191 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002192
Tejun Heo7e116292010-06-29 10:07:13 +02002193 /*
2194 * A single work shouldn't be executed concurrently by
2195 * multiple workers on a single cpu. Check whether anyone is
2196 * already processing the work. If so, defer the work to the
2197 * currently executing one.
2198 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002199 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002200 if (unlikely(collision)) {
2201 move_linked_works(work, &collision->scheduled, NULL);
2202 return;
2203 }
2204
Tejun Heo8930cab2012-08-03 10:30:45 -07002205 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002206 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002207 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002208 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002209 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002210 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002211 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002212
Tejun Heo8bf89592018-05-18 08:47:13 -07002213 /*
2214 * Record wq name for cmdline and debug reporting, may get
2215 * overridden through set_worker_desc().
2216 */
2217 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2218
Tejun Heoa62428c2010-06-29 10:07:10 +02002219 list_del_init(&work->entry);
2220
Tejun Heo649027d2010-06-29 10:07:14 +02002221 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002222 * CPU intensive works don't participate in concurrency management.
2223 * They're the scheduler's responsibility. This takes @worker out
2224 * of concurrency management and the next code block will chain
2225 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002226 */
2227 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002228 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002229
Tejun Heo974271c2012-07-12 14:46:37 -07002230 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002231 * Wake up another worker if necessary. The condition is always
2232 * false for normal per-cpu workers since nr_running would always
2233 * be >= 1 at this point. This is used to chain execution of the
2234 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002235 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002236 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002237 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002238 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002239
Tejun Heo8930cab2012-08-03 10:30:45 -07002240 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002241 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002242 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002243 * PENDING and queued state changes happen together while IRQ is
2244 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002245 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002246 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002247
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002248 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002249
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002250 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002251 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002252 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002253 * Strictly speaking we should mark the invariant state without holding
2254 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002255 *
2256 * However, that would result in:
2257 *
2258 * A(W1)
2259 * WFC(C)
2260 * A(W1)
2261 * C(C)
2262 *
2263 * Which would create W1->C->W1 dependencies, even though there is no
2264 * actual deadlock possible. There are two solutions, using a
2265 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002266 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002267 * these locks.
2268 *
2269 * AFAICT there is no possible deadlock scenario between the
2270 * flush_work() and complete() primitives (except for single-threaded
2271 * workqueues), so hiding them isn't a problem.
2272 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002273 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002274 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002275 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002276 /*
2277 * While we must be careful to not use "work" after this, the trace
2278 * point will only record its address.
2279 */
Daniel Jordan1c5da0e2020-01-13 17:52:39 -05002280 trace_workqueue_execute_end(work, worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002281 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002282 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002283
2284 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002285 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002286 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002287 current->comm, preempt_count(), task_pid_nr(current),
2288 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002289 debug_show_held_locks(current);
2290 dump_stack();
2291 }
2292
Tejun Heob22ce272013-08-28 17:33:37 -04002293 /*
Sebastian Andrzej Siewior025f50f2019-10-15 21:18:21 +02002294 * The following prevents a kworker from hogging CPU on !PREEMPTION
Tejun Heob22ce272013-08-28 17:33:37 -04002295 * kernels, where a requeueing work item waiting for something to
2296 * happen could deadlock with stop_machine as such work item could
2297 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002298 * stop_machine. At the same time, report a quiescent RCU state so
2299 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002300 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002301 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002302
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002303 raw_spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002304
Tejun Heofb0e7be2010-06-29 10:07:15 +02002305 /* clear cpu intensive status */
2306 if (unlikely(cpu_intensive))
2307 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2308
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002309 /* tag the worker for identification in schedule() */
2310 worker->last_func = worker->current_func;
2311
Tejun Heoa62428c2010-06-29 10:07:10 +02002312 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002313 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002314 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002315 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002316 worker->current_pwq = NULL;
2317 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002318}
2319
Tejun Heoaffee4b2010-06-29 10:07:12 +02002320/**
2321 * process_scheduled_works - process scheduled works
2322 * @worker: self
2323 *
2324 * Process all scheduled works. Please note that the scheduled list
2325 * may change while processing a work, so this function repeatedly
2326 * fetches a work from the top and executes it.
2327 *
2328 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002329 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002330 * multiple times.
2331 */
2332static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002334 while (!list_empty(&worker->scheduled)) {
2335 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002337 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339}
2340
Tejun Heo197f6ac2018-05-21 08:04:35 -07002341static void set_pf_worker(bool val)
2342{
2343 mutex_lock(&wq_pool_attach_mutex);
2344 if (val)
2345 current->flags |= PF_WQ_WORKER;
2346 else
2347 current->flags &= ~PF_WQ_WORKER;
2348 mutex_unlock(&wq_pool_attach_mutex);
2349}
2350
Tejun Heo4690c4a2010-06-29 10:07:10 +02002351/**
2352 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002353 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002354 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002355 * The worker thread function. All workers belong to a worker_pool -
2356 * either a per-cpu one or dynamic unbound one. These workers process all
2357 * work items regardless of their specific target workqueue. The only
2358 * exception is work items which belong to workqueues with a rescuer which
2359 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002360 *
2361 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002362 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002363static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364{
Tejun Heoc34056a2010-06-29 10:07:11 +02002365 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002366 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367
Tejun Heoe22bee72010-06-29 10:07:14 +02002368 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002369 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002370woke_up:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002371 raw_spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002372
Tejun Heoa9ab7752013-03-19 13:45:21 -07002373 /* am I supposed to die? */
2374 if (unlikely(worker->flags & WORKER_DIE)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002375 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002376 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002377 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002378
2379 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002380 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002381 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002382 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002383 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002385
Tejun Heoc8e55f32010-06-29 10:07:12 +02002386 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002387recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002388 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002389 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002390 goto sleep;
2391
2392 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002393 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002394 goto recheck;
2395
Tejun Heoc8e55f32010-06-29 10:07:12 +02002396 /*
2397 * ->scheduled list can only be filled while a worker is
2398 * preparing to process a work or actually processing it.
2399 * Make sure nobody diddled with it while I was sleeping.
2400 */
Tejun Heo6183c002013-03-12 11:29:57 -07002401 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002402
Tejun Heoe22bee72010-06-29 10:07:14 +02002403 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002404 * Finish PREP stage. We're guaranteed to have at least one idle
2405 * worker or that someone else has already assumed the manager
2406 * role. This is where @worker starts participating in concurrency
2407 * management if applicable and concurrency management is restored
2408 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002409 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002410 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002411
2412 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002413 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002414 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002415 struct work_struct, entry);
2416
Tejun Heo82607adc2015-12-08 11:28:04 -05002417 pool->watchdog_ts = jiffies;
2418
Tejun Heoc8e55f32010-06-29 10:07:12 +02002419 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2420 /* optimization path, not strictly necessary */
2421 process_one_work(worker, work);
2422 if (unlikely(!list_empty(&worker->scheduled)))
2423 process_scheduled_works(worker);
2424 } else {
2425 move_linked_works(work, &worker->scheduled, NULL);
2426 process_scheduled_works(worker);
2427 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002428 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002429
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002430 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002431sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002432 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002433 * pool->lock is held and there's no work to process and no need to
2434 * manage, sleep. Workers are woken up only while holding
2435 * pool->lock or from local cpu, so setting the current state
2436 * before releasing pool->lock is enough to prevent losing any
2437 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002438 */
2439 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002440 __set_current_state(TASK_IDLE);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002441 raw_spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002442 schedule();
2443 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444}
2445
Tejun Heoe22bee72010-06-29 10:07:14 +02002446/**
2447 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002448 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002449 *
2450 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002451 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002452 *
Tejun Heo706026c2013-01-24 11:01:34 -08002453 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002454 * worker which uses GFP_KERNEL allocation which has slight chance of
2455 * developing into deadlock if some works currently on the same queue
2456 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2457 * the problem rescuer solves.
2458 *
Tejun Heo706026c2013-01-24 11:01:34 -08002459 * When such condition is possible, the pool summons rescuers of all
2460 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002461 * those works so that forward progress can be guaranteed.
2462 *
2463 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002464 *
2465 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002466 */
Tejun Heo111c2252013-01-17 17:16:24 -08002467static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002468{
Tejun Heo111c2252013-01-17 17:16:24 -08002469 struct worker *rescuer = __rescuer;
2470 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002471 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002472 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002473
2474 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002475
2476 /*
2477 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2478 * doesn't participate in concurrency management.
2479 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002480 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002481repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002482 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002483
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002484 /*
2485 * By the time the rescuer is requested to stop, the workqueue
2486 * shouldn't have any work pending, but @wq->maydays may still have
2487 * pwq(s) queued. This can happen by non-rescuer workers consuming
2488 * all the work items before the rescuer got to them. Go through
2489 * @wq->maydays processing before acting on should_stop so that the
2490 * list is always empty on exit.
2491 */
2492 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002493
Tejun Heo493a1722013-03-12 11:29:59 -07002494 /* see whether any pwq is asking for help */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002495 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002496
2497 while (!list_empty(&wq->maydays)) {
2498 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2499 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002500 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002501 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002502 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002503
2504 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002505 list_del_init(&pwq->mayday_node);
2506
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002507 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002508
Lai Jiangshan51697d392014-05-20 17:46:36 +08002509 worker_attach_to_pool(rescuer, pool);
2510
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002511 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002512
2513 /*
2514 * Slurp in all works issued via this workqueue and
2515 * process'em.
2516 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002517 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002518 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2519 if (get_work_pwq(work) == pwq) {
2520 if (first)
2521 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002522 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002523 }
2524 first = false;
2525 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002526
NeilBrown008847f2014-12-08 12:39:16 -05002527 if (!list_empty(scheduled)) {
2528 process_scheduled_works(rescuer);
2529
2530 /*
2531 * The above execution of rescued work items could
2532 * have created more to rescue through
2533 * pwq_activate_first_delayed() or chained
2534 * queueing. Let's put @pwq back on mayday list so
2535 * that such back-to-back work items, which may be
2536 * being used to relieve memory pressure, don't
2537 * incur MAYDAY_INTERVAL delay inbetween.
2538 */
Lai Jiangshan4f3f4cf2020-05-29 06:58:59 +00002539 if (pwq->nr_active && need_to_create_worker(pool)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002540 raw_spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002541 /*
2542 * Queue iff we aren't racing destruction
2543 * and somebody else hasn't queued it already.
2544 */
2545 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2546 get_pwq(pwq);
2547 list_add_tail(&pwq->mayday_node, &wq->maydays);
2548 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002549 raw_spin_unlock(&wq_mayday_lock);
NeilBrown008847f2014-12-08 12:39:16 -05002550 }
2551 }
Tejun Heo75769582011-02-14 14:04:46 +01002552
2553 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002554 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002555 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002556 */
2557 put_pwq(pwq);
2558
2559 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002560 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002561 * regular worker; otherwise, we end up with 0 concurrency
2562 * and stalling the execution.
2563 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002564 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002565 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002566
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002567 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002568
Tejun Heoa2d812a2018-05-18 08:47:13 -07002569 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002570
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002571 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002572 }
2573
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002574 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002575
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002576 if (should_stop) {
2577 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002578 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002579 return 0;
2580 }
2581
Tejun Heo111c2252013-01-17 17:16:24 -08002582 /* rescuers should never participate in concurrency management */
2583 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002584 schedule();
2585 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586}
2587
Tejun Heofca839c2015-12-07 10:58:57 -05002588/**
2589 * check_flush_dependency - check for flush dependency sanity
2590 * @target_wq: workqueue being flushed
2591 * @target_work: work item being flushed (NULL for workqueue flushes)
2592 *
2593 * %current is trying to flush the whole @target_wq or @target_work on it.
2594 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2595 * reclaiming memory or running on a workqueue which doesn't have
2596 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2597 * a deadlock.
2598 */
2599static void check_flush_dependency(struct workqueue_struct *target_wq,
2600 struct work_struct *target_work)
2601{
2602 work_func_t target_func = target_work ? target_work->func : NULL;
2603 struct worker *worker;
2604
2605 if (target_wq->flags & WQ_MEM_RECLAIM)
2606 return;
2607
2608 worker = current_wq_worker();
2609
2610 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002611 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002612 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002613 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2614 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002615 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002616 worker->current_pwq->wq->name, worker->current_func,
2617 target_wq->name, target_func);
2618}
2619
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002620struct wq_barrier {
2621 struct work_struct work;
2622 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002623 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002624};
2625
2626static void wq_barrier_func(struct work_struct *work)
2627{
2628 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2629 complete(&barr->done);
2630}
2631
Tejun Heo4690c4a2010-06-29 10:07:10 +02002632/**
2633 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002634 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002635 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002636 * @target: target work to attach @barr to
2637 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002638 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002639 * @barr is linked to @target such that @barr is completed only after
2640 * @target finishes execution. Please note that the ordering
2641 * guarantee is observed only with respect to @target and on the local
2642 * cpu.
2643 *
2644 * Currently, a queued barrier can't be canceled. This is because
2645 * try_to_grab_pending() can't determine whether the work to be
2646 * grabbed is at the head of the queue and thus can't clear LINKED
2647 * flag of the previous work while there must be a valid next work
2648 * after a work with LINKED flag set.
2649 *
2650 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002651 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002652 *
2653 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002654 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002655 */
Tejun Heo112202d2013-02-13 19:29:12 -08002656static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002657 struct wq_barrier *barr,
2658 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002659{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002660 struct list_head *head;
2661 unsigned int linked = 0;
2662
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002663 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002664 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002665 * as we know for sure that this will not trigger any of the
2666 * checks and call back into the fixup functions where we
2667 * might deadlock.
2668 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002669 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002670 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002671
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002672 init_completion_map(&barr->done, &target->lockdep_map);
2673
Tejun Heo2607d7a2015-03-09 09:22:28 -04002674 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002675
Tejun Heoaffee4b2010-06-29 10:07:12 +02002676 /*
2677 * If @target is currently being executed, schedule the
2678 * barrier to the worker; otherwise, put it after @target.
2679 */
2680 if (worker)
2681 head = worker->scheduled.next;
2682 else {
2683 unsigned long *bits = work_data_bits(target);
2684
2685 head = target->entry.next;
2686 /* there can already be other linked works, inherit and set */
2687 linked = *bits & WORK_STRUCT_LINKED;
2688 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2689 }
2690
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002691 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002692 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002693 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002694}
2695
Tejun Heo73f53c42010-06-29 10:07:11 +02002696/**
Tejun Heo112202d2013-02-13 19:29:12 -08002697 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002698 * @wq: workqueue being flushed
2699 * @flush_color: new flush color, < 0 for no-op
2700 * @work_color: new work color, < 0 for no-op
2701 *
Tejun Heo112202d2013-02-13 19:29:12 -08002702 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002703 *
Tejun Heo112202d2013-02-13 19:29:12 -08002704 * If @flush_color is non-negative, flush_color on all pwqs should be
2705 * -1. If no pwq has in-flight commands at the specified color, all
2706 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2707 * has in flight commands, its pwq->flush_color is set to
2708 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002709 * wakeup logic is armed and %true is returned.
2710 *
2711 * The caller should have initialized @wq->first_flusher prior to
2712 * calling this function with non-negative @flush_color. If
2713 * @flush_color is negative, no flush color update is done and %false
2714 * is returned.
2715 *
Tejun Heo112202d2013-02-13 19:29:12 -08002716 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002717 * work_color which is previous to @work_color and all will be
2718 * advanced to @work_color.
2719 *
2720 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002721 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002722 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002723 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002724 * %true if @flush_color >= 0 and there's something to flush. %false
2725 * otherwise.
2726 */
Tejun Heo112202d2013-02-13 19:29:12 -08002727static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002728 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729{
Tejun Heo73f53c42010-06-29 10:07:11 +02002730 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002731 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002732
Tejun Heo73f53c42010-06-29 10:07:11 +02002733 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002734 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002735 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002736 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002737
Tejun Heo49e3cf42013-03-12 11:29:58 -07002738 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002739 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002740
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002741 raw_spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002742
2743 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002744 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002745
Tejun Heo112202d2013-02-13 19:29:12 -08002746 if (pwq->nr_in_flight[flush_color]) {
2747 pwq->flush_color = flush_color;
2748 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002749 wait = true;
2750 }
2751 }
2752
2753 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002754 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002755 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002756 }
2757
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002758 raw_spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002759 }
2760
Tejun Heo112202d2013-02-13 19:29:12 -08002761 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002762 complete(&wq->first_flusher->done);
2763
2764 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765}
2766
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002767/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002769 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002771 * This function sleeps until all work items which were queued on entry
2772 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002774void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775{
Tejun Heo73f53c42010-06-29 10:07:11 +02002776 struct wq_flusher this_flusher = {
2777 .list = LIST_HEAD_INIT(this_flusher.list),
2778 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002779 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002780 };
2781 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002782
Tejun Heo3347fa02016-09-16 15:49:32 -04002783 if (WARN_ON(!wq_online))
2784 return;
2785
Johannes Berg87915ad2018-08-22 11:49:04 +02002786 lock_map_acquire(&wq->lockdep_map);
2787 lock_map_release(&wq->lockdep_map);
2788
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002789 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002790
2791 /*
2792 * Start-to-wait phase
2793 */
2794 next_color = work_next_color(wq->work_color);
2795
2796 if (next_color != wq->flush_color) {
2797 /*
2798 * Color space is not full. The current work_color
2799 * becomes our flush_color and work_color is advanced
2800 * by one.
2801 */
Tejun Heo6183c002013-03-12 11:29:57 -07002802 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002803 this_flusher.flush_color = wq->work_color;
2804 wq->work_color = next_color;
2805
2806 if (!wq->first_flusher) {
2807 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002808 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002809
2810 wq->first_flusher = &this_flusher;
2811
Tejun Heo112202d2013-02-13 19:29:12 -08002812 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002813 wq->work_color)) {
2814 /* nothing to flush, done */
2815 wq->flush_color = next_color;
2816 wq->first_flusher = NULL;
2817 goto out_unlock;
2818 }
2819 } else {
2820 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002821 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002822 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002823 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002824 }
2825 } else {
2826 /*
2827 * Oops, color space is full, wait on overflow queue.
2828 * The next flush completion will assign us
2829 * flush_color and transfer to flusher_queue.
2830 */
2831 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2832 }
2833
Tejun Heofca839c2015-12-07 10:58:57 -05002834 check_flush_dependency(wq, NULL);
2835
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002836 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002837
2838 wait_for_completion(&this_flusher.done);
2839
2840 /*
2841 * Wake-up-and-cascade phase
2842 *
2843 * First flushers are responsible for cascading flushes and
2844 * handling overflow. Non-first flushers can simply return.
2845 */
Chris Wilson00d5d152020-03-10 16:23:19 +00002846 if (READ_ONCE(wq->first_flusher) != &this_flusher)
Tejun Heo73f53c42010-06-29 10:07:11 +02002847 return;
2848
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002849 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002850
Tejun Heo4ce48b32010-07-02 10:03:51 +02002851 /* we might have raced, check again with mutex held */
2852 if (wq->first_flusher != &this_flusher)
2853 goto out_unlock;
2854
Chris Wilson00d5d152020-03-10 16:23:19 +00002855 WRITE_ONCE(wq->first_flusher, NULL);
Tejun Heo73f53c42010-06-29 10:07:11 +02002856
Tejun Heo6183c002013-03-12 11:29:57 -07002857 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2858 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002859
2860 while (true) {
2861 struct wq_flusher *next, *tmp;
2862
2863 /* complete all the flushers sharing the current flush color */
2864 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2865 if (next->flush_color != wq->flush_color)
2866 break;
2867 list_del_init(&next->list);
2868 complete(&next->done);
2869 }
2870
Tejun Heo6183c002013-03-12 11:29:57 -07002871 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2872 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002873
2874 /* this flush_color is finished, advance by one */
2875 wq->flush_color = work_next_color(wq->flush_color);
2876
2877 /* one color has been freed, handle overflow queue */
2878 if (!list_empty(&wq->flusher_overflow)) {
2879 /*
2880 * Assign the same color to all overflowed
2881 * flushers, advance work_color and append to
2882 * flusher_queue. This is the start-to-wait
2883 * phase for these overflowed flushers.
2884 */
2885 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2886 tmp->flush_color = wq->work_color;
2887
2888 wq->work_color = work_next_color(wq->work_color);
2889
2890 list_splice_tail_init(&wq->flusher_overflow,
2891 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002892 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002893 }
2894
2895 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002896 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002897 break;
2898 }
2899
2900 /*
2901 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002902 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002903 */
Tejun Heo6183c002013-03-12 11:29:57 -07002904 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2905 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002906
2907 list_del_init(&next->list);
2908 wq->first_flusher = next;
2909
Tejun Heo112202d2013-02-13 19:29:12 -08002910 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002911 break;
2912
2913 /*
2914 * Meh... this color is already done, clear first
2915 * flusher and repeat cascading.
2916 */
2917 wq->first_flusher = NULL;
2918 }
2919
2920out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002921 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002922}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002923EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002925/**
2926 * drain_workqueue - drain a workqueue
2927 * @wq: workqueue to drain
2928 *
2929 * Wait until the workqueue becomes empty. While draining is in progress,
2930 * only chain queueing is allowed. IOW, only currently pending or running
2931 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002932 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002933 * by the depth of chaining and should be relatively short. Whine if it
2934 * takes too long.
2935 */
2936void drain_workqueue(struct workqueue_struct *wq)
2937{
2938 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002939 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002940
2941 /*
2942 * __queue_work() needs to test whether there are drainers, is much
2943 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002944 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002945 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002946 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002947 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002948 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002949 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002950reflush:
2951 flush_workqueue(wq);
2952
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002953 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002954
Tejun Heo49e3cf42013-03-12 11:29:58 -07002955 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002956 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002957
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002958 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002959 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002960 raw_spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002961
2962 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002963 continue;
2964
2965 if (++flush_cnt == 10 ||
2966 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Stephen Zhange9ad2eb2021-01-23 16:04:00 +08002967 pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
2968 wq->name, __func__, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002969
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002970 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002971 goto reflush;
2972 }
2973
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002974 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002975 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002976 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002977}
2978EXPORT_SYMBOL_GPL(drain_workqueue);
2979
Johannes Bergd6e89782018-08-22 11:49:03 +02002980static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2981 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002982{
2983 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002984 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002985 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002986
2987 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002988
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002989 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002990 pool = get_work_pool(work);
2991 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002992 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002993 return false;
2994 }
2995
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002996 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002997 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002998 pwq = get_work_pwq(work);
2999 if (pwq) {
3000 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02003001 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07003002 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003003 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003004 if (!worker)
3005 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003006 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003007 }
Tejun Heobaf59022010-09-16 10:42:16 +02003008
Tejun Heofca839c2015-12-07 10:58:57 -05003009 check_flush_dependency(pwq->wq, work);
3010
Tejun Heo112202d2013-02-13 19:29:12 -08003011 insert_wq_barrier(pwq, barr, work, worker);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003012 raw_spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003013
Tejun Heoe159489b2011-01-09 23:32:15 +01003014 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003015 * Force a lock recursion deadlock when using flush_work() inside a
3016 * single-threaded or rescuer equipped workqueue.
3017 *
3018 * For single threaded workqueues the deadlock happens when the work
3019 * is after the work issuing the flush_work(). For rescuer equipped
3020 * workqueues the deadlock happens when the rescuer stalls, blocking
3021 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003022 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003023 if (!from_cancel &&
3024 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003025 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003026 lock_map_release(&pwq->wq->lockdep_map);
3027 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003028 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003029 return true;
3030already_gone:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003031 raw_spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003032 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003033 return false;
3034}
3035
Johannes Bergd6e89782018-08-22 11:49:03 +02003036static bool __flush_work(struct work_struct *work, bool from_cancel)
3037{
3038 struct wq_barrier barr;
3039
3040 if (WARN_ON(!wq_online))
3041 return false;
3042
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003043 if (WARN_ON(!work->func))
3044 return false;
3045
Johannes Berg87915ad2018-08-22 11:49:04 +02003046 if (!from_cancel) {
3047 lock_map_acquire(&work->lockdep_map);
3048 lock_map_release(&work->lockdep_map);
3049 }
3050
Johannes Bergd6e89782018-08-22 11:49:03 +02003051 if (start_flush_work(work, &barr, from_cancel)) {
3052 wait_for_completion(&barr.done);
3053 destroy_work_on_stack(&barr.work);
3054 return true;
3055 } else {
3056 return false;
3057 }
3058}
3059
Oleg Nesterovdb700892008-07-25 01:47:49 -07003060/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003061 * flush_work - wait for a work to finish executing the last queueing instance
3062 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003063 *
Tejun Heo606a5022012-08-20 14:51:23 -07003064 * Wait until @work has finished execution. @work is guaranteed to be idle
3065 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003066 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003067 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003068 * %true if flush_work() waited for the work to finish execution,
3069 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003070 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003071bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003072{
Johannes Bergd6e89782018-08-22 11:49:03 +02003073 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003074}
3075EXPORT_SYMBOL_GPL(flush_work);
3076
Tejun Heo8603e1b32015-03-05 08:04:13 -05003077struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003078 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003079 struct work_struct *work;
3080};
3081
Ingo Molnarac6424b2017-06-20 12:06:13 +02003082static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003083{
3084 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3085
3086 if (cwait->work != key)
3087 return 0;
3088 return autoremove_wake_function(wait, mode, sync, key);
3089}
3090
Tejun Heo36e227d2012-08-03 10:30:46 -07003091static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003092{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003093 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003094 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003095 int ret;
3096
3097 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003098 ret = try_to_grab_pending(work, is_dwork, &flags);
3099 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003100 * If someone else is already canceling, wait for it to
3101 * finish. flush_work() doesn't work for PREEMPT_NONE
3102 * because we may get scheduled between @work's completion
3103 * and the other canceling task resuming and clearing
3104 * CANCELING - flush_work() will return false immediately
3105 * as @work is no longer busy, try_to_grab_pending() will
3106 * return -ENOENT as @work is still being canceled and the
3107 * other canceling task won't be able to clear CANCELING as
3108 * we're hogging the CPU.
3109 *
3110 * Let's wait for completion using a waitqueue. As this
3111 * may lead to the thundering herd problem, use a custom
3112 * wake function which matches @work along with exclusive
3113 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003114 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003115 if (unlikely(ret == -ENOENT)) {
3116 struct cwt_wait cwait;
3117
3118 init_wait(&cwait.wait);
3119 cwait.wait.func = cwt_wakefn;
3120 cwait.work = work;
3121
3122 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3123 TASK_UNINTERRUPTIBLE);
3124 if (work_is_canceling(work))
3125 schedule();
3126 finish_wait(&cancel_waitq, &cwait.wait);
3127 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003128 } while (unlikely(ret < 0));
3129
Tejun Heobbb68df2012-08-03 10:30:46 -07003130 /* tell other tasks trying to grab @work to back off */
3131 mark_work_canceling(work);
3132 local_irq_restore(flags);
3133
Tejun Heo3347fa02016-09-16 15:49:32 -04003134 /*
3135 * This allows canceling during early boot. We know that @work
3136 * isn't executing.
3137 */
3138 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003139 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003140
Tejun Heo7a22ad72010-06-29 10:07:13 +02003141 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003142
3143 /*
3144 * Paired with prepare_to_wait() above so that either
3145 * waitqueue_active() is visible here or !work_is_canceling() is
3146 * visible there.
3147 */
3148 smp_mb();
3149 if (waitqueue_active(&cancel_waitq))
3150 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3151
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003152 return ret;
3153}
3154
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003155/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003156 * cancel_work_sync - cancel a work and wait for it to finish
3157 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003158 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003159 * Cancel @work and wait for its execution to finish. This function
3160 * can be used even if the work re-queues itself or migrates to
3161 * another workqueue. On return from this function, @work is
3162 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003163 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003164 * cancel_work_sync(&delayed_work->work) must not be used for
3165 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003166 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003167 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003168 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003169 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003170 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003171 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003172 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003173bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003174{
Tejun Heo36e227d2012-08-03 10:30:46 -07003175 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003176}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003177EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003178
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003179/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003180 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3181 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003182 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003183 * Delayed timer is cancelled and the pending work is queued for
3184 * immediate execution. Like flush_work(), this function only
3185 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003186 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003187 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003188 * %true if flush_work() waited for the work to finish execution,
3189 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003190 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003191bool flush_delayed_work(struct delayed_work *dwork)
3192{
Tejun Heo8930cab2012-08-03 10:30:45 -07003193 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003194 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003195 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003196 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003197 return flush_work(&dwork->work);
3198}
3199EXPORT_SYMBOL(flush_delayed_work);
3200
Tejun Heo05f0fe62018-03-14 12:45:13 -07003201/**
3202 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3203 * @rwork: the rcu work to flush
3204 *
3205 * Return:
3206 * %true if flush_rcu_work() waited for the work to finish execution,
3207 * %false if it was already idle.
3208 */
3209bool flush_rcu_work(struct rcu_work *rwork)
3210{
3211 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3212 rcu_barrier();
3213 flush_work(&rwork->work);
3214 return true;
3215 } else {
3216 return flush_work(&rwork->work);
3217 }
3218}
3219EXPORT_SYMBOL(flush_rcu_work);
3220
Jens Axboef72b8792016-08-24 15:51:50 -06003221static bool __cancel_work(struct work_struct *work, bool is_dwork)
3222{
3223 unsigned long flags;
3224 int ret;
3225
3226 do {
3227 ret = try_to_grab_pending(work, is_dwork, &flags);
3228 } while (unlikely(ret == -EAGAIN));
3229
3230 if (unlikely(ret < 0))
3231 return false;
3232
3233 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3234 local_irq_restore(flags);
3235 return ret;
3236}
3237
Tejun Heo401a8d02010-09-16 10:36:00 +02003238/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003239 * cancel_delayed_work - cancel a delayed work
3240 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003241 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003242 * Kill off a pending delayed_work.
3243 *
3244 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3245 * pending.
3246 *
3247 * Note:
3248 * The work callback function may still be running on return, unless
3249 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3250 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003251 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003252 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003253 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003254bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003255{
Jens Axboef72b8792016-08-24 15:51:50 -06003256 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003257}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003258EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003259
3260/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003261 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3262 * @dwork: the delayed work cancel
3263 *
3264 * This is cancel_work_sync() for delayed works.
3265 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003266 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003267 * %true if @dwork was pending, %false otherwise.
3268 */
3269bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003270{
Tejun Heo36e227d2012-08-03 10:30:46 -07003271 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003272}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003273EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003275/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003276 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003277 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003278 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003279 * schedule_on_each_cpu() executes @func on each online CPU using the
3280 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003281 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003282 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003283 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003284 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003285 */
David Howells65f27f32006-11-22 14:55:48 +00003286int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003287{
3288 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003289 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003290
Andrew Mortonb6136772006-06-25 05:47:49 -07003291 works = alloc_percpu(struct work_struct);
3292 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003293 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003294
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003295 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003296
Christoph Lameter15316ba2006-01-08 01:00:43 -08003297 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003298 struct work_struct *work = per_cpu_ptr(works, cpu);
3299
3300 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003301 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003302 }
Tejun Heo93981802009-11-17 14:06:20 -08003303
3304 for_each_online_cpu(cpu)
3305 flush_work(per_cpu_ptr(works, cpu));
3306
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003307 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003308 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003309 return 0;
3310}
3311
Alan Sterneef6a7d2010-02-12 17:39:21 +09003312/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003313 * execute_in_process_context - reliably execute the routine with user context
3314 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003315 * @ew: guaranteed storage for the execute work structure (must
3316 * be available when the work executes)
3317 *
3318 * Executes the function immediately if process context is available,
3319 * otherwise schedules the function for delayed execution.
3320 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003321 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003322 * 1 - function was scheduled for execution
3323 */
David Howells65f27f32006-11-22 14:55:48 +00003324int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003325{
3326 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003327 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003328 return 0;
3329 }
3330
David Howells65f27f32006-11-22 14:55:48 +00003331 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003332 schedule_work(&ew->work);
3333
3334 return 1;
3335}
3336EXPORT_SYMBOL_GPL(execute_in_process_context);
3337
Tejun Heo7a4e3442013-03-12 11:30:00 -07003338/**
3339 * free_workqueue_attrs - free a workqueue_attrs
3340 * @attrs: workqueue_attrs to free
3341 *
3342 * Undo alloc_workqueue_attrs().
3343 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003344void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003345{
3346 if (attrs) {
3347 free_cpumask_var(attrs->cpumask);
3348 kfree(attrs);
3349 }
3350}
3351
3352/**
3353 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003354 *
3355 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003356 * return it.
3357 *
3358 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003359 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003360struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003361{
3362 struct workqueue_attrs *attrs;
3363
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003364 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003365 if (!attrs)
3366 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003367 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003368 goto fail;
3369
Tejun Heo13e2e552013-04-01 11:23:31 -07003370 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003371 return attrs;
3372fail:
3373 free_workqueue_attrs(attrs);
3374 return NULL;
3375}
3376
Tejun Heo29c91e92013-03-12 11:30:03 -07003377static void copy_workqueue_attrs(struct workqueue_attrs *to,
3378 const struct workqueue_attrs *from)
3379{
3380 to->nice = from->nice;
3381 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003382 /*
3383 * Unlike hash and equality test, this function doesn't ignore
3384 * ->no_numa as it is used for both pool and wq attrs. Instead,
3385 * get_unbound_pool() explicitly clears ->no_numa after copying.
3386 */
3387 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003388}
3389
Tejun Heo29c91e92013-03-12 11:30:03 -07003390/* hash value of the content of @attr */
3391static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3392{
3393 u32 hash = 0;
3394
3395 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003396 hash = jhash(cpumask_bits(attrs->cpumask),
3397 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003398 return hash;
3399}
3400
3401/* content equality test */
3402static bool wqattrs_equal(const struct workqueue_attrs *a,
3403 const struct workqueue_attrs *b)
3404{
3405 if (a->nice != b->nice)
3406 return false;
3407 if (!cpumask_equal(a->cpumask, b->cpumask))
3408 return false;
3409 return true;
3410}
3411
Tejun Heo7a4e3442013-03-12 11:30:00 -07003412/**
3413 * init_worker_pool - initialize a newly zalloc'd worker_pool
3414 * @pool: worker_pool to initialize
3415 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303416 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003417 *
3418 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003419 * inside @pool proper are initialized and put_unbound_pool() can be called
3420 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003421 */
3422static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003423{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003424 raw_spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003425 pool->id = -1;
3426 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003427 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003428 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003429 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003430 INIT_LIST_HEAD(&pool->worklist);
3431 INIT_LIST_HEAD(&pool->idle_list);
3432 hash_init(pool->busy_hash);
3433
Kees Cook32a6c722017-10-16 15:58:25 -07003434 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003435
Kees Cook32a6c722017-10-16 15:58:25 -07003436 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003437
Lai Jiangshanda028462014-05-20 17:46:31 +08003438 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003439
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003440 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003441 INIT_HLIST_NODE(&pool->hash_node);
3442 pool->refcnt = 1;
3443
3444 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003445 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003446 if (!pool->attrs)
3447 return -ENOMEM;
3448 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003449}
3450
Bart Van Assche669de8b2019-02-14 15:00:54 -08003451#ifdef CONFIG_LOCKDEP
3452static void wq_init_lockdep(struct workqueue_struct *wq)
3453{
3454 char *lock_name;
3455
3456 lockdep_register_key(&wq->key);
3457 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3458 if (!lock_name)
3459 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003460
3461 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003462 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3463}
3464
3465static void wq_unregister_lockdep(struct workqueue_struct *wq)
3466{
3467 lockdep_unregister_key(&wq->key);
3468}
3469
3470static void wq_free_lockdep(struct workqueue_struct *wq)
3471{
3472 if (wq->lock_name != wq->name)
3473 kfree(wq->lock_name);
3474}
3475#else
3476static void wq_init_lockdep(struct workqueue_struct *wq)
3477{
3478}
3479
3480static void wq_unregister_lockdep(struct workqueue_struct *wq)
3481{
3482}
3483
3484static void wq_free_lockdep(struct workqueue_struct *wq)
3485{
3486}
3487#endif
3488
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003489static void rcu_free_wq(struct rcu_head *rcu)
3490{
3491 struct workqueue_struct *wq =
3492 container_of(rcu, struct workqueue_struct, rcu);
3493
Bart Van Assche669de8b2019-02-14 15:00:54 -08003494 wq_free_lockdep(wq);
3495
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003496 if (!(wq->flags & WQ_UNBOUND))
3497 free_percpu(wq->cpu_pwqs);
3498 else
3499 free_workqueue_attrs(wq->unbound_attrs);
3500
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003501 kfree(wq);
3502}
3503
Tejun Heo29c91e92013-03-12 11:30:03 -07003504static void rcu_free_pool(struct rcu_head *rcu)
3505{
3506 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3507
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003508 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003509 free_workqueue_attrs(pool->attrs);
3510 kfree(pool);
3511}
3512
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003513/* This returns with the lock held on success (pool manager is inactive). */
3514static bool wq_manager_inactive(struct worker_pool *pool)
3515{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003516 raw_spin_lock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003517
3518 if (pool->flags & POOL_MANAGER_ACTIVE) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003519 raw_spin_unlock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003520 return false;
3521 }
3522 return true;
3523}
3524
Tejun Heo29c91e92013-03-12 11:30:03 -07003525/**
3526 * put_unbound_pool - put a worker_pool
3527 * @pool: worker_pool to put
3528 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003529 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003530 * safe manner. get_unbound_pool() calls this function on its failure path
3531 * and this function should be able to release pools which went through,
3532 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003533 *
3534 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003535 */
3536static void put_unbound_pool(struct worker_pool *pool)
3537{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003538 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003539 struct worker *worker;
3540
Tejun Heoa892cac2013-04-01 11:23:32 -07003541 lockdep_assert_held(&wq_pool_mutex);
3542
3543 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003544 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003545
3546 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003547 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003548 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003549 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003550
3551 /* release id and unhash */
3552 if (pool->id >= 0)
3553 idr_remove(&worker_pool_idr, pool->id);
3554 hash_del(&pool->hash_node);
3555
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003556 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003557 * Become the manager and destroy all workers. This prevents
3558 * @pool's workers from blocking on attach_mutex. We're the last
3559 * manager and @pool gets freed with the flag set.
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003560 * Because of how wq_manager_inactive() works, we will hold the
3561 * spinlock after a successful wait.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003562 */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003563 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3564 TASK_UNINTERRUPTIBLE);
Tejun Heo692b4822017-10-09 08:04:13 -07003565 pool->flags |= POOL_MANAGER_ACTIVE;
3566
Lai Jiangshan1037de32014-05-22 16:44:07 +08003567 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003568 destroy_worker(worker);
3569 WARN_ON(pool->nr_workers || pool->nr_idle);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003570 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003571
Tejun Heo1258fae2018-05-18 08:47:13 -07003572 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003573 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003574 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003575 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003576
3577 if (pool->detach_completion)
3578 wait_for_completion(pool->detach_completion);
3579
Tejun Heo29c91e92013-03-12 11:30:03 -07003580 /* shut down the timers */
3581 del_timer_sync(&pool->idle_timer);
3582 del_timer_sync(&pool->mayday_timer);
3583
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003584 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003585 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003586}
3587
3588/**
3589 * get_unbound_pool - get a worker_pool with the specified attributes
3590 * @attrs: the attributes of the worker_pool to get
3591 *
3592 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3593 * reference count and return it. If there already is a matching
3594 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003595 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003596 *
3597 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003598 *
3599 * Return: On success, a worker_pool with the same attributes as @attrs.
3600 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003601 */
3602static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3603{
Tejun Heo29c91e92013-03-12 11:30:03 -07003604 u32 hash = wqattrs_hash(attrs);
3605 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003606 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003607 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003608
Tejun Heoa892cac2013-04-01 11:23:32 -07003609 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003610
3611 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003612 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3613 if (wqattrs_equal(pool->attrs, attrs)) {
3614 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003615 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003616 }
3617 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003618
Xunlei Pange22735842015-10-09 11:53:12 +08003619 /* if cpumask is contained inside a NUMA node, we belong to that node */
3620 if (wq_numa_enabled) {
3621 for_each_node(node) {
3622 if (cpumask_subset(attrs->cpumask,
3623 wq_numa_possible_cpumask[node])) {
3624 target_node = node;
3625 break;
3626 }
3627 }
3628 }
3629
Tejun Heo29c91e92013-03-12 11:30:03 -07003630 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003631 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003632 if (!pool || init_worker_pool(pool) < 0)
3633 goto fail;
3634
Tejun Heo8864b4e2013-03-12 11:30:04 -07003635 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003636 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003637 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003638
Shaohua Li2865a8f2013-08-01 09:56:36 +08003639 /*
3640 * no_numa isn't a worker_pool attribute, always clear it. See
3641 * 'struct workqueue_attrs' comments for detail.
3642 */
3643 pool->attrs->no_numa = false;
3644
Tejun Heo29c91e92013-03-12 11:30:03 -07003645 if (worker_pool_assign_id(pool) < 0)
3646 goto fail;
3647
3648 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003649 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003650 goto fail;
3651
Tejun Heo29c91e92013-03-12 11:30:03 -07003652 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003653 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003654
Tejun Heo29c91e92013-03-12 11:30:03 -07003655 return pool;
3656fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003657 if (pool)
3658 put_unbound_pool(pool);
3659 return NULL;
3660}
3661
Tejun Heo8864b4e2013-03-12 11:30:04 -07003662static void rcu_free_pwq(struct rcu_head *rcu)
3663{
3664 kmem_cache_free(pwq_cache,
3665 container_of(rcu, struct pool_workqueue, rcu));
3666}
3667
3668/*
3669 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3670 * and needs to be destroyed.
3671 */
3672static void pwq_unbound_release_workfn(struct work_struct *work)
3673{
3674 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3675 unbound_release_work);
3676 struct workqueue_struct *wq = pwq->wq;
3677 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003678 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003679
3680 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3681 return;
3682
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003683 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003684 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003685 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003686 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003687
Tejun Heoa892cac2013-04-01 11:23:32 -07003688 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003689 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003690 mutex_unlock(&wq_pool_mutex);
3691
Paul E. McKenney25b00772018-11-06 19:18:45 -08003692 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003693
3694 /*
3695 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003696 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003697 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003698 if (is_last) {
3699 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003700 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003701 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003702}
3703
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003704/**
Tejun Heo699ce092013-03-13 16:51:35 -07003705 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003706 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003707 *
Tejun Heo699ce092013-03-13 16:51:35 -07003708 * If @pwq isn't freezing, set @pwq->max_active to the associated
3709 * workqueue's saved_max_active and activate delayed work items
3710 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003711 */
Tejun Heo699ce092013-03-13 16:51:35 -07003712static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003713{
Tejun Heo699ce092013-03-13 16:51:35 -07003714 struct workqueue_struct *wq = pwq->wq;
3715 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003716 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003717
Tejun Heo699ce092013-03-13 16:51:35 -07003718 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003719 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003720
3721 /* fast exit for non-freezable wqs */
3722 if (!freezable && pwq->max_active == wq->saved_max_active)
3723 return;
3724
Tejun Heo3347fa02016-09-16 15:49:32 -04003725 /* this function can be called during early boot w/ irq disabled */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003726 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003727
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003728 /*
3729 * During [un]freezing, the caller is responsible for ensuring that
3730 * this function is called at least once after @workqueue_freezing
3731 * is updated and visible.
3732 */
3733 if (!freezable || !workqueue_freezing) {
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003734 bool kick = false;
3735
Tejun Heo699ce092013-03-13 16:51:35 -07003736 pwq->max_active = wq->saved_max_active;
3737
3738 while (!list_empty(&pwq->delayed_works) &&
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003739 pwq->nr_active < pwq->max_active) {
Tejun Heo699ce092013-03-13 16:51:35 -07003740 pwq_activate_first_delayed(pwq);
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003741 kick = true;
3742 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003743
3744 /*
3745 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003746 * max_active is bumped. In realtime scenarios, always kicking a
3747 * worker will cause interference on the isolated cpu cores, so
3748 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003749 */
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003750 if (kick)
3751 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003752 } else {
3753 pwq->max_active = 0;
3754 }
3755
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003756 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003757}
3758
Tejun Heoe50aba92013-04-01 11:23:35 -07003759/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003760static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3761 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003762{
3763 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3764
Tejun Heoe50aba92013-04-01 11:23:35 -07003765 memset(pwq, 0, sizeof(*pwq));
3766
Tejun Heod2c1d402013-03-12 11:30:04 -07003767 pwq->pool = pool;
3768 pwq->wq = wq;
3769 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003770 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003771 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003772 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003773 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003774 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003775}
Tejun Heod2c1d402013-03-12 11:30:04 -07003776
Tejun Heof147f292013-04-01 11:23:35 -07003777/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003778static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003779{
3780 struct workqueue_struct *wq = pwq->wq;
3781
3782 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003783
Tejun Heo1befcf32013-04-01 11:23:35 -07003784 /* may be called multiple times, ignore if already linked */
3785 if (!list_empty(&pwq->pwqs_node))
3786 return;
3787
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003788 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003789 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003790
3791 /* sync max_active to the current setting */
3792 pwq_adjust_max_active(pwq);
3793
3794 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003795 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003796}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003797
Tejun Heof147f292013-04-01 11:23:35 -07003798/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3799static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3800 const struct workqueue_attrs *attrs)
3801{
3802 struct worker_pool *pool;
3803 struct pool_workqueue *pwq;
3804
3805 lockdep_assert_held(&wq_pool_mutex);
3806
3807 pool = get_unbound_pool(attrs);
3808 if (!pool)
3809 return NULL;
3810
Tejun Heoe50aba92013-04-01 11:23:35 -07003811 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003812 if (!pwq) {
3813 put_unbound_pool(pool);
3814 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003815 }
Tejun Heo6029a912013-04-01 11:23:34 -07003816
Tejun Heof147f292013-04-01 11:23:35 -07003817 init_pwq(pwq, wq, pool);
3818 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003819}
3820
Tejun Heo4c16bd32013-04-01 11:23:36 -07003821/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003822 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003823 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003824 * @node: the target NUMA node
3825 * @cpu_going_down: if >= 0, the CPU to consider as offline
3826 * @cpumask: outarg, the resulting cpumask
3827 *
3828 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3829 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003830 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003831 *
3832 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3833 * enabled and @node has online CPUs requested by @attrs, the returned
3834 * cpumask is the intersection of the possible CPUs of @node and
3835 * @attrs->cpumask.
3836 *
3837 * The caller is responsible for ensuring that the cpumask of @node stays
3838 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003839 *
3840 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3841 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003842 */
3843static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3844 int cpu_going_down, cpumask_t *cpumask)
3845{
Tejun Heod55262c2013-04-01 11:23:38 -07003846 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003847 goto use_dfl;
3848
3849 /* does @node have any online CPUs @attrs wants? */
3850 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3851 if (cpu_going_down >= 0)
3852 cpumask_clear_cpu(cpu_going_down, cpumask);
3853
3854 if (cpumask_empty(cpumask))
3855 goto use_dfl;
3856
3857 /* yeap, return possible CPUs in @node that @attrs wants */
3858 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003859
3860 if (cpumask_empty(cpumask)) {
3861 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3862 "possible intersect\n");
3863 return false;
3864 }
3865
Tejun Heo4c16bd32013-04-01 11:23:36 -07003866 return !cpumask_equal(cpumask, attrs->cpumask);
3867
3868use_dfl:
3869 cpumask_copy(cpumask, attrs->cpumask);
3870 return false;
3871}
3872
Tejun Heo1befcf32013-04-01 11:23:35 -07003873/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3874static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3875 int node,
3876 struct pool_workqueue *pwq)
3877{
3878 struct pool_workqueue *old_pwq;
3879
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003880 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003881 lockdep_assert_held(&wq->mutex);
3882
3883 /* link_pwq() can handle duplicate calls */
3884 link_pwq(pwq);
3885
3886 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3887 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3888 return old_pwq;
3889}
3890
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003891/* context to store the prepared attrs & pwqs before applying */
3892struct apply_wqattrs_ctx {
3893 struct workqueue_struct *wq; /* target workqueue */
3894 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003895 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003896 struct pool_workqueue *dfl_pwq;
3897 struct pool_workqueue *pwq_tbl[];
3898};
3899
3900/* free the resources after success or abort */
3901static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3902{
3903 if (ctx) {
3904 int node;
3905
3906 for_each_node(node)
3907 put_pwq_unlocked(ctx->pwq_tbl[node]);
3908 put_pwq_unlocked(ctx->dfl_pwq);
3909
3910 free_workqueue_attrs(ctx->attrs);
3911
3912 kfree(ctx);
3913 }
3914}
3915
3916/* allocate the attrs and pwqs for later installation */
3917static struct apply_wqattrs_ctx *
3918apply_wqattrs_prepare(struct workqueue_struct *wq,
3919 const struct workqueue_attrs *attrs)
3920{
3921 struct apply_wqattrs_ctx *ctx;
3922 struct workqueue_attrs *new_attrs, *tmp_attrs;
3923 int node;
3924
3925 lockdep_assert_held(&wq_pool_mutex);
3926
Kees Cookacafe7e2018-05-08 13:45:50 -07003927 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003928
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003929 new_attrs = alloc_workqueue_attrs();
3930 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003931 if (!ctx || !new_attrs || !tmp_attrs)
3932 goto out_free;
3933
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003934 /*
3935 * Calculate the attrs of the default pwq.
3936 * If the user configured cpumask doesn't overlap with the
3937 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3938 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003939 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003940 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003941 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3942 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003943
3944 /*
3945 * We may create multiple pwqs with differing cpumasks. Make a
3946 * copy of @new_attrs which will be modified and used to obtain
3947 * pools.
3948 */
3949 copy_workqueue_attrs(tmp_attrs, new_attrs);
3950
3951 /*
3952 * If something goes wrong during CPU up/down, we'll fall back to
3953 * the default pwq covering whole @attrs->cpumask. Always create
3954 * it even if we don't use it immediately.
3955 */
3956 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3957 if (!ctx->dfl_pwq)
3958 goto out_free;
3959
3960 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003961 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003962 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3963 if (!ctx->pwq_tbl[node])
3964 goto out_free;
3965 } else {
3966 ctx->dfl_pwq->refcnt++;
3967 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3968 }
3969 }
3970
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003971 /* save the user configured attrs and sanitize it. */
3972 copy_workqueue_attrs(new_attrs, attrs);
3973 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003974 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003975
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003976 ctx->wq = wq;
3977 free_workqueue_attrs(tmp_attrs);
3978 return ctx;
3979
3980out_free:
3981 free_workqueue_attrs(tmp_attrs);
3982 free_workqueue_attrs(new_attrs);
3983 apply_wqattrs_cleanup(ctx);
3984 return NULL;
3985}
3986
3987/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3988static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3989{
3990 int node;
3991
3992 /* all pwqs have been created successfully, let's install'em */
3993 mutex_lock(&ctx->wq->mutex);
3994
3995 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3996
3997 /* save the previous pwq and install the new one */
3998 for_each_node(node)
3999 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4000 ctx->pwq_tbl[node]);
4001
4002 /* @dfl_pwq might not have been used, ensure it's linked */
4003 link_pwq(ctx->dfl_pwq);
4004 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
4005
4006 mutex_unlock(&ctx->wq->mutex);
4007}
4008
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004009static void apply_wqattrs_lock(void)
4010{
4011 /* CPUs should stay stable across pwq creations and installations */
4012 get_online_cpus();
4013 mutex_lock(&wq_pool_mutex);
4014}
4015
4016static void apply_wqattrs_unlock(void)
4017{
4018 mutex_unlock(&wq_pool_mutex);
4019 put_online_cpus();
4020}
4021
4022static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4023 const struct workqueue_attrs *attrs)
4024{
4025 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004026
4027 /* only unbound workqueues can change attributes */
4028 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4029 return -EINVAL;
4030
4031 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004032 if (!list_empty(&wq->pwqs)) {
4033 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4034 return -EINVAL;
4035
4036 wq->flags &= ~__WQ_ORDERED;
4037 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004038
4039 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004040 if (!ctx)
4041 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004042
4043 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004044 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004045 apply_wqattrs_cleanup(ctx);
4046
wanghaibin62011712016-01-07 20:38:59 +08004047 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004048}
4049
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004050/**
4051 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4052 * @wq: the target workqueue
4053 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4054 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004055 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4056 * machines, this function maps a separate pwq to each NUMA node with
4057 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4058 * NUMA node it was issued on. Older pwqs are released as in-flight work
4059 * items finish. Note that a work item which repeatedly requeues itself
4060 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004061 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004062 * Performs GFP_KERNEL allocations.
4063 *
Daniel Jordan509b3202019-09-05 21:40:23 -04004064 * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus().
4065 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004066 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004067 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004068int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004069 const struct workqueue_attrs *attrs)
4070{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004071 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004072
Daniel Jordan509b3202019-09-05 21:40:23 -04004073 lockdep_assert_cpus_held();
4074
4075 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004076 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004077 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004078
Tejun Heo48621252013-04-01 11:23:31 -07004079 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004080}
4081
Tejun Heo4c16bd32013-04-01 11:23:36 -07004082/**
4083 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4084 * @wq: the target workqueue
4085 * @cpu: the CPU coming up or going down
4086 * @online: whether @cpu is coming up or going down
4087 *
4088 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4089 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4090 * @wq accordingly.
4091 *
4092 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4093 * falls back to @wq->dfl_pwq which may not be optimal but is always
4094 * correct.
4095 *
4096 * Note that when the last allowed CPU of a NUMA node goes offline for a
4097 * workqueue with a cpumask spanning multiple nodes, the workers which were
4098 * already executing the work items for the workqueue will lose their CPU
4099 * affinity and may execute on any CPU. This is similar to how per-cpu
4100 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4101 * affinity, it's the user's responsibility to flush the work item from
4102 * CPU_DOWN_PREPARE.
4103 */
4104static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4105 bool online)
4106{
4107 int node = cpu_to_node(cpu);
4108 int cpu_off = online ? -1 : cpu;
4109 struct pool_workqueue *old_pwq = NULL, *pwq;
4110 struct workqueue_attrs *target_attrs;
4111 cpumask_t *cpumask;
4112
4113 lockdep_assert_held(&wq_pool_mutex);
4114
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004115 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4116 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004117 return;
4118
4119 /*
4120 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4121 * Let's use a preallocated one. The following buf is protected by
4122 * CPU hotplug exclusion.
4123 */
4124 target_attrs = wq_update_unbound_numa_attrs_buf;
4125 cpumask = target_attrs->cpumask;
4126
Tejun Heo4c16bd32013-04-01 11:23:36 -07004127 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4128 pwq = unbound_pwq_by_node(wq, node);
4129
4130 /*
4131 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004132 * different from the default pwq's, we need to compare it to @pwq's
4133 * and create a new one if they don't match. If the target cpumask
4134 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004135 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004136 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004137 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004138 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004139 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004140 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004141 }
4142
Tejun Heo4c16bd32013-04-01 11:23:36 -07004143 /* create a new pwq */
4144 pwq = alloc_unbound_pwq(wq, target_attrs);
4145 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004146 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4147 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004148 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004149 }
4150
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004151 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004152 mutex_lock(&wq->mutex);
4153 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4154 goto out_unlock;
4155
4156use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004157 mutex_lock(&wq->mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004158 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004159 get_pwq(wq->dfl_pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004160 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004161 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4162out_unlock:
4163 mutex_unlock(&wq->mutex);
4164 put_pwq_unlocked(old_pwq);
4165}
4166
Tejun Heo30cdf2492013-03-12 11:29:57 -07004167static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004168{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004169 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004170 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004171
Tejun Heo30cdf2492013-03-12 11:29:57 -07004172 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004173 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4174 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004175 return -ENOMEM;
4176
4177 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004178 struct pool_workqueue *pwq =
4179 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004180 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004181 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004182
Tejun Heof147f292013-04-01 11:23:35 -07004183 init_pwq(pwq, wq, &cpu_pools[highpri]);
4184
4185 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004186 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004187 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004188 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004189 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004190 }
4191
4192 get_online_cpus();
4193 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004194 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4195 /* there should only be single pwq for ordering guarantee */
4196 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4197 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4198 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004199 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004200 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004201 }
Daniel Jordan509b3202019-09-05 21:40:23 -04004202 put_online_cpus();
4203
4204 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004205}
4206
Tejun Heof3421792010-07-02 10:03:51 +02004207static int wq_clamp_max_active(int max_active, unsigned int flags,
4208 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004209{
Tejun Heof3421792010-07-02 10:03:51 +02004210 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4211
4212 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004213 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4214 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004215
Tejun Heof3421792010-07-02 10:03:51 +02004216 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004217}
4218
Tejun Heo983c7512018-01-08 05:38:32 -08004219/*
4220 * Workqueues which may be used during memory reclaim should have a rescuer
4221 * to guarantee forward progress.
4222 */
4223static int init_rescuer(struct workqueue_struct *wq)
4224{
4225 struct worker *rescuer;
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004226 int ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004227
4228 if (!(wq->flags & WQ_MEM_RECLAIM))
4229 return 0;
4230
4231 rescuer = alloc_worker(NUMA_NO_NODE);
4232 if (!rescuer)
4233 return -ENOMEM;
4234
4235 rescuer->rescue_wq = wq;
4236 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
Sean Fuf187b692020-04-29 12:04:13 +08004237 if (IS_ERR(rescuer->task)) {
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004238 ret = PTR_ERR(rescuer->task);
Tejun Heo983c7512018-01-08 05:38:32 -08004239 kfree(rescuer);
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004240 return ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004241 }
4242
4243 wq->rescuer = rescuer;
4244 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4245 wake_up_process(rescuer->task);
4246
4247 return 0;
4248}
4249
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004250__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004251struct workqueue_struct *alloc_workqueue(const char *fmt,
4252 unsigned int flags,
4253 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004254{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004255 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004256 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004257 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004258 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004259
Tejun Heo5c0338c2017-07-18 18:41:52 -04004260 /*
4261 * Unbound && max_active == 1 used to imply ordered, which is no
4262 * longer the case on NUMA machines due to per-node pools. While
4263 * alloc_ordered_workqueue() is the right way to create an ordered
4264 * workqueue, keep the previous behavior to avoid subtle breakages
4265 * on NUMA.
4266 */
4267 if ((flags & WQ_UNBOUND) && max_active == 1)
4268 flags |= __WQ_ORDERED;
4269
Viresh Kumarcee22a12013-04-08 16:45:40 +05304270 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4271 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4272 flags |= WQ_UNBOUND;
4273
Tejun Heoecf68812013-04-01 11:23:34 -07004274 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004275 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004276 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004277
4278 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004279 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004280 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004281
Tejun Heo6029a912013-04-01 11:23:34 -07004282 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004283 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004284 if (!wq->unbound_attrs)
4285 goto err_free_wq;
4286 }
4287
Bart Van Assche669de8b2019-02-14 15:00:54 -08004288 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004289 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004290 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004291
Tejun Heod320c032010-06-29 10:07:14 +02004292 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004293 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004294
Tejun Heob196be82012-01-10 15:11:35 -08004295 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004296 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004297 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004298 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004299 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004300 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004301 INIT_LIST_HEAD(&wq->flusher_queue);
4302 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004303 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004304
Bart Van Assche669de8b2019-02-14 15:00:54 -08004305 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004306 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004307
Tejun Heo30cdf2492013-03-12 11:29:57 -07004308 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004309 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004310
Tejun Heo40c17f72018-01-08 05:38:37 -08004311 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004312 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004313
Tejun Heo226223a2013-03-12 11:30:05 -07004314 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4315 goto err_destroy;
4316
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004317 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004318 * wq_pool_mutex protects global freeze state and workqueues list.
4319 * Grab it, adjust max_active and add the new @wq to workqueues
4320 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004321 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004322 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004323
Lai Jiangshana357fc02013-03-25 16:57:19 -07004324 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004325 for_each_pwq(pwq, wq)
4326 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004327 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004328
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004329 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004330
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004331 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004332
Oleg Nesterov3af244332007-05-09 02:34:09 -07004333 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004334
Bart Van Assche82efcab2019-03-11 16:02:55 -07004335err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004336 wq_unregister_lockdep(wq);
4337 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004338err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004339 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004340 kfree(wq);
4341 return NULL;
4342err_destroy:
4343 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004344 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004345}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004346EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004347
Tejun Heoc29eb852019-09-23 11:08:58 -07004348static bool pwq_busy(struct pool_workqueue *pwq)
4349{
4350 int i;
4351
4352 for (i = 0; i < WORK_NR_COLORS; i++)
4353 if (pwq->nr_in_flight[i])
4354 return true;
4355
4356 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4357 return true;
4358 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4359 return true;
4360
4361 return false;
4362}
4363
Oleg Nesterov3af244332007-05-09 02:34:09 -07004364/**
4365 * destroy_workqueue - safely terminate a workqueue
4366 * @wq: target workqueue
4367 *
4368 * Safely destroy a workqueue. All work currently pending will be done first.
4369 */
4370void destroy_workqueue(struct workqueue_struct *wq)
4371{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004372 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004373 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004374
Tejun Heodef98c82019-09-18 18:43:40 -07004375 /*
4376 * Remove it from sysfs first so that sanity check failure doesn't
4377 * lead to sysfs name conflicts.
4378 */
4379 workqueue_sysfs_unregister(wq);
4380
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004381 /* drain it before proceeding with destruction */
4382 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004383
Tejun Heodef98c82019-09-18 18:43:40 -07004384 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4385 if (wq->rescuer) {
4386 struct worker *rescuer = wq->rescuer;
4387
4388 /* this prevents new queueing */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004389 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004390 wq->rescuer = NULL;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004391 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004392
4393 /* rescuer will empty maydays list before exiting */
4394 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004395 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004396 }
4397
Tejun Heoc29eb852019-09-23 11:08:58 -07004398 /*
4399 * Sanity checks - grab all the locks so that we wait for all
4400 * in-flight operations which may do put_pwq().
4401 */
4402 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004403 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004404 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004405 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heoc29eb852019-09-23 11:08:58 -07004406 if (WARN_ON(pwq_busy(pwq))) {
Kefeng Wang1d9a6152019-11-28 08:47:49 +08004407 pr_warn("%s: %s has the following busy pwq\n",
4408 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004409 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004410 raw_spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004411 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004412 mutex_unlock(&wq_pool_mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004413 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004414 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004415 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004416 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004417 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004418 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004419
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004420 /*
4421 * wq list is used to freeze wq, remove from list after
4422 * flushing is complete in case freeze races us.
4423 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004424 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004425 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004426
Tejun Heo8864b4e2013-03-12 11:30:04 -07004427 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004428 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004429 /*
4430 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004431 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004432 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004433 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004434 } else {
4435 /*
4436 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004437 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4438 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004439 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004440 for_each_node(node) {
4441 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4442 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4443 put_pwq_unlocked(pwq);
4444 }
4445
4446 /*
4447 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4448 * put. Don't access it afterwards.
4449 */
4450 pwq = wq->dfl_pwq;
4451 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004452 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004453 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004454}
4455EXPORT_SYMBOL_GPL(destroy_workqueue);
4456
Tejun Heodcd989c2010-06-29 10:07:14 +02004457/**
4458 * workqueue_set_max_active - adjust max_active of a workqueue
4459 * @wq: target workqueue
4460 * @max_active: new max_active value.
4461 *
4462 * Set max_active of @wq to @max_active.
4463 *
4464 * CONTEXT:
4465 * Don't call from IRQ context.
4466 */
4467void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4468{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004469 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004470
Tejun Heo8719dce2013-03-12 11:30:04 -07004471 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004472 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004473 return;
4474
Tejun Heof3421792010-07-02 10:03:51 +02004475 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004476
Lai Jiangshana357fc02013-03-25 16:57:19 -07004477 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004478
Tejun Heo0a94efb2017-07-23 08:36:15 -04004479 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004480 wq->saved_max_active = max_active;
4481
Tejun Heo699ce092013-03-13 16:51:35 -07004482 for_each_pwq(pwq, wq)
4483 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004484
Lai Jiangshana357fc02013-03-25 16:57:19 -07004485 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004486}
4487EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4488
4489/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004490 * current_work - retrieve %current task's work struct
4491 *
4492 * Determine if %current task is a workqueue worker and what it's working on.
4493 * Useful to find out the context that the %current task is running in.
4494 *
4495 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4496 */
4497struct work_struct *current_work(void)
4498{
4499 struct worker *worker = current_wq_worker();
4500
4501 return worker ? worker->current_work : NULL;
4502}
4503EXPORT_SYMBOL(current_work);
4504
4505/**
Tejun Heoe62676162013-03-12 17:41:37 -07004506 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4507 *
4508 * Determine whether %current is a workqueue rescuer. Can be used from
4509 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004510 *
4511 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004512 */
4513bool current_is_workqueue_rescuer(void)
4514{
4515 struct worker *worker = current_wq_worker();
4516
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004517 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004518}
4519
4520/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004521 * workqueue_congested - test whether a workqueue is congested
4522 * @cpu: CPU in question
4523 * @wq: target workqueue
4524 *
4525 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4526 * no synchronization around this function and the test result is
4527 * unreliable and only useful as advisory hints or for debugging.
4528 *
Tejun Heod3251852013-05-10 11:10:17 -07004529 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4530 * Note that both per-cpu and unbound workqueues may be associated with
4531 * multiple pool_workqueues which have separate congested states. A
4532 * workqueue being congested on one CPU doesn't mean the workqueue is also
4533 * contested on other CPUs / NUMA nodes.
4534 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004535 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004536 * %true if congested, %false otherwise.
4537 */
Tejun Heod84ff052013-03-12 11:29:59 -07004538bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004539{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004540 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004541 bool ret;
4542
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004543 rcu_read_lock();
4544 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004545
Tejun Heod3251852013-05-10 11:10:17 -07004546 if (cpu == WORK_CPU_UNBOUND)
4547 cpu = smp_processor_id();
4548
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004549 if (!(wq->flags & WQ_UNBOUND))
4550 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4551 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004552 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004553
Tejun Heo76af4d92013-03-12 11:30:00 -07004554 ret = !list_empty(&pwq->delayed_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004555 preempt_enable();
4556 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004557
4558 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004559}
4560EXPORT_SYMBOL_GPL(workqueue_congested);
4561
4562/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004563 * work_busy - test whether a work is currently pending or running
4564 * @work: the work to be tested
4565 *
4566 * Test whether @work is currently pending or running. There is no
4567 * synchronization around this function and the test result is
4568 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004569 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004570 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004571 * OR'd bitmask of WORK_BUSY_* bits.
4572 */
4573unsigned int work_busy(struct work_struct *work)
4574{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004575 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004576 unsigned long flags;
4577 unsigned int ret = 0;
4578
Tejun Heodcd989c2010-06-29 10:07:14 +02004579 if (work_pending(work))
4580 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004581
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004582 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004583 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004584 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004585 raw_spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004586 if (find_worker_executing_work(pool, work))
4587 ret |= WORK_BUSY_RUNNING;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004588 raw_spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004589 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004590 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004591
4592 return ret;
4593}
4594EXPORT_SYMBOL_GPL(work_busy);
4595
Tejun Heo3d1cb202013-04-30 15:27:22 -07004596/**
4597 * set_worker_desc - set description for the current work item
4598 * @fmt: printf-style format string
4599 * @...: arguments for the format string
4600 *
4601 * This function can be called by a running work function to describe what
4602 * the work item is about. If the worker task gets dumped, this
4603 * information will be printed out together to help debugging. The
4604 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4605 */
4606void set_worker_desc(const char *fmt, ...)
4607{
4608 struct worker *worker = current_wq_worker();
4609 va_list args;
4610
4611 if (worker) {
4612 va_start(args, fmt);
4613 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4614 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004615 }
4616}
Steffen Maier5c750d52018-05-17 19:14:57 +02004617EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004618
4619/**
4620 * print_worker_info - print out worker information and description
4621 * @log_lvl: the log level to use when printing
4622 * @task: target task
4623 *
4624 * If @task is a worker and currently executing a work item, print out the
4625 * name of the workqueue being serviced and worker description set with
4626 * set_worker_desc() by the currently executing work item.
4627 *
4628 * This function can be safely called on any task as long as the
4629 * task_struct itself is accessible. While safe, this function isn't
4630 * synchronized and may print out mixups or garbages of limited length.
4631 */
4632void print_worker_info(const char *log_lvl, struct task_struct *task)
4633{
4634 work_func_t *fn = NULL;
4635 char name[WQ_NAME_LEN] = { };
4636 char desc[WORKER_DESC_LEN] = { };
4637 struct pool_workqueue *pwq = NULL;
4638 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004639 struct worker *worker;
4640
4641 if (!(task->flags & PF_WQ_WORKER))
4642 return;
4643
4644 /*
4645 * This function is called without any synchronization and @task
4646 * could be in any state. Be careful with dereferences.
4647 */
Petr Mladeke7005912016-10-11 13:55:17 -07004648 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004649
4650 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004651 * Carefully copy the associated workqueue's workfn, name and desc.
4652 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004653 */
Christoph Hellwigfe557312020-06-17 09:37:53 +02004654 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4655 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4656 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4657 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4658 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004659
4660 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004661 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004662 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004663 pr_cont(" (%s)", desc);
4664 pr_cont("\n");
4665 }
4666}
4667
Tejun Heo3494fc32015-03-09 09:22:28 -04004668static void pr_cont_pool_info(struct worker_pool *pool)
4669{
4670 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4671 if (pool->node != NUMA_NO_NODE)
4672 pr_cont(" node=%d", pool->node);
4673 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4674}
4675
4676static void pr_cont_work(bool comma, struct work_struct *work)
4677{
4678 if (work->func == wq_barrier_func) {
4679 struct wq_barrier *barr;
4680
4681 barr = container_of(work, struct wq_barrier, work);
4682
4683 pr_cont("%s BAR(%d)", comma ? "," : "",
4684 task_pid_nr(barr->task));
4685 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004686 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004687 }
4688}
4689
4690static void show_pwq(struct pool_workqueue *pwq)
4691{
4692 struct worker_pool *pool = pwq->pool;
4693 struct work_struct *work;
4694 struct worker *worker;
4695 bool has_in_flight = false, has_pending = false;
4696 int bkt;
4697
4698 pr_info(" pwq %d:", pool->id);
4699 pr_cont_pool_info(pool);
4700
Tejun Heoe66b39a2019-09-25 06:59:15 -07004701 pr_cont(" active=%d/%d refcnt=%d%s\n",
4702 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004703 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4704
4705 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4706 if (worker->current_pwq == pwq) {
4707 has_in_flight = true;
4708 break;
4709 }
4710 }
4711 if (has_in_flight) {
4712 bool comma = false;
4713
4714 pr_info(" in-flight:");
4715 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4716 if (worker->current_pwq != pwq)
4717 continue;
4718
Sakari Ailusd75f7732019-03-25 21:32:28 +02004719 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004720 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004721 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004722 worker->current_func);
4723 list_for_each_entry(work, &worker->scheduled, entry)
4724 pr_cont_work(false, work);
4725 comma = true;
4726 }
4727 pr_cont("\n");
4728 }
4729
4730 list_for_each_entry(work, &pool->worklist, entry) {
4731 if (get_work_pwq(work) == pwq) {
4732 has_pending = true;
4733 break;
4734 }
4735 }
4736 if (has_pending) {
4737 bool comma = false;
4738
4739 pr_info(" pending:");
4740 list_for_each_entry(work, &pool->worklist, entry) {
4741 if (get_work_pwq(work) != pwq)
4742 continue;
4743
4744 pr_cont_work(comma, work);
4745 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4746 }
4747 pr_cont("\n");
4748 }
4749
4750 if (!list_empty(&pwq->delayed_works)) {
4751 bool comma = false;
4752
4753 pr_info(" delayed:");
4754 list_for_each_entry(work, &pwq->delayed_works, entry) {
4755 pr_cont_work(comma, work);
4756 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4757 }
4758 pr_cont("\n");
4759 }
4760}
4761
4762/**
4763 * show_workqueue_state - dump workqueue state
4764 *
Roger Lu7b776af2016-07-01 11:05:02 +08004765 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4766 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004767 */
4768void show_workqueue_state(void)
4769{
4770 struct workqueue_struct *wq;
4771 struct worker_pool *pool;
4772 unsigned long flags;
4773 int pi;
4774
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004775 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004776
4777 pr_info("Showing busy workqueues and worker pools:\n");
4778
4779 list_for_each_entry_rcu(wq, &workqueues, list) {
4780 struct pool_workqueue *pwq;
4781 bool idle = true;
4782
4783 for_each_pwq(pwq, wq) {
4784 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4785 idle = false;
4786 break;
4787 }
4788 }
4789 if (idle)
4790 continue;
4791
4792 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4793
4794 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004795 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004796 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4797 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004798 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004799 /*
4800 * We could be printing a lot from atomic context, e.g.
4801 * sysrq-t -> show_workqueue_state(). Avoid triggering
4802 * hard lockup.
4803 */
4804 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004805 }
4806 }
4807
4808 for_each_pool(pool, pi) {
4809 struct worker *worker;
4810 bool first = true;
4811
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004812 raw_spin_lock_irqsave(&pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004813 if (pool->nr_workers == pool->nr_idle)
4814 goto next_pool;
4815
4816 pr_info("pool %d:", pool->id);
4817 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004818 pr_cont(" hung=%us workers=%d",
4819 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4820 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004821 if (pool->manager)
4822 pr_cont(" manager: %d",
4823 task_pid_nr(pool->manager->task));
4824 list_for_each_entry(worker, &pool->idle_list, entry) {
4825 pr_cont(" %s%d", first ? "idle: " : "",
4826 task_pid_nr(worker->task));
4827 first = false;
4828 }
4829 pr_cont("\n");
4830 next_pool:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004831 raw_spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004832 /*
4833 * We could be printing a lot from atomic context, e.g.
4834 * sysrq-t -> show_workqueue_state(). Avoid triggering
4835 * hard lockup.
4836 */
4837 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004838 }
4839
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004840 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004841}
4842
Tejun Heo6b598082018-05-18 08:47:13 -07004843/* used to show worker information through /proc/PID/{comm,stat,status} */
4844void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4845{
Tejun Heo6b598082018-05-18 08:47:13 -07004846 int off;
4847
4848 /* always show the actual comm */
4849 off = strscpy(buf, task->comm, size);
4850 if (off < 0)
4851 return;
4852
Tejun Heo197f6ac2018-05-21 08:04:35 -07004853 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004854 mutex_lock(&wq_pool_attach_mutex);
4855
Tejun Heo197f6ac2018-05-21 08:04:35 -07004856 if (task->flags & PF_WQ_WORKER) {
4857 struct worker *worker = kthread_data(task);
4858 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004859
Tejun Heo197f6ac2018-05-21 08:04:35 -07004860 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004861 raw_spin_lock_irq(&pool->lock);
Tejun Heo197f6ac2018-05-21 08:04:35 -07004862 /*
4863 * ->desc tracks information (wq name or
4864 * set_worker_desc()) for the latest execution. If
4865 * current, prepend '+', otherwise '-'.
4866 */
4867 if (worker->desc[0] != '\0') {
4868 if (worker->current_work)
4869 scnprintf(buf + off, size - off, "+%s",
4870 worker->desc);
4871 else
4872 scnprintf(buf + off, size - off, "-%s",
4873 worker->desc);
4874 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004875 raw_spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004876 }
Tejun Heo6b598082018-05-18 08:47:13 -07004877 }
4878
4879 mutex_unlock(&wq_pool_attach_mutex);
4880}
4881
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004882#ifdef CONFIG_SMP
4883
Tejun Heodb7bccf2010-06-29 10:07:12 +02004884/*
4885 * CPU hotplug.
4886 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004887 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004888 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004889 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004890 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004891 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004892 * blocked draining impractical.
4893 *
Tejun Heo24647572013-01-24 11:01:33 -08004894 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004895 * running as an unbound one and allowing it to be reattached later if the
4896 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004897 */
4898
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004899static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004900{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004901 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004902 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004903
Tejun Heof02ae732013-03-12 11:30:03 -07004904 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004905 mutex_lock(&wq_pool_attach_mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004906 raw_spin_lock_irq(&pool->lock);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004907
4908 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004909 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004910 * unbound and set DISASSOCIATED. Before this, all workers
4911 * except for the ones which are still executing works from
4912 * before the last CPU down must be on the cpu. After
4913 * this, they may become diasporas.
4914 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004915 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004916 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004917
Tejun Heo24647572013-01-24 11:01:33 -08004918 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004919
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004920 raw_spin_unlock_irq(&pool->lock);
Peter Zijlstra06249732020-09-25 15:45:11 +02004921
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004922 for_each_pool_worker(worker, pool) {
4923 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshan547a77d2021-01-11 23:26:33 +08004924 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004925 }
Peter Zijlstra06249732020-09-25 15:45:11 +02004926
Tejun Heo1258fae2018-05-18 08:47:13 -07004927 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004928
Lai Jiangshaneb283422013-03-08 15:18:28 -08004929 /*
4930 * Call schedule() so that we cross rq->lock and thus can
4931 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4932 * This is necessary as scheduler callbacks may be invoked
4933 * from other cpus.
4934 */
4935 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004936
Lai Jiangshaneb283422013-03-08 15:18:28 -08004937 /*
4938 * Sched callbacks are disabled now. Zap nr_running.
4939 * After this, nr_running stays zero and need_more_worker()
4940 * and keep_working() are always true as long as the
4941 * worklist is not empty. This pool now behaves as an
4942 * unbound (in terms of concurrency management) pool which
4943 * are served by workers tied to the pool.
4944 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004945 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004946
4947 /*
4948 * With concurrency management just turned off, a busy
4949 * worker blocking could lead to lengthy stalls. Kick off
4950 * unbound chain execution of currently pending work items.
4951 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004952 raw_spin_lock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004953 wake_up_worker(pool);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004954 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004955 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004956}
4957
Tejun Heobd7c0892013-03-19 13:45:21 -07004958/**
4959 * rebind_workers - rebind all workers of a pool to the associated CPU
4960 * @pool: pool of interest
4961 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004962 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004963 */
4964static void rebind_workers(struct worker_pool *pool)
4965{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004966 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004967
Tejun Heo1258fae2018-05-18 08:47:13 -07004968 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004969
Tejun Heoa9ab7752013-03-19 13:45:21 -07004970 /*
4971 * Restore CPU affinity of all workers. As all idle workers should
4972 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304973 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004974 * of all workers first and then clear UNBOUND. As we're called
4975 * from CPU_ONLINE, the following shouldn't fail.
4976 */
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004977 for_each_pool_worker(worker, pool) {
4978 kthread_set_per_cpu(worker->task, pool->cpu);
Tejun Heoa9ab7752013-03-19 13:45:21 -07004979 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4980 pool->attrs->cpumask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004981 }
Tejun Heoa9ab7752013-03-19 13:45:21 -07004982
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004983 raw_spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004984
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004985 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004986
Lai Jiangshanda028462014-05-20 17:46:31 +08004987 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004988 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004989
4990 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004991 * A bound idle worker should actually be on the runqueue
4992 * of the associated CPU for local wake-ups targeting it to
4993 * work. Kick all idle workers so that they migrate to the
4994 * associated CPU. Doing this in the same loop as
4995 * replacing UNBOUND with REBOUND is safe as no worker will
4996 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004997 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004998 if (worker_flags & WORKER_IDLE)
4999 wake_up_process(worker->task);
5000
5001 /*
5002 * We want to clear UNBOUND but can't directly call
5003 * worker_clr_flags() or adjust nr_running. Atomically
5004 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5005 * @worker will clear REBOUND using worker_clr_flags() when
5006 * it initiates the next execution cycle thus restoring
5007 * concurrency management. Note that when or whether
5008 * @worker clears REBOUND doesn't affect correctness.
5009 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07005010 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07005011 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01005012 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07005013 * fail incorrectly leading to premature concurrency
5014 * management operations.
5015 */
5016 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5017 worker_flags |= WORKER_REBOUND;
5018 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07005019 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07005020 }
5021
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005022 raw_spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07005023}
5024
Tejun Heo7dbc7252013-03-19 13:45:21 -07005025/**
5026 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5027 * @pool: unbound pool of interest
5028 * @cpu: the CPU which is coming up
5029 *
5030 * An unbound pool may end up with a cpumask which doesn't have any online
5031 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5032 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5033 * online CPU before, cpus_allowed of all its workers should be restored.
5034 */
5035static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5036{
5037 static cpumask_t cpumask;
5038 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005039
Tejun Heo1258fae2018-05-18 08:47:13 -07005040 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005041
5042 /* is @cpu allowed for @pool? */
5043 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5044 return;
5045
Tejun Heo7dbc7252013-03-19 13:45:21 -07005046 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005047
5048 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005049 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005050 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005051}
5052
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005053int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005054{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005055 struct worker_pool *pool;
5056
5057 for_each_cpu_worker_pool(pool, cpu) {
5058 if (pool->nr_workers)
5059 continue;
5060 if (!create_worker(pool))
5061 return -ENOMEM;
5062 }
5063 return 0;
5064}
5065
5066int workqueue_online_cpu(unsigned int cpu)
5067{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005068 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005069 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005070 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005071
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005072 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005073
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005074 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005075 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005076
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005077 if (pool->cpu == cpu)
5078 rebind_workers(pool);
5079 else if (pool->cpu < 0)
5080 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005081
Tejun Heo1258fae2018-05-18 08:47:13 -07005082 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005083 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005084
5085 /* update NUMA affinity of unbound workqueues */
5086 list_for_each_entry(wq, &workqueues, list)
5087 wq_update_unbound_numa(wq, cpu, true);
5088
5089 mutex_unlock(&wq_pool_mutex);
5090 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005091}
5092
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005093int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005094{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005095 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005096
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005097 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005098 if (WARN_ON(cpu != smp_processor_id()))
5099 return -1;
5100
5101 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005102
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005103 /* update NUMA affinity of unbound workqueues */
5104 mutex_lock(&wq_pool_mutex);
5105 list_for_each_entry(wq, &workqueues, list)
5106 wq_update_unbound_numa(wq, cpu, false);
5107 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005108
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005109 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005110}
5111
Rusty Russell2d3854a2008-11-05 13:39:10 +11005112struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005113 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005114 long (*fn)(void *);
5115 void *arg;
5116 long ret;
5117};
5118
Tejun Heoed48ece2012-09-18 12:48:43 -07005119static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005120{
Tejun Heoed48ece2012-09-18 12:48:43 -07005121 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5122
Rusty Russell2d3854a2008-11-05 13:39:10 +11005123 wfc->ret = wfc->fn(wfc->arg);
5124}
5125
5126/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005127 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005128 * @cpu: the cpu to run on
5129 * @fn: the function to run
5130 * @arg: the function arg
5131 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005132 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005133 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005134 *
5135 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005136 */
Tejun Heod84ff052013-03-12 11:29:59 -07005137long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005138{
Tejun Heoed48ece2012-09-18 12:48:43 -07005139 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005140
Tejun Heoed48ece2012-09-18 12:48:43 -07005141 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5142 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005143 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005144 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005145 return wfc.ret;
5146}
5147EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005148
5149/**
5150 * work_on_cpu_safe - run a function in thread context on a particular cpu
5151 * @cpu: the cpu to run on
5152 * @fn: the function to run
5153 * @arg: the function argument
5154 *
5155 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5156 * any locks which would prevent @fn from completing.
5157 *
5158 * Return: The value @fn returns.
5159 */
5160long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5161{
5162 long ret = -ENODEV;
5163
5164 get_online_cpus();
5165 if (cpu_online(cpu))
5166 ret = work_on_cpu(cpu, fn, arg);
5167 put_online_cpus();
5168 return ret;
5169}
5170EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005171#endif /* CONFIG_SMP */
5172
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005173#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305174
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005175/**
5176 * freeze_workqueues_begin - begin freezing workqueues
5177 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005178 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005179 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005180 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005181 *
5182 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005183 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005184 */
5185void freeze_workqueues_begin(void)
5186{
Tejun Heo24b8a842013-03-12 11:29:58 -07005187 struct workqueue_struct *wq;
5188 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005189
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005190 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005191
Tejun Heo6183c002013-03-12 11:29:57 -07005192 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005193 workqueue_freezing = true;
5194
Tejun Heo24b8a842013-03-12 11:29:58 -07005195 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005196 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005197 for_each_pwq(pwq, wq)
5198 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005199 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005200 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005201
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005202 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005203}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005204
5205/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005206 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005207 *
5208 * Check whether freezing is complete. This function must be called
5209 * between freeze_workqueues_begin() and thaw_workqueues().
5210 *
5211 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005212 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005213 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005214 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005215 * %true if some freezable workqueues are still busy. %false if freezing
5216 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005217 */
5218bool freeze_workqueues_busy(void)
5219{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005220 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005221 struct workqueue_struct *wq;
5222 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005223
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005224 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005225
Tejun Heo6183c002013-03-12 11:29:57 -07005226 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005227
Tejun Heo24b8a842013-03-12 11:29:58 -07005228 list_for_each_entry(wq, &workqueues, list) {
5229 if (!(wq->flags & WQ_FREEZABLE))
5230 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005231 /*
5232 * nr_active is monotonically decreasing. It's safe
5233 * to peek without lock.
5234 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005235 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005236 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005237 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005238 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005239 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005240 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005241 goto out_unlock;
5242 }
5243 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005244 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005245 }
5246out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005247 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005248 return busy;
5249}
5250
5251/**
5252 * thaw_workqueues - thaw workqueues
5253 *
5254 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005255 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005256 *
5257 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005258 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005259 */
5260void thaw_workqueues(void)
5261{
Tejun Heo24b8a842013-03-12 11:29:58 -07005262 struct workqueue_struct *wq;
5263 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005264
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005265 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005266
5267 if (!workqueue_freezing)
5268 goto out_unlock;
5269
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005270 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005271
Tejun Heo24b8a842013-03-12 11:29:58 -07005272 /* restore max_active and repopulate worklist */
5273 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005274 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005275 for_each_pwq(pwq, wq)
5276 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005277 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005278 }
5279
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005280out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005281 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005282}
5283#endif /* CONFIG_FREEZER */
5284
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005285static int workqueue_apply_unbound_cpumask(void)
5286{
5287 LIST_HEAD(ctxs);
5288 int ret = 0;
5289 struct workqueue_struct *wq;
5290 struct apply_wqattrs_ctx *ctx, *n;
5291
5292 lockdep_assert_held(&wq_pool_mutex);
5293
5294 list_for_each_entry(wq, &workqueues, list) {
5295 if (!(wq->flags & WQ_UNBOUND))
5296 continue;
5297 /* creating multiple pwqs breaks ordering guarantee */
5298 if (wq->flags & __WQ_ORDERED)
5299 continue;
5300
5301 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5302 if (!ctx) {
5303 ret = -ENOMEM;
5304 break;
5305 }
5306
5307 list_add_tail(&ctx->list, &ctxs);
5308 }
5309
5310 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5311 if (!ret)
5312 apply_wqattrs_commit(ctx);
5313 apply_wqattrs_cleanup(ctx);
5314 }
5315
5316 return ret;
5317}
5318
5319/**
5320 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5321 * @cpumask: the cpumask to set
5322 *
5323 * The low-level workqueues cpumask is a global cpumask that limits
5324 * the affinity of all unbound workqueues. This function check the @cpumask
5325 * and apply it to all unbound workqueues and updates all pwqs of them.
5326 *
5327 * Retun: 0 - Success
5328 * -EINVAL - Invalid @cpumask
5329 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5330 */
5331int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5332{
5333 int ret = -EINVAL;
5334 cpumask_var_t saved_cpumask;
5335
5336 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5337 return -ENOMEM;
5338
Tal Shorerc98a9802017-11-03 17:27:50 +02005339 /*
5340 * Not excluding isolated cpus on purpose.
5341 * If the user wishes to include them, we allow that.
5342 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005343 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5344 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005345 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005346
5347 /* save the old wq_unbound_cpumask. */
5348 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5349
5350 /* update wq_unbound_cpumask at first and apply it to wqs. */
5351 cpumask_copy(wq_unbound_cpumask, cpumask);
5352 ret = workqueue_apply_unbound_cpumask();
5353
5354 /* restore the wq_unbound_cpumask when failed. */
5355 if (ret < 0)
5356 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5357
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005358 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005359 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005360
5361 free_cpumask_var(saved_cpumask);
5362 return ret;
5363}
5364
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005365#ifdef CONFIG_SYSFS
5366/*
5367 * Workqueues with WQ_SYSFS flag set is visible to userland via
5368 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5369 * following attributes.
5370 *
5371 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5372 * max_active RW int : maximum number of in-flight work items
5373 *
5374 * Unbound workqueues have the following extra attributes.
5375 *
Wang Long9a19b462017-11-02 23:05:12 -04005376 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005377 * nice RW int : nice value of the workers
5378 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005379 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005380 */
5381struct wq_device {
5382 struct workqueue_struct *wq;
5383 struct device dev;
5384};
5385
5386static struct workqueue_struct *dev_to_wq(struct device *dev)
5387{
5388 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5389
5390 return wq_dev->wq;
5391}
5392
5393static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5394 char *buf)
5395{
5396 struct workqueue_struct *wq = dev_to_wq(dev);
5397
5398 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5399}
5400static DEVICE_ATTR_RO(per_cpu);
5401
5402static ssize_t max_active_show(struct device *dev,
5403 struct device_attribute *attr, char *buf)
5404{
5405 struct workqueue_struct *wq = dev_to_wq(dev);
5406
5407 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5408}
5409
5410static ssize_t max_active_store(struct device *dev,
5411 struct device_attribute *attr, const char *buf,
5412 size_t count)
5413{
5414 struct workqueue_struct *wq = dev_to_wq(dev);
5415 int val;
5416
5417 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5418 return -EINVAL;
5419
5420 workqueue_set_max_active(wq, val);
5421 return count;
5422}
5423static DEVICE_ATTR_RW(max_active);
5424
5425static struct attribute *wq_sysfs_attrs[] = {
5426 &dev_attr_per_cpu.attr,
5427 &dev_attr_max_active.attr,
5428 NULL,
5429};
5430ATTRIBUTE_GROUPS(wq_sysfs);
5431
5432static ssize_t wq_pool_ids_show(struct device *dev,
5433 struct device_attribute *attr, char *buf)
5434{
5435 struct workqueue_struct *wq = dev_to_wq(dev);
5436 const char *delim = "";
5437 int node, written = 0;
5438
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005439 get_online_cpus();
5440 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005441 for_each_node(node) {
5442 written += scnprintf(buf + written, PAGE_SIZE - written,
5443 "%s%d:%d", delim, node,
5444 unbound_pwq_by_node(wq, node)->pool->id);
5445 delim = " ";
5446 }
5447 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005448 rcu_read_unlock();
5449 put_online_cpus();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005450
5451 return written;
5452}
5453
5454static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5455 char *buf)
5456{
5457 struct workqueue_struct *wq = dev_to_wq(dev);
5458 int written;
5459
5460 mutex_lock(&wq->mutex);
5461 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5462 mutex_unlock(&wq->mutex);
5463
5464 return written;
5465}
5466
5467/* prepare workqueue_attrs for sysfs store operations */
5468static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5469{
5470 struct workqueue_attrs *attrs;
5471
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005472 lockdep_assert_held(&wq_pool_mutex);
5473
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005474 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005475 if (!attrs)
5476 return NULL;
5477
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005478 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005479 return attrs;
5480}
5481
5482static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5483 const char *buf, size_t count)
5484{
5485 struct workqueue_struct *wq = dev_to_wq(dev);
5486 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005487 int ret = -ENOMEM;
5488
5489 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005490
5491 attrs = wq_sysfs_prep_attrs(wq);
5492 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005493 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005494
5495 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5496 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005497 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005498 else
5499 ret = -EINVAL;
5500
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005501out_unlock:
5502 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005503 free_workqueue_attrs(attrs);
5504 return ret ?: count;
5505}
5506
5507static ssize_t wq_cpumask_show(struct device *dev,
5508 struct device_attribute *attr, char *buf)
5509{
5510 struct workqueue_struct *wq = dev_to_wq(dev);
5511 int written;
5512
5513 mutex_lock(&wq->mutex);
5514 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5515 cpumask_pr_args(wq->unbound_attrs->cpumask));
5516 mutex_unlock(&wq->mutex);
5517 return written;
5518}
5519
5520static ssize_t wq_cpumask_store(struct device *dev,
5521 struct device_attribute *attr,
5522 const char *buf, size_t count)
5523{
5524 struct workqueue_struct *wq = dev_to_wq(dev);
5525 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005526 int ret = -ENOMEM;
5527
5528 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005529
5530 attrs = wq_sysfs_prep_attrs(wq);
5531 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005532 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005533
5534 ret = cpumask_parse(buf, attrs->cpumask);
5535 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005536 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005537
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005538out_unlock:
5539 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005540 free_workqueue_attrs(attrs);
5541 return ret ?: count;
5542}
5543
5544static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5545 char *buf)
5546{
5547 struct workqueue_struct *wq = dev_to_wq(dev);
5548 int written;
5549
5550 mutex_lock(&wq->mutex);
5551 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5552 !wq->unbound_attrs->no_numa);
5553 mutex_unlock(&wq->mutex);
5554
5555 return written;
5556}
5557
5558static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5559 const char *buf, size_t count)
5560{
5561 struct workqueue_struct *wq = dev_to_wq(dev);
5562 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005563 int v, ret = -ENOMEM;
5564
5565 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005566
5567 attrs = wq_sysfs_prep_attrs(wq);
5568 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005569 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005570
5571 ret = -EINVAL;
5572 if (sscanf(buf, "%d", &v) == 1) {
5573 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005574 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005575 }
5576
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005577out_unlock:
5578 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005579 free_workqueue_attrs(attrs);
5580 return ret ?: count;
5581}
5582
5583static struct device_attribute wq_sysfs_unbound_attrs[] = {
5584 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5585 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5586 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5587 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5588 __ATTR_NULL,
5589};
5590
5591static struct bus_type wq_subsys = {
5592 .name = "workqueue",
5593 .dev_groups = wq_sysfs_groups,
5594};
5595
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005596static ssize_t wq_unbound_cpumask_show(struct device *dev,
5597 struct device_attribute *attr, char *buf)
5598{
5599 int written;
5600
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005601 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005602 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5603 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005604 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005605
5606 return written;
5607}
5608
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005609static ssize_t wq_unbound_cpumask_store(struct device *dev,
5610 struct device_attribute *attr, const char *buf, size_t count)
5611{
5612 cpumask_var_t cpumask;
5613 int ret;
5614
5615 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5616 return -ENOMEM;
5617
5618 ret = cpumask_parse(buf, cpumask);
5619 if (!ret)
5620 ret = workqueue_set_unbound_cpumask(cpumask);
5621
5622 free_cpumask_var(cpumask);
5623 return ret ? ret : count;
5624}
5625
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005626static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005627 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5628 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005629
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005630static int __init wq_sysfs_init(void)
5631{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005632 int err;
5633
5634 err = subsys_virtual_register(&wq_subsys, NULL);
5635 if (err)
5636 return err;
5637
5638 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005639}
5640core_initcall(wq_sysfs_init);
5641
5642static void wq_device_release(struct device *dev)
5643{
5644 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5645
5646 kfree(wq_dev);
5647}
5648
5649/**
5650 * workqueue_sysfs_register - make a workqueue visible in sysfs
5651 * @wq: the workqueue to register
5652 *
5653 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5654 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5655 * which is the preferred method.
5656 *
5657 * Workqueue user should use this function directly iff it wants to apply
5658 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5659 * apply_workqueue_attrs() may race against userland updating the
5660 * attributes.
5661 *
5662 * Return: 0 on success, -errno on failure.
5663 */
5664int workqueue_sysfs_register(struct workqueue_struct *wq)
5665{
5666 struct wq_device *wq_dev;
5667 int ret;
5668
5669 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305670 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005671 * attributes breaks ordering guarantee. Disallow exposing ordered
5672 * workqueues.
5673 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005674 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005675 return -EINVAL;
5676
5677 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5678 if (!wq_dev)
5679 return -ENOMEM;
5680
5681 wq_dev->wq = wq;
5682 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005683 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005684 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005685
5686 /*
5687 * unbound_attrs are created separately. Suppress uevent until
5688 * everything is ready.
5689 */
5690 dev_set_uevent_suppress(&wq_dev->dev, true);
5691
5692 ret = device_register(&wq_dev->dev);
5693 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305694 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005695 wq->wq_dev = NULL;
5696 return ret;
5697 }
5698
5699 if (wq->flags & WQ_UNBOUND) {
5700 struct device_attribute *attr;
5701
5702 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5703 ret = device_create_file(&wq_dev->dev, attr);
5704 if (ret) {
5705 device_unregister(&wq_dev->dev);
5706 wq->wq_dev = NULL;
5707 return ret;
5708 }
5709 }
5710 }
5711
5712 dev_set_uevent_suppress(&wq_dev->dev, false);
5713 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5714 return 0;
5715}
5716
5717/**
5718 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5719 * @wq: the workqueue to unregister
5720 *
5721 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5722 */
5723static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5724{
5725 struct wq_device *wq_dev = wq->wq_dev;
5726
5727 if (!wq->wq_dev)
5728 return;
5729
5730 wq->wq_dev = NULL;
5731 device_unregister(&wq_dev->dev);
5732}
5733#else /* CONFIG_SYSFS */
5734static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5735#endif /* CONFIG_SYSFS */
5736
Tejun Heo82607adc2015-12-08 11:28:04 -05005737/*
5738 * Workqueue watchdog.
5739 *
5740 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5741 * flush dependency, a concurrency managed work item which stays RUNNING
5742 * indefinitely. Workqueue stalls can be very difficult to debug as the
5743 * usual warning mechanisms don't trigger and internal workqueue state is
5744 * largely opaque.
5745 *
5746 * Workqueue watchdog monitors all worker pools periodically and dumps
5747 * state if some pools failed to make forward progress for a while where
5748 * forward progress is defined as the first item on ->worklist changing.
5749 *
5750 * This mechanism is controlled through the kernel parameter
5751 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5752 * corresponding sysfs parameter file.
5753 */
5754#ifdef CONFIG_WQ_WATCHDOG
5755
Tejun Heo82607adc2015-12-08 11:28:04 -05005756static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005757static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005758
5759static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5760static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5761
5762static void wq_watchdog_reset_touched(void)
5763{
5764 int cpu;
5765
5766 wq_watchdog_touched = jiffies;
5767 for_each_possible_cpu(cpu)
5768 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5769}
5770
Kees Cook5cd79d62017-10-04 16:27:00 -07005771static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005772{
5773 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5774 bool lockup_detected = false;
5775 struct worker_pool *pool;
5776 int pi;
5777
5778 if (!thresh)
5779 return;
5780
5781 rcu_read_lock();
5782
5783 for_each_pool(pool, pi) {
5784 unsigned long pool_ts, touched, ts;
5785
5786 if (list_empty(&pool->worklist))
5787 continue;
5788
5789 /* get the latest of pool and touched timestamps */
Wang Qing89e28ce2021-03-24 19:40:29 +08005790 if (pool->cpu >= 0)
5791 touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
5792 else
5793 touched = READ_ONCE(wq_watchdog_touched);
Tejun Heo82607adc2015-12-08 11:28:04 -05005794 pool_ts = READ_ONCE(pool->watchdog_ts);
Tejun Heo82607adc2015-12-08 11:28:04 -05005795
5796 if (time_after(pool_ts, touched))
5797 ts = pool_ts;
5798 else
5799 ts = touched;
5800
Tejun Heo82607adc2015-12-08 11:28:04 -05005801 /* did we stall? */
5802 if (time_after(jiffies, ts + thresh)) {
5803 lockup_detected = true;
5804 pr_emerg("BUG: workqueue lockup - pool");
5805 pr_cont_pool_info(pool);
5806 pr_cont(" stuck for %us!\n",
5807 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5808 }
5809 }
5810
5811 rcu_read_unlock();
5812
5813 if (lockup_detected)
5814 show_workqueue_state();
5815
5816 wq_watchdog_reset_touched();
5817 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5818}
5819
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005820notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005821{
5822 if (cpu >= 0)
5823 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
Wang Qing89e28ce2021-03-24 19:40:29 +08005824
5825 wq_watchdog_touched = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005826}
5827
5828static void wq_watchdog_set_thresh(unsigned long thresh)
5829{
5830 wq_watchdog_thresh = 0;
5831 del_timer_sync(&wq_watchdog_timer);
5832
5833 if (thresh) {
5834 wq_watchdog_thresh = thresh;
5835 wq_watchdog_reset_touched();
5836 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5837 }
5838}
5839
5840static int wq_watchdog_param_set_thresh(const char *val,
5841 const struct kernel_param *kp)
5842{
5843 unsigned long thresh;
5844 int ret;
5845
5846 ret = kstrtoul(val, 0, &thresh);
5847 if (ret)
5848 return ret;
5849
5850 if (system_wq)
5851 wq_watchdog_set_thresh(thresh);
5852 else
5853 wq_watchdog_thresh = thresh;
5854
5855 return 0;
5856}
5857
5858static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5859 .set = wq_watchdog_param_set_thresh,
5860 .get = param_get_ulong,
5861};
5862
5863module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5864 0644);
5865
5866static void wq_watchdog_init(void)
5867{
Kees Cook5cd79d62017-10-04 16:27:00 -07005868 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005869 wq_watchdog_set_thresh(wq_watchdog_thresh);
5870}
5871
5872#else /* CONFIG_WQ_WATCHDOG */
5873
5874static inline void wq_watchdog_init(void) { }
5875
5876#endif /* CONFIG_WQ_WATCHDOG */
5877
Tejun Heobce90382013-04-01 11:23:32 -07005878static void __init wq_numa_init(void)
5879{
5880 cpumask_var_t *tbl;
5881 int node, cpu;
5882
Tejun Heobce90382013-04-01 11:23:32 -07005883 if (num_possible_nodes() <= 1)
5884 return;
5885
Tejun Heod55262c2013-04-01 11:23:38 -07005886 if (wq_disable_numa) {
5887 pr_info("workqueue: NUMA affinity support disabled\n");
5888 return;
5889 }
5890
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005891 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005892 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5893
Tejun Heobce90382013-04-01 11:23:32 -07005894 /*
5895 * We want masks of possible CPUs of each node which isn't readily
5896 * available. Build one from cpu_to_node() which should have been
5897 * fully initialized by now.
5898 */
Kees Cook6396bb22018-06-12 14:03:40 -07005899 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005900 BUG_ON(!tbl);
5901
5902 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005903 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005904 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005905
5906 for_each_possible_cpu(cpu) {
5907 node = cpu_to_node(cpu);
5908 if (WARN_ON(node == NUMA_NO_NODE)) {
5909 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5910 /* happens iff arch is bonkers, let's just proceed */
5911 return;
5912 }
5913 cpumask_set_cpu(cpu, tbl[node]);
5914 }
5915
5916 wq_numa_possible_cpumask = tbl;
5917 wq_numa_enabled = true;
5918}
5919
Tejun Heo3347fa02016-09-16 15:49:32 -04005920/**
5921 * workqueue_init_early - early init for workqueue subsystem
5922 *
5923 * This is the first half of two-staged workqueue subsystem initialization
5924 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5925 * idr are up. It sets up all the data structures and system workqueues
5926 * and allows early boot code to create workqueues and queue/cancel work
5927 * items. Actual work item execution starts only after kthreads can be
5928 * created and scheduled right before early initcalls.
5929 */
Yu Chen2333e822020-02-23 15:28:52 +08005930void __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005931{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005932 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005933 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005934 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005935
Lai Jiangshan10cdb152020-06-01 08:44:40 +00005936 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
Tejun Heoe904e6c2013-03-12 11:29:57 -07005937
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005938 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005939 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005940
Tejun Heoe904e6c2013-03-12 11:29:57 -07005941 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5942
Tejun Heo706026c2013-01-24 11:01:34 -08005943 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005944 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005945 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005946
Tejun Heo7a4e3442013-03-12 11:30:00 -07005947 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005948 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005949 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005950 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005951 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005952 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005953 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005954
Tejun Heo9daf9e62013-01-24 11:01:33 -08005955 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005956 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005957 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005958 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005959 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005960 }
5961
Tejun Heo8a2b7532013-09-05 12:30:04 -04005962 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005963 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5964 struct workqueue_attrs *attrs;
5965
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005966 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07005967 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005968 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005969
5970 /*
5971 * An ordered wq should have only one pwq as ordering is
5972 * guaranteed by max_active which is enforced by pwqs.
5973 * Turn off NUMA so that dfl_pwq is used for all nodes.
5974 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005975 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04005976 attrs->nice = std_nice[i];
5977 attrs->no_numa = true;
5978 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005979 }
5980
Tejun Heod320c032010-06-29 10:07:14 +02005981 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005982 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005983 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005984 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5985 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005986 system_freezable_wq = alloc_workqueue("events_freezable",
5987 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305988 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5989 WQ_POWER_EFFICIENT, 0);
5990 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5991 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5992 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005993 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305994 !system_unbound_wq || !system_freezable_wq ||
5995 !system_power_efficient_wq ||
5996 !system_freezable_power_efficient_wq);
Tejun Heo3347fa02016-09-16 15:49:32 -04005997}
5998
5999/**
6000 * workqueue_init - bring workqueue subsystem fully online
6001 *
6002 * This is the latter half of two-staged workqueue subsystem initialization
6003 * and invoked as soon as kthreads can be created and scheduled.
6004 * Workqueues have been created and work items queued on them, but there
6005 * are no kworkers executing the work items yet. Populate the worker pools
6006 * with the initial workers and enable future kworker creations.
6007 */
Yu Chen2333e822020-02-23 15:28:52 +08006008void __init workqueue_init(void)
Tejun Heo3347fa02016-09-16 15:49:32 -04006009{
Tejun Heo2186d9f2016-10-19 12:01:27 -04006010 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04006011 struct worker_pool *pool;
6012 int cpu, bkt;
6013
Tejun Heo2186d9f2016-10-19 12:01:27 -04006014 /*
6015 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6016 * CPU to node mapping may not be available that early on some
6017 * archs such as power and arm64. As per-cpu pools created
6018 * previously could be missing node hint and unbound pools NUMA
6019 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08006020 *
6021 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006022 */
6023 wq_numa_init();
6024
6025 mutex_lock(&wq_pool_mutex);
6026
6027 for_each_possible_cpu(cpu) {
6028 for_each_cpu_worker_pool(pool, cpu) {
6029 pool->node = cpu_to_node(cpu);
6030 }
6031 }
6032
Tejun Heo40c17f72018-01-08 05:38:37 -08006033 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006034 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006035 WARN(init_rescuer(wq),
6036 "workqueue: failed to create early rescuer for %s",
6037 wq->name);
6038 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006039
6040 mutex_unlock(&wq_pool_mutex);
6041
Tejun Heo3347fa02016-09-16 15:49:32 -04006042 /* create the initial workers */
6043 for_each_online_cpu(cpu) {
6044 for_each_cpu_worker_pool(pool, cpu) {
6045 pool->flags &= ~POOL_DISASSOCIATED;
6046 BUG_ON(!create_worker(pool));
6047 }
6048 }
6049
6050 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6051 BUG_ON(!create_worker(pool));
6052
6053 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006054 wq_watchdog_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006055}