blob: 437935e7a1991156120a29aadffb03eb52fe5723 [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
Tejun Heo4690c4a2010-06-29 10:07:10 +02001330 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001331 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001332 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001333 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001334
1335 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001336 * Ensure either wq_worker_sleeping() sees the above
1337 * list_add_tail() or we see zero nr_running to avoid workers lying
1338 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001339 */
1340 smp_mb();
1341
Tejun Heo63d95a92012-07-12 14:46:37 -07001342 if (__need_more_worker(pool))
1343 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001344}
1345
Tejun Heoc8efcc22010-12-20 19:32:04 +01001346/*
1347 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001348 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001349 */
1350static bool is_chained_work(struct workqueue_struct *wq)
1351{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001352 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001353
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001354 worker = current_wq_worker();
1355 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001356 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001357 * I'm @worker, it's safe to dereference it without locking.
1358 */
Tejun Heo112202d2013-02-13 19:29:12 -08001359 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001360}
1361
Mike Galbraithef5571802016-02-09 17:59:38 -05001362/*
1363 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1364 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1365 * avoid perturbing sensitive tasks.
1366 */
1367static int wq_select_unbound_cpu(int cpu)
1368{
Tejun Heof303fccb2016-02-09 17:59:38 -05001369 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001370 int new_cpu;
1371
Tejun Heof303fccb2016-02-09 17:59:38 -05001372 if (likely(!wq_debug_force_rr_cpu)) {
1373 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1374 return cpu;
1375 } else if (!printed_dbg_warning) {
1376 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1377 printed_dbg_warning = true;
1378 }
1379
Mike Galbraithef5571802016-02-09 17:59:38 -05001380 if (cpumask_empty(wq_unbound_cpumask))
1381 return cpu;
1382
1383 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1384 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1385 if (unlikely(new_cpu >= nr_cpu_ids)) {
1386 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1387 if (unlikely(new_cpu >= nr_cpu_ids))
1388 return cpu;
1389 }
1390 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1391
1392 return new_cpu;
1393}
1394
Tejun Heod84ff052013-03-12 11:29:59 -07001395static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 struct work_struct *work)
1397{
Tejun Heo112202d2013-02-13 19:29:12 -08001398 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001399 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001400 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001401 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001402 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001403
1404 /*
1405 * While a work item is PENDING && off queue, a task trying to
1406 * steal the PENDING will busy-loop waiting for it to either get
1407 * queued or lose PENDING. Grabbing PENDING and queueing should
1408 * happen with IRQ disabled.
1409 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001410 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001412 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001413
Li Bin9ef28a72013-09-09 13:13:58 +08001414 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001415 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001416 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001417 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001418 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001419retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001420 /* pwq which will be used unless @work is executing elsewhere */
Hillf Dantonaa202f12020-01-24 20:14:45 -05001421 if (wq->flags & WQ_UNBOUND) {
1422 if (req_cpu == WORK_CPU_UNBOUND)
1423 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001424 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Dantonaa202f12020-01-24 20:14:45 -05001425 } else {
1426 if (req_cpu == WORK_CPU_UNBOUND)
1427 cpu = raw_smp_processor_id();
1428 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1429 }
Tejun Heodbf25762012-08-20 14:51:23 -07001430
Tejun Heoc9178082013-03-12 11:30:04 -07001431 /*
1432 * If @work was previously on a different pool, it might still be
1433 * running there, in which case the work needs to be queued on that
1434 * pool to guarantee non-reentrancy.
1435 */
1436 last_pool = get_work_pool(work);
1437 if (last_pool && last_pool != pwq->pool) {
1438 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001439
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001440 raw_spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001441
Tejun Heoc9178082013-03-12 11:30:04 -07001442 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001443
Tejun Heoc9178082013-03-12 11:30:04 -07001444 if (worker && worker->current_pwq->wq == wq) {
1445 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001446 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001447 /* meh... not running there, queue here */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001448 raw_spin_unlock(&last_pool->lock);
1449 raw_spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001450 }
Tejun Heof3421792010-07-02 10:03:51 +02001451 } else {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001452 raw_spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001453 }
1454
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001455 /*
1456 * pwq is determined and locked. For unbound pools, we could have
1457 * raced with pwq release and it could already be dead. If its
1458 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001459 * without another pwq replacing it in the numa_pwq_tbl or while
1460 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001461 * make forward-progress.
1462 */
1463 if (unlikely(!pwq->refcnt)) {
1464 if (wq->flags & WQ_UNBOUND) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001465 raw_spin_unlock(&pwq->pool->lock);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001466 cpu_relax();
1467 goto retry;
1468 }
1469 /* oops */
1470 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1471 wq->name, cpu);
1472 }
1473
Tejun Heo112202d2013-02-13 19:29:12 -08001474 /* pwq determined, queue */
1475 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001476
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001477 if (WARN_ON(!list_empty(&work->entry)))
1478 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001479
Tejun Heo112202d2013-02-13 19:29:12 -08001480 pwq->nr_in_flight[pwq->work_color]++;
1481 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001482
Tejun Heo112202d2013-02-13 19:29:12 -08001483 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001484 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001485 pwq->nr_active++;
1486 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001487 if (list_empty(worklist))
1488 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001489 } else {
1490 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001491 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001492 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001493
Tejun Heo112202d2013-02-13 19:29:12 -08001494 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001495
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001496out:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001497 raw_spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001498 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499}
1500
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001501/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001502 * queue_work_on - queue work on specific cpu
1503 * @cpu: CPU number to execute work on
1504 * @wq: workqueue to use
1505 * @work: work to queue
1506 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001507 * We queue the work to a specific CPU, the caller must ensure it
1508 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001509 *
1510 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001511 */
Tejun Heod4283e92012-08-03 10:30:44 -07001512bool queue_work_on(int cpu, struct workqueue_struct *wq,
1513 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001514{
Tejun Heod4283e92012-08-03 10:30:44 -07001515 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001516 unsigned long flags;
1517
1518 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001519
Tejun Heo22df02b2010-06-29 10:07:10 +02001520 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001521 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001522 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001523 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001524
1525 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001526 return ret;
1527}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001528EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001529
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001530/**
1531 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1532 * @node: NUMA node ID that we want to select a CPU from
1533 *
1534 * This function will attempt to find a "random" cpu available on a given
1535 * node. If there are no CPUs available on the given node it will return
1536 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1537 * available CPU if we need to schedule this work.
1538 */
1539static int workqueue_select_cpu_near(int node)
1540{
1541 int cpu;
1542
1543 /* No point in doing this if NUMA isn't enabled for workqueues */
1544 if (!wq_numa_enabled)
1545 return WORK_CPU_UNBOUND;
1546
1547 /* Delay binding to CPU if node is not valid or online */
1548 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1549 return WORK_CPU_UNBOUND;
1550
1551 /* Use local node/cpu if we are already there */
1552 cpu = raw_smp_processor_id();
1553 if (node == cpu_to_node(cpu))
1554 return cpu;
1555
1556 /* Use "random" otherwise know as "first" online CPU of node */
1557 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1558
1559 /* If CPU is valid return that, otherwise just defer */
1560 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1561}
1562
1563/**
1564 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1565 * @node: NUMA node that we are targeting the work for
1566 * @wq: workqueue to use
1567 * @work: work to queue
1568 *
1569 * We queue the work to a "random" CPU within a given NUMA node. The basic
1570 * idea here is to provide a way to somehow associate work with a given
1571 * NUMA node.
1572 *
1573 * This function will only make a best effort attempt at getting this onto
1574 * the right NUMA node. If no node is requested or the requested node is
1575 * offline then we just fall back to standard queue_work behavior.
1576 *
1577 * Currently the "random" CPU ends up being the first available CPU in the
1578 * intersection of cpu_online_mask and the cpumask of the node, unless we
1579 * are running on the node. In that case we just use the current CPU.
1580 *
1581 * Return: %false if @work was already on a queue, %true otherwise.
1582 */
1583bool queue_work_node(int node, struct workqueue_struct *wq,
1584 struct work_struct *work)
1585{
1586 unsigned long flags;
1587 bool ret = false;
1588
1589 /*
1590 * This current implementation is specific to unbound workqueues.
1591 * Specifically we only return the first available CPU for a given
1592 * node instead of cycling through individual CPUs within the node.
1593 *
1594 * If this is used with a per-cpu workqueue then the logic in
1595 * workqueue_select_cpu_near would need to be updated to allow for
1596 * some round robin type logic.
1597 */
1598 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1599
1600 local_irq_save(flags);
1601
1602 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1603 int cpu = workqueue_select_cpu_near(node);
1604
1605 __queue_work(cpu, wq, work);
1606 ret = true;
1607 }
1608
1609 local_irq_restore(flags);
1610 return ret;
1611}
1612EXPORT_SYMBOL_GPL(queue_work_node);
1613
Kees Cook8c20feb2017-10-04 16:27:07 -07001614void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615{
Kees Cook8c20feb2017-10-04 16:27:07 -07001616 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001618 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001619 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001621EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001623static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1624 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001626 struct timer_list *timer = &dwork->timer;
1627 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Tejun Heo637fdba2017-03-06 15:33:42 -05001629 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001630 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001631 WARN_ON_ONCE(timer_pending(timer));
1632 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001633
Tejun Heo8852aac2012-12-01 16:23:42 -08001634 /*
1635 * If @delay is 0, queue @dwork->work immediately. This is for
1636 * both optimization and correctness. The earliest @timer can
1637 * expire is on the closest next tick and delayed_work users depend
1638 * on that there's no such delay when @delay is 0.
1639 */
1640 if (!delay) {
1641 __queue_work(cpu, wq, &dwork->work);
1642 return;
1643 }
1644
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001645 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001646 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001647 timer->expires = jiffies + delay;
1648
Tejun Heo041bd122016-02-09 16:11:26 -05001649 if (unlikely(cpu != WORK_CPU_UNBOUND))
1650 add_timer_on(timer, cpu);
1651 else
1652 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653}
1654
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001655/**
1656 * queue_delayed_work_on - queue work on specific CPU after delay
1657 * @cpu: CPU number to execute work on
1658 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001659 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001660 * @delay: number of jiffies to wait before queueing
1661 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001662 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001663 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1664 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001665 */
Tejun Heod4283e92012-08-03 10:30:44 -07001666bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1667 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001668{
David Howells52bad642006-11-22 14:54:01 +00001669 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001670 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001671 unsigned long flags;
1672
1673 /* read the comment in __queue_work() */
1674 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001675
Tejun Heo22df02b2010-06-29 10:07:10 +02001676 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001677 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001678 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001679 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001680
1681 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001682 return ret;
1683}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001684EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
Tejun Heoc8e55f32010-06-29 10:07:12 +02001686/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001687 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1688 * @cpu: CPU number to execute work on
1689 * @wq: workqueue to use
1690 * @dwork: work to queue
1691 * @delay: number of jiffies to wait before queueing
1692 *
1693 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1694 * modify @dwork's timer so that it expires after @delay. If @delay is
1695 * zero, @work is guaranteed to be scheduled immediately regardless of its
1696 * current state.
1697 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001698 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001699 * pending and its timer was modified.
1700 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001701 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001702 * See try_to_grab_pending() for details.
1703 */
1704bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1705 struct delayed_work *dwork, unsigned long delay)
1706{
1707 unsigned long flags;
1708 int ret;
1709
1710 do {
1711 ret = try_to_grab_pending(&dwork->work, true, &flags);
1712 } while (unlikely(ret == -EAGAIN));
1713
1714 if (likely(ret >= 0)) {
1715 __queue_delayed_work(cpu, wq, dwork, delay);
1716 local_irq_restore(flags);
1717 }
1718
1719 /* -ENOENT from try_to_grab_pending() becomes %true */
1720 return ret;
1721}
1722EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1723
Tejun Heo05f0fe62018-03-14 12:45:13 -07001724static void rcu_work_rcufn(struct rcu_head *rcu)
1725{
1726 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1727
1728 /* read the comment in __queue_work() */
1729 local_irq_disable();
1730 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1731 local_irq_enable();
1732}
1733
1734/**
1735 * queue_rcu_work - queue work after a RCU grace period
1736 * @wq: workqueue to use
1737 * @rwork: work to queue
1738 *
1739 * Return: %false if @rwork was already pending, %true otherwise. Note
1740 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001741 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001742 * execution may happen before a full RCU grace period has passed.
1743 */
1744bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1745{
1746 struct work_struct *work = &rwork->work;
1747
1748 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1749 rwork->wq = wq;
1750 call_rcu(&rwork->rcu, rcu_work_rcufn);
1751 return true;
1752 }
1753
1754 return false;
1755}
1756EXPORT_SYMBOL(queue_rcu_work);
1757
Tejun Heo8376fe22012-08-03 10:30:47 -07001758/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001759 * worker_enter_idle - enter idle state
1760 * @worker: worker which is entering idle state
1761 *
1762 * @worker is entering idle state. Update stats and idle timer if
1763 * necessary.
1764 *
1765 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001766 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001767 */
1768static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001770 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Tejun Heo6183c002013-03-12 11:29:57 -07001772 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1773 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1774 (worker->hentry.next || worker->hentry.pprev)))
1775 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Lai Jiangshan051e1852014-07-22 13:03:02 +08001777 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001778 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001779 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001780 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001781
Tejun Heoc8e55f32010-06-29 10:07:12 +02001782 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001783 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001784
Tejun Heo628c78e2012-07-17 12:39:27 -07001785 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1786 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001787
Tejun Heo544ecf32012-05-14 15:04:50 -07001788 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001789 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001790 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001791 * nr_running, the warning may trigger spuriously. Check iff
1792 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001793 */
Tejun Heo24647572013-01-24 11:01:33 -08001794 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001795 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001796 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797}
1798
Tejun Heoc8e55f32010-06-29 10:07:12 +02001799/**
1800 * worker_leave_idle - leave idle state
1801 * @worker: worker which is leaving idle state
1802 *
1803 * @worker is leaving idle state. Update stats.
1804 *
1805 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001806 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001807 */
1808static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001810 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Tejun Heo6183c002013-03-12 11:29:57 -07001812 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1813 return;
Tejun Heod302f012010-06-29 10:07:13 +02001814 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001815 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001816 list_del_init(&worker->entry);
1817}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001819static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001820{
1821 struct worker *worker;
1822
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001823 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001824 if (worker) {
1825 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001826 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001827 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001828 /* on creation a worker is in !idle && prep state */
1829 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001830 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001831 return worker;
1832}
1833
1834/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001835 * worker_attach_to_pool() - attach a worker to a pool
1836 * @worker: worker to be attached
1837 * @pool: the target pool
1838 *
1839 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1840 * cpu-binding of @worker are kept coordinated with the pool across
1841 * cpu-[un]hotplugs.
1842 */
1843static void worker_attach_to_pool(struct worker *worker,
1844 struct worker_pool *pool)
1845{
Tejun Heo1258fae2018-05-18 08:47:13 -07001846 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001847
1848 /*
1849 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1850 * online CPUs. It'll be re-applied when any of the CPUs come up.
1851 */
1852 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1853
1854 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001855 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1856 * stable across this function. See the comments above the flag
1857 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001858 */
1859 if (pool->flags & POOL_DISASSOCIATED)
1860 worker->flags |= WORKER_UNBOUND;
1861
1862 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001863 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001864
Tejun Heo1258fae2018-05-18 08:47:13 -07001865 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001866}
1867
1868/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001869 * worker_detach_from_pool() - detach a worker from its pool
1870 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001871 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001872 * Undo the attaching which had been done in worker_attach_to_pool(). The
1873 * caller worker shouldn't access to the pool after detached except it has
1874 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001875 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001876static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001877{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001878 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001879 struct completion *detach_completion = NULL;
1880
Tejun Heo1258fae2018-05-18 08:47:13 -07001881 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001882
Lai Jiangshanda028462014-05-20 17:46:31 +08001883 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001884 worker->pool = NULL;
1885
Lai Jiangshanda028462014-05-20 17:46:31 +08001886 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001887 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001888 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001889
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001890 /* clear leftover flags without pool->lock after it is detached */
1891 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1892
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001893 if (detach_completion)
1894 complete(detach_completion);
1895}
1896
1897/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001898 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001899 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001900 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001901 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001902 *
1903 * CONTEXT:
1904 * Might sleep. Does GFP_KERNEL allocations.
1905 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001906 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001907 * Pointer to the newly created worker.
1908 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001909static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001910{
Tejun Heoc34056a2010-06-29 10:07:11 +02001911 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001912 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001913 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001914
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001915 /* ID is needed to determine kthread name */
1916 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001917 if (id < 0)
1918 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001919
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001920 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001921 if (!worker)
1922 goto fail;
1923
Tejun Heoc34056a2010-06-29 10:07:11 +02001924 worker->id = id;
1925
Tejun Heo29c91e92013-03-12 11:30:03 -07001926 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001927 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1928 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001929 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001930 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1931
Tejun Heof3f90ad2013-04-01 11:23:34 -07001932 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001933 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001934 if (IS_ERR(worker->task))
1935 goto fail;
1936
Oleg Nesterov91151222013-11-14 12:56:18 +01001937 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001938 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001939
Lai Jiangshanda028462014-05-20 17:46:31 +08001940 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001941 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001942
Lai Jiangshan051e1852014-07-22 13:03:02 +08001943 /* start the newly created worker */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001944 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001945 worker->pool->nr_workers++;
1946 worker_enter_idle(worker);
1947 wake_up_process(worker->task);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001948 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001949
Tejun Heoc34056a2010-06-29 10:07:11 +02001950 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001951
Tejun Heoc34056a2010-06-29 10:07:11 +02001952fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001953 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001954 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001955 kfree(worker);
1956 return NULL;
1957}
1958
1959/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001960 * destroy_worker - destroy a workqueue worker
1961 * @worker: worker to be destroyed
1962 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001963 * Destroy @worker and adjust @pool stats accordingly. The worker should
1964 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001965 *
1966 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001967 * raw_spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001968 */
1969static void destroy_worker(struct worker *worker)
1970{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001971 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001972
Tejun Heocd549682013-03-13 19:47:39 -07001973 lockdep_assert_held(&pool->lock);
1974
Tejun Heoc34056a2010-06-29 10:07:11 +02001975 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001976 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001977 WARN_ON(!list_empty(&worker->scheduled)) ||
1978 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001979 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001980
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001981 pool->nr_workers--;
1982 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001983
Tejun Heoc8e55f32010-06-29 10:07:12 +02001984 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001985 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001986 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001987}
1988
Kees Cook32a6c722017-10-16 15:58:25 -07001989static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001990{
Kees Cook32a6c722017-10-16 15:58:25 -07001991 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001992
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001993 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001994
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001995 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 struct worker *worker;
1997 unsigned long expires;
1998
1999 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07002000 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002001 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2002
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002003 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002004 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002005 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002006 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002007
2008 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 }
2010
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002011 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002012}
2013
Tejun Heo493a1722013-03-12 11:29:59 -07002014static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002015{
Tejun Heo112202d2013-02-13 19:29:12 -08002016 struct pool_workqueue *pwq = get_work_pwq(work);
2017 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002018
Tejun Heo2e109a22013-03-13 19:47:40 -07002019 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002020
Tejun Heo493008a2013-03-12 11:30:03 -07002021 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002022 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002023
2024 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002025 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002026 /*
2027 * If @pwq is for an unbound wq, its base ref may be put at
2028 * any time due to an attribute change. Pin @pwq until the
2029 * rescuer is done with it.
2030 */
2031 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002032 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002034 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002035}
2036
Kees Cook32a6c722017-10-16 15:58:25 -07002037static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002038{
Kees Cook32a6c722017-10-16 15:58:25 -07002039 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002040 struct work_struct *work;
2041
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002042 raw_spin_lock_irq(&pool->lock);
2043 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002044
Tejun Heo63d95a92012-07-12 14:46:37 -07002045 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002046 /*
2047 * We've been trying to create a new worker but
2048 * haven't been successful. We might be hitting an
2049 * allocation deadlock. Send distress signals to
2050 * rescuers.
2051 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002052 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002053 send_mayday(work);
2054 }
2055
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002056 raw_spin_unlock(&wq_mayday_lock);
2057 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002058
Tejun Heo63d95a92012-07-12 14:46:37 -07002059 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002060}
2061
2062/**
2063 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002064 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002065 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002066 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002067 * have at least one idle worker on return from this function. If
2068 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002069 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002070 * possible allocation deadlock.
2071 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002072 * On return, need_to_create_worker() is guaranteed to be %false and
2073 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002074 *
2075 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002076 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002077 * multiple times. Does GFP_KERNEL allocations. Called only from
2078 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002079 */
Tejun Heo29187a92015-01-16 14:21:16 -05002080static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002081__releases(&pool->lock)
2082__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002083{
Tejun Heoe22bee72010-06-29 10:07:14 +02002084restart:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002085 raw_spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002086
Tejun Heoe22bee72010-06-29 10:07:14 +02002087 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002088 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002089
2090 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002091 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002092 break;
2093
Lai Jiangshane212f362014-06-03 15:32:17 +08002094 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002095
Tejun Heo63d95a92012-07-12 14:46:37 -07002096 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002097 break;
2098 }
2099
Tejun Heo63d95a92012-07-12 14:46:37 -07002100 del_timer_sync(&pool->mayday_timer);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002101 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002102 /*
2103 * This is necessary even after a new worker was just successfully
2104 * created as @pool->lock was dropped and the new worker might have
2105 * already become busy.
2106 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002107 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002108 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002109}
2110
2111/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002112 * manage_workers - manage worker pool
2113 * @worker: self
2114 *
Tejun Heo706026c2013-01-24 11:01:34 -08002115 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002116 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002117 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002118 *
2119 * The caller can safely start processing works on false return. On
2120 * true return, it's guaranteed that need_to_create_worker() is false
2121 * and may_start_working() is true.
2122 *
2123 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002124 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002125 * multiple times. Does GFP_KERNEL allocations.
2126 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002127 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002128 * %false if the pool doesn't need management and the caller can safely
2129 * start processing works, %true if management function was performed and
2130 * the conditions that the caller verified before calling the function may
2131 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002132 */
2133static bool manage_workers(struct worker *worker)
2134{
Tejun Heo63d95a92012-07-12 14:46:37 -07002135 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002136
Tejun Heo692b4822017-10-09 08:04:13 -07002137 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002138 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002139
2140 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002141 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002142
Tejun Heo29187a92015-01-16 14:21:16 -05002143 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002144
Tejun Heo2607d7a2015-03-09 09:22:28 -04002145 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002146 pool->flags &= ~POOL_MANAGER_ACTIVE;
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02002147 rcuwait_wake_up(&manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002148 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002149}
2150
Tejun Heoa62428c2010-06-29 10:07:10 +02002151/**
2152 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002153 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002154 * @work: work to process
2155 *
2156 * Process @work. This function contains all the logics necessary to
2157 * process a single work including synchronization against and
2158 * interaction with other workers on the same cpu, queueing and
2159 * flushing. As long as context requirement is met, any worker can
2160 * call this function to process a work.
2161 *
2162 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002163 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002164 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002165static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002166__releases(&pool->lock)
2167__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002168{
Tejun Heo112202d2013-02-13 19:29:12 -08002169 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002170 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002171 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002172 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002173 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002174#ifdef CONFIG_LOCKDEP
2175 /*
2176 * It is permissible to free the struct work_struct from
2177 * inside the function that is called from it, this we need to
2178 * take into account for lockdep too. To avoid bogus "held
2179 * lock freed" warnings as well as problems when looking into
2180 * work->lockdep_map, make a copy and use that here.
2181 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002182 struct lockdep_map lockdep_map;
2183
2184 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002185#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002186 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002187 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002188 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002189
Tejun Heo7e116292010-06-29 10:07:13 +02002190 /*
2191 * A single work shouldn't be executed concurrently by
2192 * multiple workers on a single cpu. Check whether anyone is
2193 * already processing the work. If so, defer the work to the
2194 * currently executing one.
2195 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002196 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002197 if (unlikely(collision)) {
2198 move_linked_works(work, &collision->scheduled, NULL);
2199 return;
2200 }
2201
Tejun Heo8930cab2012-08-03 10:30:45 -07002202 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002203 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002204 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002205 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002206 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002207 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002208 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002209
Tejun Heo8bf89592018-05-18 08:47:13 -07002210 /*
2211 * Record wq name for cmdline and debug reporting, may get
2212 * overridden through set_worker_desc().
2213 */
2214 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2215
Tejun Heoa62428c2010-06-29 10:07:10 +02002216 list_del_init(&work->entry);
2217
Tejun Heo649027d2010-06-29 10:07:14 +02002218 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002219 * CPU intensive works don't participate in concurrency management.
2220 * They're the scheduler's responsibility. This takes @worker out
2221 * of concurrency management and the next code block will chain
2222 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002223 */
2224 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002225 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002226
Tejun Heo974271c2012-07-12 14:46:37 -07002227 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002228 * Wake up another worker if necessary. The condition is always
2229 * false for normal per-cpu workers since nr_running would always
2230 * be >= 1 at this point. This is used to chain execution of the
2231 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002232 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002233 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002234 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002235 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002236
Tejun Heo8930cab2012-08-03 10:30:45 -07002237 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002238 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002239 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002240 * PENDING and queued state changes happen together while IRQ is
2241 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002242 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002243 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002244
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002245 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002246
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002247 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002248 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002249 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002250 * Strictly speaking we should mark the invariant state without holding
2251 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002252 *
2253 * However, that would result in:
2254 *
2255 * A(W1)
2256 * WFC(C)
2257 * A(W1)
2258 * C(C)
2259 *
2260 * Which would create W1->C->W1 dependencies, even though there is no
2261 * actual deadlock possible. There are two solutions, using a
2262 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002263 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002264 * these locks.
2265 *
2266 * AFAICT there is no possible deadlock scenario between the
2267 * flush_work() and complete() primitives (except for single-threaded
2268 * workqueues), so hiding them isn't a problem.
2269 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002270 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002271 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002272 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002273 /*
2274 * While we must be careful to not use "work" after this, the trace
2275 * point will only record its address.
2276 */
Daniel Jordan1c5da0e2020-01-13 17:52:39 -05002277 trace_workqueue_execute_end(work, worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002278 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002279 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002280
2281 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002282 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002283 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002284 current->comm, preempt_count(), task_pid_nr(current),
2285 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002286 debug_show_held_locks(current);
2287 dump_stack();
2288 }
2289
Tejun Heob22ce272013-08-28 17:33:37 -04002290 /*
Sebastian Andrzej Siewior025f50f2019-10-15 21:18:21 +02002291 * The following prevents a kworker from hogging CPU on !PREEMPTION
Tejun Heob22ce272013-08-28 17:33:37 -04002292 * kernels, where a requeueing work item waiting for something to
2293 * happen could deadlock with stop_machine as such work item could
2294 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002295 * stop_machine. At the same time, report a quiescent RCU state so
2296 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002297 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002298 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002299
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002300 raw_spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002301
Tejun Heofb0e7be2010-06-29 10:07:15 +02002302 /* clear cpu intensive status */
2303 if (unlikely(cpu_intensive))
2304 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2305
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002306 /* tag the worker for identification in schedule() */
2307 worker->last_func = worker->current_func;
2308
Tejun Heoa62428c2010-06-29 10:07:10 +02002309 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002310 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002311 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002312 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002313 worker->current_pwq = NULL;
2314 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002315}
2316
Tejun Heoaffee4b2010-06-29 10:07:12 +02002317/**
2318 * process_scheduled_works - process scheduled works
2319 * @worker: self
2320 *
2321 * Process all scheduled works. Please note that the scheduled list
2322 * may change while processing a work, so this function repeatedly
2323 * fetches a work from the top and executes it.
2324 *
2325 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002326 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002327 * multiple times.
2328 */
2329static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002331 while (!list_empty(&worker->scheduled)) {
2332 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002334 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336}
2337
Tejun Heo197f6ac2018-05-21 08:04:35 -07002338static void set_pf_worker(bool val)
2339{
2340 mutex_lock(&wq_pool_attach_mutex);
2341 if (val)
2342 current->flags |= PF_WQ_WORKER;
2343 else
2344 current->flags &= ~PF_WQ_WORKER;
2345 mutex_unlock(&wq_pool_attach_mutex);
2346}
2347
Tejun Heo4690c4a2010-06-29 10:07:10 +02002348/**
2349 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002350 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002351 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002352 * The worker thread function. All workers belong to a worker_pool -
2353 * either a per-cpu one or dynamic unbound one. These workers process all
2354 * work items regardless of their specific target workqueue. The only
2355 * exception is work items which belong to workqueues with a rescuer which
2356 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002357 *
2358 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002359 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002360static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361{
Tejun Heoc34056a2010-06-29 10:07:11 +02002362 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002363 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364
Tejun Heoe22bee72010-06-29 10:07:14 +02002365 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002366 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002367woke_up:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002368 raw_spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002369
Tejun Heoa9ab7752013-03-19 13:45:21 -07002370 /* am I supposed to die? */
2371 if (unlikely(worker->flags & WORKER_DIE)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002372 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002373 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002374 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002375
2376 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002377 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002378 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002379 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002380 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002382
Tejun Heoc8e55f32010-06-29 10:07:12 +02002383 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002384recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002385 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002386 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002387 goto sleep;
2388
2389 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002390 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 goto recheck;
2392
Tejun Heoc8e55f32010-06-29 10:07:12 +02002393 /*
2394 * ->scheduled list can only be filled while a worker is
2395 * preparing to process a work or actually processing it.
2396 * Make sure nobody diddled with it while I was sleeping.
2397 */
Tejun Heo6183c002013-03-12 11:29:57 -07002398 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002399
Tejun Heoe22bee72010-06-29 10:07:14 +02002400 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002401 * Finish PREP stage. We're guaranteed to have at least one idle
2402 * worker or that someone else has already assumed the manager
2403 * role. This is where @worker starts participating in concurrency
2404 * management if applicable and concurrency management is restored
2405 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002406 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002407 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002408
2409 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002410 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002411 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002412 struct work_struct, entry);
2413
Tejun Heo82607adc2015-12-08 11:28:04 -05002414 pool->watchdog_ts = jiffies;
2415
Tejun Heoc8e55f32010-06-29 10:07:12 +02002416 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2417 /* optimization path, not strictly necessary */
2418 process_one_work(worker, work);
2419 if (unlikely(!list_empty(&worker->scheduled)))
2420 process_scheduled_works(worker);
2421 } else {
2422 move_linked_works(work, &worker->scheduled, NULL);
2423 process_scheduled_works(worker);
2424 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002425 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002426
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002427 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002428sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002429 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002430 * pool->lock is held and there's no work to process and no need to
2431 * manage, sleep. Workers are woken up only while holding
2432 * pool->lock or from local cpu, so setting the current state
2433 * before releasing pool->lock is enough to prevent losing any
2434 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002435 */
2436 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002437 __set_current_state(TASK_IDLE);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002438 raw_spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002439 schedule();
2440 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441}
2442
Tejun Heoe22bee72010-06-29 10:07:14 +02002443/**
2444 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002445 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002446 *
2447 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002448 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002449 *
Tejun Heo706026c2013-01-24 11:01:34 -08002450 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002451 * worker which uses GFP_KERNEL allocation which has slight chance of
2452 * developing into deadlock if some works currently on the same queue
2453 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2454 * the problem rescuer solves.
2455 *
Tejun Heo706026c2013-01-24 11:01:34 -08002456 * When such condition is possible, the pool summons rescuers of all
2457 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002458 * those works so that forward progress can be guaranteed.
2459 *
2460 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002461 *
2462 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002463 */
Tejun Heo111c2252013-01-17 17:16:24 -08002464static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002465{
Tejun Heo111c2252013-01-17 17:16:24 -08002466 struct worker *rescuer = __rescuer;
2467 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002468 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002469 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002470
2471 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002472
2473 /*
2474 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2475 * doesn't participate in concurrency management.
2476 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002477 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002478repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002479 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002480
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002481 /*
2482 * By the time the rescuer is requested to stop, the workqueue
2483 * shouldn't have any work pending, but @wq->maydays may still have
2484 * pwq(s) queued. This can happen by non-rescuer workers consuming
2485 * all the work items before the rescuer got to them. Go through
2486 * @wq->maydays processing before acting on should_stop so that the
2487 * list is always empty on exit.
2488 */
2489 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002490
Tejun Heo493a1722013-03-12 11:29:59 -07002491 /* see whether any pwq is asking for help */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002492 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002493
2494 while (!list_empty(&wq->maydays)) {
2495 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2496 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002497 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002498 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002499 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002500
2501 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002502 list_del_init(&pwq->mayday_node);
2503
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002504 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002505
Lai Jiangshan51697d392014-05-20 17:46:36 +08002506 worker_attach_to_pool(rescuer, pool);
2507
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002508 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002509
2510 /*
2511 * Slurp in all works issued via this workqueue and
2512 * process'em.
2513 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002514 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002515 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2516 if (get_work_pwq(work) == pwq) {
2517 if (first)
2518 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002519 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002520 }
2521 first = false;
2522 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002523
NeilBrown008847f2014-12-08 12:39:16 -05002524 if (!list_empty(scheduled)) {
2525 process_scheduled_works(rescuer);
2526
2527 /*
2528 * The above execution of rescued work items could
2529 * have created more to rescue through
2530 * pwq_activate_first_delayed() or chained
2531 * queueing. Let's put @pwq back on mayday list so
2532 * that such back-to-back work items, which may be
2533 * being used to relieve memory pressure, don't
2534 * incur MAYDAY_INTERVAL delay inbetween.
2535 */
Lai Jiangshan4f3f4cf2020-05-29 06:58:59 +00002536 if (pwq->nr_active && need_to_create_worker(pool)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002537 raw_spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002538 /*
2539 * Queue iff we aren't racing destruction
2540 * and somebody else hasn't queued it already.
2541 */
2542 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2543 get_pwq(pwq);
2544 list_add_tail(&pwq->mayday_node, &wq->maydays);
2545 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002546 raw_spin_unlock(&wq_mayday_lock);
NeilBrown008847f2014-12-08 12:39:16 -05002547 }
2548 }
Tejun Heo75769582011-02-14 14:04:46 +01002549
2550 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002551 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002552 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002553 */
2554 put_pwq(pwq);
2555
2556 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002557 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002558 * regular worker; otherwise, we end up with 0 concurrency
2559 * and stalling the execution.
2560 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002561 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002562 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002563
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002564 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002565
Tejun Heoa2d812a2018-05-18 08:47:13 -07002566 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002567
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002568 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002569 }
2570
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002571 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002572
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002573 if (should_stop) {
2574 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002575 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002576 return 0;
2577 }
2578
Tejun Heo111c2252013-01-17 17:16:24 -08002579 /* rescuers should never participate in concurrency management */
2580 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002581 schedule();
2582 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583}
2584
Tejun Heofca839c2015-12-07 10:58:57 -05002585/**
2586 * check_flush_dependency - check for flush dependency sanity
2587 * @target_wq: workqueue being flushed
2588 * @target_work: work item being flushed (NULL for workqueue flushes)
2589 *
2590 * %current is trying to flush the whole @target_wq or @target_work on it.
2591 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2592 * reclaiming memory or running on a workqueue which doesn't have
2593 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2594 * a deadlock.
2595 */
2596static void check_flush_dependency(struct workqueue_struct *target_wq,
2597 struct work_struct *target_work)
2598{
2599 work_func_t target_func = target_work ? target_work->func : NULL;
2600 struct worker *worker;
2601
2602 if (target_wq->flags & WQ_MEM_RECLAIM)
2603 return;
2604
2605 worker = current_wq_worker();
2606
2607 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002608 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002609 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002610 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2611 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002612 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002613 worker->current_pwq->wq->name, worker->current_func,
2614 target_wq->name, target_func);
2615}
2616
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002617struct wq_barrier {
2618 struct work_struct work;
2619 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002620 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002621};
2622
2623static void wq_barrier_func(struct work_struct *work)
2624{
2625 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2626 complete(&barr->done);
2627}
2628
Tejun Heo4690c4a2010-06-29 10:07:10 +02002629/**
2630 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002631 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002632 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002633 * @target: target work to attach @barr to
2634 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002635 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002636 * @barr is linked to @target such that @barr is completed only after
2637 * @target finishes execution. Please note that the ordering
2638 * guarantee is observed only with respect to @target and on the local
2639 * cpu.
2640 *
2641 * Currently, a queued barrier can't be canceled. This is because
2642 * try_to_grab_pending() can't determine whether the work to be
2643 * grabbed is at the head of the queue and thus can't clear LINKED
2644 * flag of the previous work while there must be a valid next work
2645 * after a work with LINKED flag set.
2646 *
2647 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002648 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002649 *
2650 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002651 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002652 */
Tejun Heo112202d2013-02-13 19:29:12 -08002653static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002654 struct wq_barrier *barr,
2655 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002656{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002657 struct list_head *head;
2658 unsigned int linked = 0;
2659
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002660 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002661 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002662 * as we know for sure that this will not trigger any of the
2663 * checks and call back into the fixup functions where we
2664 * might deadlock.
2665 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002666 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002667 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002668
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002669 init_completion_map(&barr->done, &target->lockdep_map);
2670
Tejun Heo2607d7a2015-03-09 09:22:28 -04002671 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002672
Tejun Heoaffee4b2010-06-29 10:07:12 +02002673 /*
2674 * If @target is currently being executed, schedule the
2675 * barrier to the worker; otherwise, put it after @target.
2676 */
2677 if (worker)
2678 head = worker->scheduled.next;
2679 else {
2680 unsigned long *bits = work_data_bits(target);
2681
2682 head = target->entry.next;
2683 /* there can already be other linked works, inherit and set */
2684 linked = *bits & WORK_STRUCT_LINKED;
2685 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2686 }
2687
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002688 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002689 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002690 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002691}
2692
Tejun Heo73f53c42010-06-29 10:07:11 +02002693/**
Tejun Heo112202d2013-02-13 19:29:12 -08002694 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002695 * @wq: workqueue being flushed
2696 * @flush_color: new flush color, < 0 for no-op
2697 * @work_color: new work color, < 0 for no-op
2698 *
Tejun Heo112202d2013-02-13 19:29:12 -08002699 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002700 *
Tejun Heo112202d2013-02-13 19:29:12 -08002701 * If @flush_color is non-negative, flush_color on all pwqs should be
2702 * -1. If no pwq has in-flight commands at the specified color, all
2703 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2704 * has in flight commands, its pwq->flush_color is set to
2705 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002706 * wakeup logic is armed and %true is returned.
2707 *
2708 * The caller should have initialized @wq->first_flusher prior to
2709 * calling this function with non-negative @flush_color. If
2710 * @flush_color is negative, no flush color update is done and %false
2711 * is returned.
2712 *
Tejun Heo112202d2013-02-13 19:29:12 -08002713 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002714 * work_color which is previous to @work_color and all will be
2715 * advanced to @work_color.
2716 *
2717 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002718 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002719 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002720 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002721 * %true if @flush_color >= 0 and there's something to flush. %false
2722 * otherwise.
2723 */
Tejun Heo112202d2013-02-13 19:29:12 -08002724static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002725 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726{
Tejun Heo73f53c42010-06-29 10:07:11 +02002727 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002728 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002729
Tejun Heo73f53c42010-06-29 10:07:11 +02002730 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002731 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002732 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002733 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002734
Tejun Heo49e3cf42013-03-12 11:29:58 -07002735 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002736 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002737
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002738 raw_spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002739
2740 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002741 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002742
Tejun Heo112202d2013-02-13 19:29:12 -08002743 if (pwq->nr_in_flight[flush_color]) {
2744 pwq->flush_color = flush_color;
2745 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002746 wait = true;
2747 }
2748 }
2749
2750 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002751 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002752 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002753 }
2754
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002755 raw_spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002756 }
2757
Tejun Heo112202d2013-02-13 19:29:12 -08002758 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002759 complete(&wq->first_flusher->done);
2760
2761 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762}
2763
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002764/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002766 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002768 * This function sleeps until all work items which were queued on entry
2769 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002771void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772{
Tejun Heo73f53c42010-06-29 10:07:11 +02002773 struct wq_flusher this_flusher = {
2774 .list = LIST_HEAD_INIT(this_flusher.list),
2775 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002776 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002777 };
2778 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002779
Tejun Heo3347fa02016-09-16 15:49:32 -04002780 if (WARN_ON(!wq_online))
2781 return;
2782
Johannes Berg87915ad2018-08-22 11:49:04 +02002783 lock_map_acquire(&wq->lockdep_map);
2784 lock_map_release(&wq->lockdep_map);
2785
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002786 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002787
2788 /*
2789 * Start-to-wait phase
2790 */
2791 next_color = work_next_color(wq->work_color);
2792
2793 if (next_color != wq->flush_color) {
2794 /*
2795 * Color space is not full. The current work_color
2796 * becomes our flush_color and work_color is advanced
2797 * by one.
2798 */
Tejun Heo6183c002013-03-12 11:29:57 -07002799 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002800 this_flusher.flush_color = wq->work_color;
2801 wq->work_color = next_color;
2802
2803 if (!wq->first_flusher) {
2804 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002805 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002806
2807 wq->first_flusher = &this_flusher;
2808
Tejun Heo112202d2013-02-13 19:29:12 -08002809 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002810 wq->work_color)) {
2811 /* nothing to flush, done */
2812 wq->flush_color = next_color;
2813 wq->first_flusher = NULL;
2814 goto out_unlock;
2815 }
2816 } else {
2817 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002818 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002819 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002820 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002821 }
2822 } else {
2823 /*
2824 * Oops, color space is full, wait on overflow queue.
2825 * The next flush completion will assign us
2826 * flush_color and transfer to flusher_queue.
2827 */
2828 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2829 }
2830
Tejun Heofca839c2015-12-07 10:58:57 -05002831 check_flush_dependency(wq, NULL);
2832
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002833 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002834
2835 wait_for_completion(&this_flusher.done);
2836
2837 /*
2838 * Wake-up-and-cascade phase
2839 *
2840 * First flushers are responsible for cascading flushes and
2841 * handling overflow. Non-first flushers can simply return.
2842 */
Chris Wilson00d5d152020-03-10 16:23:19 +00002843 if (READ_ONCE(wq->first_flusher) != &this_flusher)
Tejun Heo73f53c42010-06-29 10:07:11 +02002844 return;
2845
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002846 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002847
Tejun Heo4ce48b32010-07-02 10:03:51 +02002848 /* we might have raced, check again with mutex held */
2849 if (wq->first_flusher != &this_flusher)
2850 goto out_unlock;
2851
Chris Wilson00d5d152020-03-10 16:23:19 +00002852 WRITE_ONCE(wq->first_flusher, NULL);
Tejun Heo73f53c42010-06-29 10:07:11 +02002853
Tejun Heo6183c002013-03-12 11:29:57 -07002854 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2855 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002856
2857 while (true) {
2858 struct wq_flusher *next, *tmp;
2859
2860 /* complete all the flushers sharing the current flush color */
2861 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2862 if (next->flush_color != wq->flush_color)
2863 break;
2864 list_del_init(&next->list);
2865 complete(&next->done);
2866 }
2867
Tejun Heo6183c002013-03-12 11:29:57 -07002868 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2869 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002870
2871 /* this flush_color is finished, advance by one */
2872 wq->flush_color = work_next_color(wq->flush_color);
2873
2874 /* one color has been freed, handle overflow queue */
2875 if (!list_empty(&wq->flusher_overflow)) {
2876 /*
2877 * Assign the same color to all overflowed
2878 * flushers, advance work_color and append to
2879 * flusher_queue. This is the start-to-wait
2880 * phase for these overflowed flushers.
2881 */
2882 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2883 tmp->flush_color = wq->work_color;
2884
2885 wq->work_color = work_next_color(wq->work_color);
2886
2887 list_splice_tail_init(&wq->flusher_overflow,
2888 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002889 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002890 }
2891
2892 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002893 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002894 break;
2895 }
2896
2897 /*
2898 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002899 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002900 */
Tejun Heo6183c002013-03-12 11:29:57 -07002901 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2902 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002903
2904 list_del_init(&next->list);
2905 wq->first_flusher = next;
2906
Tejun Heo112202d2013-02-13 19:29:12 -08002907 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002908 break;
2909
2910 /*
2911 * Meh... this color is already done, clear first
2912 * flusher and repeat cascading.
2913 */
2914 wq->first_flusher = NULL;
2915 }
2916
2917out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002918 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002920EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002922/**
2923 * drain_workqueue - drain a workqueue
2924 * @wq: workqueue to drain
2925 *
2926 * Wait until the workqueue becomes empty. While draining is in progress,
2927 * only chain queueing is allowed. IOW, only currently pending or running
2928 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002929 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002930 * by the depth of chaining and should be relatively short. Whine if it
2931 * takes too long.
2932 */
2933void drain_workqueue(struct workqueue_struct *wq)
2934{
2935 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002936 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002937
2938 /*
2939 * __queue_work() needs to test whether there are drainers, is much
2940 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002941 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002942 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002943 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002944 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002945 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002946 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002947reflush:
2948 flush_workqueue(wq);
2949
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002950 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002951
Tejun Heo49e3cf42013-03-12 11:29:58 -07002952 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002953 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002954
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002955 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002956 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002957 raw_spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002958
2959 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002960 continue;
2961
2962 if (++flush_cnt == 10 ||
2963 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002964 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002965 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002966
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002967 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002968 goto reflush;
2969 }
2970
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002971 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002972 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002973 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002974}
2975EXPORT_SYMBOL_GPL(drain_workqueue);
2976
Johannes Bergd6e89782018-08-22 11:49:03 +02002977static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2978 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002979{
2980 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002981 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002982 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002983
2984 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002985
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002986 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002987 pool = get_work_pool(work);
2988 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002989 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002990 return false;
2991 }
2992
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002993 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002994 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002995 pwq = get_work_pwq(work);
2996 if (pwq) {
2997 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002998 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002999 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003000 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003001 if (!worker)
3002 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003003 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003004 }
Tejun Heobaf59022010-09-16 10:42:16 +02003005
Tejun Heofca839c2015-12-07 10:58:57 -05003006 check_flush_dependency(pwq->wq, work);
3007
Tejun Heo112202d2013-02-13 19:29:12 -08003008 insert_wq_barrier(pwq, barr, work, worker);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003009 raw_spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003010
Tejun Heoe159489b2011-01-09 23:32:15 +01003011 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003012 * Force a lock recursion deadlock when using flush_work() inside a
3013 * single-threaded or rescuer equipped workqueue.
3014 *
3015 * For single threaded workqueues the deadlock happens when the work
3016 * is after the work issuing the flush_work(). For rescuer equipped
3017 * workqueues the deadlock happens when the rescuer stalls, blocking
3018 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003019 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003020 if (!from_cancel &&
3021 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003022 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003023 lock_map_release(&pwq->wq->lockdep_map);
3024 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003025 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003026 return true;
3027already_gone:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003028 raw_spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003029 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003030 return false;
3031}
3032
Johannes Bergd6e89782018-08-22 11:49:03 +02003033static bool __flush_work(struct work_struct *work, bool from_cancel)
3034{
3035 struct wq_barrier barr;
3036
3037 if (WARN_ON(!wq_online))
3038 return false;
3039
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003040 if (WARN_ON(!work->func))
3041 return false;
3042
Johannes Berg87915ad2018-08-22 11:49:04 +02003043 if (!from_cancel) {
3044 lock_map_acquire(&work->lockdep_map);
3045 lock_map_release(&work->lockdep_map);
3046 }
3047
Johannes Bergd6e89782018-08-22 11:49:03 +02003048 if (start_flush_work(work, &barr, from_cancel)) {
3049 wait_for_completion(&barr.done);
3050 destroy_work_on_stack(&barr.work);
3051 return true;
3052 } else {
3053 return false;
3054 }
3055}
3056
Oleg Nesterovdb700892008-07-25 01:47:49 -07003057/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003058 * flush_work - wait for a work to finish executing the last queueing instance
3059 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003060 *
Tejun Heo606a5022012-08-20 14:51:23 -07003061 * Wait until @work has finished execution. @work is guaranteed to be idle
3062 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003063 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003064 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003065 * %true if flush_work() waited for the work to finish execution,
3066 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003067 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003068bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003069{
Johannes Bergd6e89782018-08-22 11:49:03 +02003070 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003071}
3072EXPORT_SYMBOL_GPL(flush_work);
3073
Tejun Heo8603e1b32015-03-05 08:04:13 -05003074struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003075 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003076 struct work_struct *work;
3077};
3078
Ingo Molnarac6424b2017-06-20 12:06:13 +02003079static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003080{
3081 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3082
3083 if (cwait->work != key)
3084 return 0;
3085 return autoremove_wake_function(wait, mode, sync, key);
3086}
3087
Tejun Heo36e227d2012-08-03 10:30:46 -07003088static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003089{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003090 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003091 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003092 int ret;
3093
3094 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003095 ret = try_to_grab_pending(work, is_dwork, &flags);
3096 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003097 * If someone else is already canceling, wait for it to
3098 * finish. flush_work() doesn't work for PREEMPT_NONE
3099 * because we may get scheduled between @work's completion
3100 * and the other canceling task resuming and clearing
3101 * CANCELING - flush_work() will return false immediately
3102 * as @work is no longer busy, try_to_grab_pending() will
3103 * return -ENOENT as @work is still being canceled and the
3104 * other canceling task won't be able to clear CANCELING as
3105 * we're hogging the CPU.
3106 *
3107 * Let's wait for completion using a waitqueue. As this
3108 * may lead to the thundering herd problem, use a custom
3109 * wake function which matches @work along with exclusive
3110 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003111 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003112 if (unlikely(ret == -ENOENT)) {
3113 struct cwt_wait cwait;
3114
3115 init_wait(&cwait.wait);
3116 cwait.wait.func = cwt_wakefn;
3117 cwait.work = work;
3118
3119 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3120 TASK_UNINTERRUPTIBLE);
3121 if (work_is_canceling(work))
3122 schedule();
3123 finish_wait(&cancel_waitq, &cwait.wait);
3124 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003125 } while (unlikely(ret < 0));
3126
Tejun Heobbb68df2012-08-03 10:30:46 -07003127 /* tell other tasks trying to grab @work to back off */
3128 mark_work_canceling(work);
3129 local_irq_restore(flags);
3130
Tejun Heo3347fa02016-09-16 15:49:32 -04003131 /*
3132 * This allows canceling during early boot. We know that @work
3133 * isn't executing.
3134 */
3135 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003136 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003137
Tejun Heo7a22ad72010-06-29 10:07:13 +02003138 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003139
3140 /*
3141 * Paired with prepare_to_wait() above so that either
3142 * waitqueue_active() is visible here or !work_is_canceling() is
3143 * visible there.
3144 */
3145 smp_mb();
3146 if (waitqueue_active(&cancel_waitq))
3147 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3148
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003149 return ret;
3150}
3151
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003152/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003153 * cancel_work_sync - cancel a work and wait for it to finish
3154 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003155 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003156 * Cancel @work and wait for its execution to finish. This function
3157 * can be used even if the work re-queues itself or migrates to
3158 * another workqueue. On return from this function, @work is
3159 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003160 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003161 * cancel_work_sync(&delayed_work->work) must not be used for
3162 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003163 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003164 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003165 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003166 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003167 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003168 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003169 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003170bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003171{
Tejun Heo36e227d2012-08-03 10:30:46 -07003172 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003173}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003174EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003175
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003176/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003177 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3178 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003179 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003180 * Delayed timer is cancelled and the pending work is queued for
3181 * immediate execution. Like flush_work(), this function only
3182 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003183 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003184 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003185 * %true if flush_work() waited for the work to finish execution,
3186 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003187 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003188bool flush_delayed_work(struct delayed_work *dwork)
3189{
Tejun Heo8930cab2012-08-03 10:30:45 -07003190 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003191 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003192 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003193 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003194 return flush_work(&dwork->work);
3195}
3196EXPORT_SYMBOL(flush_delayed_work);
3197
Tejun Heo05f0fe62018-03-14 12:45:13 -07003198/**
3199 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3200 * @rwork: the rcu work to flush
3201 *
3202 * Return:
3203 * %true if flush_rcu_work() waited for the work to finish execution,
3204 * %false if it was already idle.
3205 */
3206bool flush_rcu_work(struct rcu_work *rwork)
3207{
3208 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3209 rcu_barrier();
3210 flush_work(&rwork->work);
3211 return true;
3212 } else {
3213 return flush_work(&rwork->work);
3214 }
3215}
3216EXPORT_SYMBOL(flush_rcu_work);
3217
Jens Axboef72b8792016-08-24 15:51:50 -06003218static bool __cancel_work(struct work_struct *work, bool is_dwork)
3219{
3220 unsigned long flags;
3221 int ret;
3222
3223 do {
3224 ret = try_to_grab_pending(work, is_dwork, &flags);
3225 } while (unlikely(ret == -EAGAIN));
3226
3227 if (unlikely(ret < 0))
3228 return false;
3229
3230 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3231 local_irq_restore(flags);
3232 return ret;
3233}
3234
Tejun Heo401a8d02010-09-16 10:36:00 +02003235/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003236 * cancel_delayed_work - cancel a delayed work
3237 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003238 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003239 * Kill off a pending delayed_work.
3240 *
3241 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3242 * pending.
3243 *
3244 * Note:
3245 * The work callback function may still be running on return, unless
3246 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3247 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003248 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003249 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003250 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003251bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003252{
Jens Axboef72b8792016-08-24 15:51:50 -06003253 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003254}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003255EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003256
3257/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003258 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3259 * @dwork: the delayed work cancel
3260 *
3261 * This is cancel_work_sync() for delayed works.
3262 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003263 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003264 * %true if @dwork was pending, %false otherwise.
3265 */
3266bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003267{
Tejun Heo36e227d2012-08-03 10:30:46 -07003268 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003269}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003270EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003272/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003273 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003274 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003275 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003276 * schedule_on_each_cpu() executes @func on each online CPU using the
3277 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003278 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003279 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003280 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003281 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003282 */
David Howells65f27f32006-11-22 14:55:48 +00003283int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003284{
3285 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003286 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003287
Andrew Mortonb6136772006-06-25 05:47:49 -07003288 works = alloc_percpu(struct work_struct);
3289 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003290 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003291
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003292 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003293
Christoph Lameter15316ba2006-01-08 01:00:43 -08003294 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003295 struct work_struct *work = per_cpu_ptr(works, cpu);
3296
3297 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003298 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003299 }
Tejun Heo93981802009-11-17 14:06:20 -08003300
3301 for_each_online_cpu(cpu)
3302 flush_work(per_cpu_ptr(works, cpu));
3303
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003304 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003305 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003306 return 0;
3307}
3308
Alan Sterneef6a7d2010-02-12 17:39:21 +09003309/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003310 * execute_in_process_context - reliably execute the routine with user context
3311 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003312 * @ew: guaranteed storage for the execute work structure (must
3313 * be available when the work executes)
3314 *
3315 * Executes the function immediately if process context is available,
3316 * otherwise schedules the function for delayed execution.
3317 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003318 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003319 * 1 - function was scheduled for execution
3320 */
David Howells65f27f32006-11-22 14:55:48 +00003321int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003322{
3323 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003324 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003325 return 0;
3326 }
3327
David Howells65f27f32006-11-22 14:55:48 +00003328 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003329 schedule_work(&ew->work);
3330
3331 return 1;
3332}
3333EXPORT_SYMBOL_GPL(execute_in_process_context);
3334
Tejun Heo7a4e3442013-03-12 11:30:00 -07003335/**
3336 * free_workqueue_attrs - free a workqueue_attrs
3337 * @attrs: workqueue_attrs to free
3338 *
3339 * Undo alloc_workqueue_attrs().
3340 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003341void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003342{
3343 if (attrs) {
3344 free_cpumask_var(attrs->cpumask);
3345 kfree(attrs);
3346 }
3347}
3348
3349/**
3350 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003351 *
3352 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003353 * return it.
3354 *
3355 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003356 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003357struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003358{
3359 struct workqueue_attrs *attrs;
3360
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003361 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003362 if (!attrs)
3363 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003364 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003365 goto fail;
3366
Tejun Heo13e2e552013-04-01 11:23:31 -07003367 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003368 return attrs;
3369fail:
3370 free_workqueue_attrs(attrs);
3371 return NULL;
3372}
3373
Tejun Heo29c91e92013-03-12 11:30:03 -07003374static void copy_workqueue_attrs(struct workqueue_attrs *to,
3375 const struct workqueue_attrs *from)
3376{
3377 to->nice = from->nice;
3378 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003379 /*
3380 * Unlike hash and equality test, this function doesn't ignore
3381 * ->no_numa as it is used for both pool and wq attrs. Instead,
3382 * get_unbound_pool() explicitly clears ->no_numa after copying.
3383 */
3384 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003385}
3386
Tejun Heo29c91e92013-03-12 11:30:03 -07003387/* hash value of the content of @attr */
3388static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3389{
3390 u32 hash = 0;
3391
3392 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003393 hash = jhash(cpumask_bits(attrs->cpumask),
3394 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003395 return hash;
3396}
3397
3398/* content equality test */
3399static bool wqattrs_equal(const struct workqueue_attrs *a,
3400 const struct workqueue_attrs *b)
3401{
3402 if (a->nice != b->nice)
3403 return false;
3404 if (!cpumask_equal(a->cpumask, b->cpumask))
3405 return false;
3406 return true;
3407}
3408
Tejun Heo7a4e3442013-03-12 11:30:00 -07003409/**
3410 * init_worker_pool - initialize a newly zalloc'd worker_pool
3411 * @pool: worker_pool to initialize
3412 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303413 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003414 *
3415 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003416 * inside @pool proper are initialized and put_unbound_pool() can be called
3417 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003418 */
3419static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003420{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003421 raw_spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003422 pool->id = -1;
3423 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003424 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003425 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003426 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003427 INIT_LIST_HEAD(&pool->worklist);
3428 INIT_LIST_HEAD(&pool->idle_list);
3429 hash_init(pool->busy_hash);
3430
Kees Cook32a6c722017-10-16 15:58:25 -07003431 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003432
Kees Cook32a6c722017-10-16 15:58:25 -07003433 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003434
Lai Jiangshanda028462014-05-20 17:46:31 +08003435 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003436
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003437 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003438 INIT_HLIST_NODE(&pool->hash_node);
3439 pool->refcnt = 1;
3440
3441 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003442 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003443 if (!pool->attrs)
3444 return -ENOMEM;
3445 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003446}
3447
Bart Van Assche669de8b2019-02-14 15:00:54 -08003448#ifdef CONFIG_LOCKDEP
3449static void wq_init_lockdep(struct workqueue_struct *wq)
3450{
3451 char *lock_name;
3452
3453 lockdep_register_key(&wq->key);
3454 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3455 if (!lock_name)
3456 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003457
3458 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003459 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3460}
3461
3462static void wq_unregister_lockdep(struct workqueue_struct *wq)
3463{
3464 lockdep_unregister_key(&wq->key);
3465}
3466
3467static void wq_free_lockdep(struct workqueue_struct *wq)
3468{
3469 if (wq->lock_name != wq->name)
3470 kfree(wq->lock_name);
3471}
3472#else
3473static void wq_init_lockdep(struct workqueue_struct *wq)
3474{
3475}
3476
3477static void wq_unregister_lockdep(struct workqueue_struct *wq)
3478{
3479}
3480
3481static void wq_free_lockdep(struct workqueue_struct *wq)
3482{
3483}
3484#endif
3485
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003486static void rcu_free_wq(struct rcu_head *rcu)
3487{
3488 struct workqueue_struct *wq =
3489 container_of(rcu, struct workqueue_struct, rcu);
3490
Bart Van Assche669de8b2019-02-14 15:00:54 -08003491 wq_free_lockdep(wq);
3492
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003493 if (!(wq->flags & WQ_UNBOUND))
3494 free_percpu(wq->cpu_pwqs);
3495 else
3496 free_workqueue_attrs(wq->unbound_attrs);
3497
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003498 kfree(wq);
3499}
3500
Tejun Heo29c91e92013-03-12 11:30:03 -07003501static void rcu_free_pool(struct rcu_head *rcu)
3502{
3503 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3504
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003505 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003506 free_workqueue_attrs(pool->attrs);
3507 kfree(pool);
3508}
3509
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003510/* This returns with the lock held on success (pool manager is inactive). */
3511static bool wq_manager_inactive(struct worker_pool *pool)
3512{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003513 raw_spin_lock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003514
3515 if (pool->flags & POOL_MANAGER_ACTIVE) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003516 raw_spin_unlock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003517 return false;
3518 }
3519 return true;
3520}
3521
Tejun Heo29c91e92013-03-12 11:30:03 -07003522/**
3523 * put_unbound_pool - put a worker_pool
3524 * @pool: worker_pool to put
3525 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003526 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003527 * safe manner. get_unbound_pool() calls this function on its failure path
3528 * and this function should be able to release pools which went through,
3529 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003530 *
3531 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003532 */
3533static void put_unbound_pool(struct worker_pool *pool)
3534{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003535 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003536 struct worker *worker;
3537
Tejun Heoa892cac2013-04-01 11:23:32 -07003538 lockdep_assert_held(&wq_pool_mutex);
3539
3540 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003541 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003542
3543 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003544 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003545 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003546 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003547
3548 /* release id and unhash */
3549 if (pool->id >= 0)
3550 idr_remove(&worker_pool_idr, pool->id);
3551 hash_del(&pool->hash_node);
3552
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003553 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003554 * Become the manager and destroy all workers. This prevents
3555 * @pool's workers from blocking on attach_mutex. We're the last
3556 * manager and @pool gets freed with the flag set.
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003557 * Because of how wq_manager_inactive() works, we will hold the
3558 * spinlock after a successful wait.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003559 */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003560 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3561 TASK_UNINTERRUPTIBLE);
Tejun Heo692b4822017-10-09 08:04:13 -07003562 pool->flags |= POOL_MANAGER_ACTIVE;
3563
Lai Jiangshan1037de32014-05-22 16:44:07 +08003564 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003565 destroy_worker(worker);
3566 WARN_ON(pool->nr_workers || pool->nr_idle);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003567 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003568
Tejun Heo1258fae2018-05-18 08:47:13 -07003569 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003570 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003571 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003572 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003573
3574 if (pool->detach_completion)
3575 wait_for_completion(pool->detach_completion);
3576
Tejun Heo29c91e92013-03-12 11:30:03 -07003577 /* shut down the timers */
3578 del_timer_sync(&pool->idle_timer);
3579 del_timer_sync(&pool->mayday_timer);
3580
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003581 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003582 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003583}
3584
3585/**
3586 * get_unbound_pool - get a worker_pool with the specified attributes
3587 * @attrs: the attributes of the worker_pool to get
3588 *
3589 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3590 * reference count and return it. If there already is a matching
3591 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003592 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003593 *
3594 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003595 *
3596 * Return: On success, a worker_pool with the same attributes as @attrs.
3597 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003598 */
3599static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3600{
Tejun Heo29c91e92013-03-12 11:30:03 -07003601 u32 hash = wqattrs_hash(attrs);
3602 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003603 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003604 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003605
Tejun Heoa892cac2013-04-01 11:23:32 -07003606 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003607
3608 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003609 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3610 if (wqattrs_equal(pool->attrs, attrs)) {
3611 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003612 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003613 }
3614 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003615
Xunlei Pange22735842015-10-09 11:53:12 +08003616 /* if cpumask is contained inside a NUMA node, we belong to that node */
3617 if (wq_numa_enabled) {
3618 for_each_node(node) {
3619 if (cpumask_subset(attrs->cpumask,
3620 wq_numa_possible_cpumask[node])) {
3621 target_node = node;
3622 break;
3623 }
3624 }
3625 }
3626
Tejun Heo29c91e92013-03-12 11:30:03 -07003627 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003628 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003629 if (!pool || init_worker_pool(pool) < 0)
3630 goto fail;
3631
Tejun Heo8864b4e2013-03-12 11:30:04 -07003632 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003633 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003634 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003635
Shaohua Li2865a8f2013-08-01 09:56:36 +08003636 /*
3637 * no_numa isn't a worker_pool attribute, always clear it. See
3638 * 'struct workqueue_attrs' comments for detail.
3639 */
3640 pool->attrs->no_numa = false;
3641
Tejun Heo29c91e92013-03-12 11:30:03 -07003642 if (worker_pool_assign_id(pool) < 0)
3643 goto fail;
3644
3645 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003646 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003647 goto fail;
3648
Tejun Heo29c91e92013-03-12 11:30:03 -07003649 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003650 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003651
Tejun Heo29c91e92013-03-12 11:30:03 -07003652 return pool;
3653fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003654 if (pool)
3655 put_unbound_pool(pool);
3656 return NULL;
3657}
3658
Tejun Heo8864b4e2013-03-12 11:30:04 -07003659static void rcu_free_pwq(struct rcu_head *rcu)
3660{
3661 kmem_cache_free(pwq_cache,
3662 container_of(rcu, struct pool_workqueue, rcu));
3663}
3664
3665/*
3666 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3667 * and needs to be destroyed.
3668 */
3669static void pwq_unbound_release_workfn(struct work_struct *work)
3670{
3671 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3672 unbound_release_work);
3673 struct workqueue_struct *wq = pwq->wq;
3674 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003675 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003676
3677 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3678 return;
3679
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003680 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003681 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003682 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003683 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003684
Tejun Heoa892cac2013-04-01 11:23:32 -07003685 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003686 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003687 mutex_unlock(&wq_pool_mutex);
3688
Paul E. McKenney25b00772018-11-06 19:18:45 -08003689 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003690
3691 /*
3692 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003693 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003694 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003695 if (is_last) {
3696 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003697 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003698 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003699}
3700
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003701/**
Tejun Heo699ce092013-03-13 16:51:35 -07003702 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003703 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003704 *
Tejun Heo699ce092013-03-13 16:51:35 -07003705 * If @pwq isn't freezing, set @pwq->max_active to the associated
3706 * workqueue's saved_max_active and activate delayed work items
3707 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003708 */
Tejun Heo699ce092013-03-13 16:51:35 -07003709static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003710{
Tejun Heo699ce092013-03-13 16:51:35 -07003711 struct workqueue_struct *wq = pwq->wq;
3712 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003713 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003714
Tejun Heo699ce092013-03-13 16:51:35 -07003715 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003716 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003717
3718 /* fast exit for non-freezable wqs */
3719 if (!freezable && pwq->max_active == wq->saved_max_active)
3720 return;
3721
Tejun Heo3347fa02016-09-16 15:49:32 -04003722 /* this function can be called during early boot w/ irq disabled */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003723 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003724
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003725 /*
3726 * During [un]freezing, the caller is responsible for ensuring that
3727 * this function is called at least once after @workqueue_freezing
3728 * is updated and visible.
3729 */
3730 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003731 pwq->max_active = wq->saved_max_active;
3732
3733 while (!list_empty(&pwq->delayed_works) &&
3734 pwq->nr_active < pwq->max_active)
3735 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003736
3737 /*
3738 * Need to kick a worker after thawed or an unbound wq's
3739 * max_active is bumped. It's a slow path. Do it always.
3740 */
3741 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003742 } else {
3743 pwq->max_active = 0;
3744 }
3745
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003746 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003747}
3748
Tejun Heoe50aba92013-04-01 11:23:35 -07003749/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003750static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3751 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003752{
3753 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3754
Tejun Heoe50aba92013-04-01 11:23:35 -07003755 memset(pwq, 0, sizeof(*pwq));
3756
Tejun Heod2c1d402013-03-12 11:30:04 -07003757 pwq->pool = pool;
3758 pwq->wq = wq;
3759 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003760 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003761 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003762 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003763 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003764 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003765}
Tejun Heod2c1d402013-03-12 11:30:04 -07003766
Tejun Heof147f292013-04-01 11:23:35 -07003767/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003768static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003769{
3770 struct workqueue_struct *wq = pwq->wq;
3771
3772 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003773
Tejun Heo1befcf32013-04-01 11:23:35 -07003774 /* may be called multiple times, ignore if already linked */
3775 if (!list_empty(&pwq->pwqs_node))
3776 return;
3777
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003778 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003779 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003780
3781 /* sync max_active to the current setting */
3782 pwq_adjust_max_active(pwq);
3783
3784 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003785 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003786}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003787
Tejun Heof147f292013-04-01 11:23:35 -07003788/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3789static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3790 const struct workqueue_attrs *attrs)
3791{
3792 struct worker_pool *pool;
3793 struct pool_workqueue *pwq;
3794
3795 lockdep_assert_held(&wq_pool_mutex);
3796
3797 pool = get_unbound_pool(attrs);
3798 if (!pool)
3799 return NULL;
3800
Tejun Heoe50aba92013-04-01 11:23:35 -07003801 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003802 if (!pwq) {
3803 put_unbound_pool(pool);
3804 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003805 }
Tejun Heo6029a912013-04-01 11:23:34 -07003806
Tejun Heof147f292013-04-01 11:23:35 -07003807 init_pwq(pwq, wq, pool);
3808 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003809}
3810
Tejun Heo4c16bd32013-04-01 11:23:36 -07003811/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003812 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003813 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003814 * @node: the target NUMA node
3815 * @cpu_going_down: if >= 0, the CPU to consider as offline
3816 * @cpumask: outarg, the resulting cpumask
3817 *
3818 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3819 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003820 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003821 *
3822 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3823 * enabled and @node has online CPUs requested by @attrs, the returned
3824 * cpumask is the intersection of the possible CPUs of @node and
3825 * @attrs->cpumask.
3826 *
3827 * The caller is responsible for ensuring that the cpumask of @node stays
3828 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003829 *
3830 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3831 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003832 */
3833static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3834 int cpu_going_down, cpumask_t *cpumask)
3835{
Tejun Heod55262c2013-04-01 11:23:38 -07003836 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003837 goto use_dfl;
3838
3839 /* does @node have any online CPUs @attrs wants? */
3840 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3841 if (cpu_going_down >= 0)
3842 cpumask_clear_cpu(cpu_going_down, cpumask);
3843
3844 if (cpumask_empty(cpumask))
3845 goto use_dfl;
3846
3847 /* yeap, return possible CPUs in @node that @attrs wants */
3848 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003849
3850 if (cpumask_empty(cpumask)) {
3851 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3852 "possible intersect\n");
3853 return false;
3854 }
3855
Tejun Heo4c16bd32013-04-01 11:23:36 -07003856 return !cpumask_equal(cpumask, attrs->cpumask);
3857
3858use_dfl:
3859 cpumask_copy(cpumask, attrs->cpumask);
3860 return false;
3861}
3862
Tejun Heo1befcf32013-04-01 11:23:35 -07003863/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3864static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3865 int node,
3866 struct pool_workqueue *pwq)
3867{
3868 struct pool_workqueue *old_pwq;
3869
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003870 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003871 lockdep_assert_held(&wq->mutex);
3872
3873 /* link_pwq() can handle duplicate calls */
3874 link_pwq(pwq);
3875
3876 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3877 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3878 return old_pwq;
3879}
3880
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003881/* context to store the prepared attrs & pwqs before applying */
3882struct apply_wqattrs_ctx {
3883 struct workqueue_struct *wq; /* target workqueue */
3884 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003885 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003886 struct pool_workqueue *dfl_pwq;
3887 struct pool_workqueue *pwq_tbl[];
3888};
3889
3890/* free the resources after success or abort */
3891static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3892{
3893 if (ctx) {
3894 int node;
3895
3896 for_each_node(node)
3897 put_pwq_unlocked(ctx->pwq_tbl[node]);
3898 put_pwq_unlocked(ctx->dfl_pwq);
3899
3900 free_workqueue_attrs(ctx->attrs);
3901
3902 kfree(ctx);
3903 }
3904}
3905
3906/* allocate the attrs and pwqs for later installation */
3907static struct apply_wqattrs_ctx *
3908apply_wqattrs_prepare(struct workqueue_struct *wq,
3909 const struct workqueue_attrs *attrs)
3910{
3911 struct apply_wqattrs_ctx *ctx;
3912 struct workqueue_attrs *new_attrs, *tmp_attrs;
3913 int node;
3914
3915 lockdep_assert_held(&wq_pool_mutex);
3916
Kees Cookacafe7e2018-05-08 13:45:50 -07003917 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003918
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003919 new_attrs = alloc_workqueue_attrs();
3920 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003921 if (!ctx || !new_attrs || !tmp_attrs)
3922 goto out_free;
3923
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003924 /*
3925 * Calculate the attrs of the default pwq.
3926 * If the user configured cpumask doesn't overlap with the
3927 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3928 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003929 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003930 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003931 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3932 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003933
3934 /*
3935 * We may create multiple pwqs with differing cpumasks. Make a
3936 * copy of @new_attrs which will be modified and used to obtain
3937 * pools.
3938 */
3939 copy_workqueue_attrs(tmp_attrs, new_attrs);
3940
3941 /*
3942 * If something goes wrong during CPU up/down, we'll fall back to
3943 * the default pwq covering whole @attrs->cpumask. Always create
3944 * it even if we don't use it immediately.
3945 */
3946 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3947 if (!ctx->dfl_pwq)
3948 goto out_free;
3949
3950 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003951 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003952 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3953 if (!ctx->pwq_tbl[node])
3954 goto out_free;
3955 } else {
3956 ctx->dfl_pwq->refcnt++;
3957 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3958 }
3959 }
3960
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003961 /* save the user configured attrs and sanitize it. */
3962 copy_workqueue_attrs(new_attrs, attrs);
3963 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003964 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003965
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003966 ctx->wq = wq;
3967 free_workqueue_attrs(tmp_attrs);
3968 return ctx;
3969
3970out_free:
3971 free_workqueue_attrs(tmp_attrs);
3972 free_workqueue_attrs(new_attrs);
3973 apply_wqattrs_cleanup(ctx);
3974 return NULL;
3975}
3976
3977/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3978static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3979{
3980 int node;
3981
3982 /* all pwqs have been created successfully, let's install'em */
3983 mutex_lock(&ctx->wq->mutex);
3984
3985 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3986
3987 /* save the previous pwq and install the new one */
3988 for_each_node(node)
3989 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3990 ctx->pwq_tbl[node]);
3991
3992 /* @dfl_pwq might not have been used, ensure it's linked */
3993 link_pwq(ctx->dfl_pwq);
3994 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3995
3996 mutex_unlock(&ctx->wq->mutex);
3997}
3998
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003999static void apply_wqattrs_lock(void)
4000{
4001 /* CPUs should stay stable across pwq creations and installations */
4002 get_online_cpus();
4003 mutex_lock(&wq_pool_mutex);
4004}
4005
4006static void apply_wqattrs_unlock(void)
4007{
4008 mutex_unlock(&wq_pool_mutex);
4009 put_online_cpus();
4010}
4011
4012static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4013 const struct workqueue_attrs *attrs)
4014{
4015 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004016
4017 /* only unbound workqueues can change attributes */
4018 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4019 return -EINVAL;
4020
4021 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004022 if (!list_empty(&wq->pwqs)) {
4023 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4024 return -EINVAL;
4025
4026 wq->flags &= ~__WQ_ORDERED;
4027 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004028
4029 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004030 if (!ctx)
4031 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004032
4033 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004034 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004035 apply_wqattrs_cleanup(ctx);
4036
wanghaibin62011712016-01-07 20:38:59 +08004037 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004038}
4039
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004040/**
4041 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4042 * @wq: the target workqueue
4043 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4044 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004045 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4046 * machines, this function maps a separate pwq to each NUMA node with
4047 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4048 * NUMA node it was issued on. Older pwqs are released as in-flight work
4049 * items finish. Note that a work item which repeatedly requeues itself
4050 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004051 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004052 * Performs GFP_KERNEL allocations.
4053 *
Daniel Jordan509b3202019-09-05 21:40:23 -04004054 * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus().
4055 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004056 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004057 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004058int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004059 const struct workqueue_attrs *attrs)
4060{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004061 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004062
Daniel Jordan509b3202019-09-05 21:40:23 -04004063 lockdep_assert_cpus_held();
4064
4065 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004066 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004067 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004068
Tejun Heo48621252013-04-01 11:23:31 -07004069 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004070}
4071
Tejun Heo4c16bd32013-04-01 11:23:36 -07004072/**
4073 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4074 * @wq: the target workqueue
4075 * @cpu: the CPU coming up or going down
4076 * @online: whether @cpu is coming up or going down
4077 *
4078 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4079 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4080 * @wq accordingly.
4081 *
4082 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4083 * falls back to @wq->dfl_pwq which may not be optimal but is always
4084 * correct.
4085 *
4086 * Note that when the last allowed CPU of a NUMA node goes offline for a
4087 * workqueue with a cpumask spanning multiple nodes, the workers which were
4088 * already executing the work items for the workqueue will lose their CPU
4089 * affinity and may execute on any CPU. This is similar to how per-cpu
4090 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4091 * affinity, it's the user's responsibility to flush the work item from
4092 * CPU_DOWN_PREPARE.
4093 */
4094static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4095 bool online)
4096{
4097 int node = cpu_to_node(cpu);
4098 int cpu_off = online ? -1 : cpu;
4099 struct pool_workqueue *old_pwq = NULL, *pwq;
4100 struct workqueue_attrs *target_attrs;
4101 cpumask_t *cpumask;
4102
4103 lockdep_assert_held(&wq_pool_mutex);
4104
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004105 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4106 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004107 return;
4108
4109 /*
4110 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4111 * Let's use a preallocated one. The following buf is protected by
4112 * CPU hotplug exclusion.
4113 */
4114 target_attrs = wq_update_unbound_numa_attrs_buf;
4115 cpumask = target_attrs->cpumask;
4116
Tejun Heo4c16bd32013-04-01 11:23:36 -07004117 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4118 pwq = unbound_pwq_by_node(wq, node);
4119
4120 /*
4121 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004122 * different from the default pwq's, we need to compare it to @pwq's
4123 * and create a new one if they don't match. If the target cpumask
4124 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004125 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004126 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004127 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004128 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004129 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004130 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004131 }
4132
Tejun Heo4c16bd32013-04-01 11:23:36 -07004133 /* create a new pwq */
4134 pwq = alloc_unbound_pwq(wq, target_attrs);
4135 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004136 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4137 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004138 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004139 }
4140
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004141 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004142 mutex_lock(&wq->mutex);
4143 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4144 goto out_unlock;
4145
4146use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004147 mutex_lock(&wq->mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004148 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004149 get_pwq(wq->dfl_pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004150 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004151 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4152out_unlock:
4153 mutex_unlock(&wq->mutex);
4154 put_pwq_unlocked(old_pwq);
4155}
4156
Tejun Heo30cdf2492013-03-12 11:29:57 -07004157static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004158{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004159 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004160 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004161
Tejun Heo30cdf2492013-03-12 11:29:57 -07004162 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004163 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4164 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004165 return -ENOMEM;
4166
4167 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004168 struct pool_workqueue *pwq =
4169 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004170 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004171 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004172
Tejun Heof147f292013-04-01 11:23:35 -07004173 init_pwq(pwq, wq, &cpu_pools[highpri]);
4174
4175 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004176 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004177 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004178 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004179 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004180 }
4181
4182 get_online_cpus();
4183 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004184 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4185 /* there should only be single pwq for ordering guarantee */
4186 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4187 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4188 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004189 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004190 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004191 }
Daniel Jordan509b3202019-09-05 21:40:23 -04004192 put_online_cpus();
4193
4194 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004195}
4196
Tejun Heof3421792010-07-02 10:03:51 +02004197static int wq_clamp_max_active(int max_active, unsigned int flags,
4198 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004199{
Tejun Heof3421792010-07-02 10:03:51 +02004200 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4201
4202 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004203 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4204 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004205
Tejun Heof3421792010-07-02 10:03:51 +02004206 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004207}
4208
Tejun Heo983c7512018-01-08 05:38:32 -08004209/*
4210 * Workqueues which may be used during memory reclaim should have a rescuer
4211 * to guarantee forward progress.
4212 */
4213static int init_rescuer(struct workqueue_struct *wq)
4214{
4215 struct worker *rescuer;
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004216 int ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004217
4218 if (!(wq->flags & WQ_MEM_RECLAIM))
4219 return 0;
4220
4221 rescuer = alloc_worker(NUMA_NO_NODE);
4222 if (!rescuer)
4223 return -ENOMEM;
4224
4225 rescuer->rescue_wq = wq;
4226 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
Sean Fuf187b692020-04-29 12:04:13 +08004227 if (IS_ERR(rescuer->task)) {
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004228 ret = PTR_ERR(rescuer->task);
Tejun Heo983c7512018-01-08 05:38:32 -08004229 kfree(rescuer);
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004230 return ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004231 }
4232
4233 wq->rescuer = rescuer;
4234 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4235 wake_up_process(rescuer->task);
4236
4237 return 0;
4238}
4239
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004240__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004241struct workqueue_struct *alloc_workqueue(const char *fmt,
4242 unsigned int flags,
4243 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004244{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004245 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004246 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004247 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004248 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004249
Tejun Heo5c0338c2017-07-18 18:41:52 -04004250 /*
4251 * Unbound && max_active == 1 used to imply ordered, which is no
4252 * longer the case on NUMA machines due to per-node pools. While
4253 * alloc_ordered_workqueue() is the right way to create an ordered
4254 * workqueue, keep the previous behavior to avoid subtle breakages
4255 * on NUMA.
4256 */
4257 if ((flags & WQ_UNBOUND) && max_active == 1)
4258 flags |= __WQ_ORDERED;
4259
Viresh Kumarcee22a12013-04-08 16:45:40 +05304260 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4261 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4262 flags |= WQ_UNBOUND;
4263
Tejun Heoecf68812013-04-01 11:23:34 -07004264 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004265 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004266 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004267
4268 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004269 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004270 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004271
Tejun Heo6029a912013-04-01 11:23:34 -07004272 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004273 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004274 if (!wq->unbound_attrs)
4275 goto err_free_wq;
4276 }
4277
Bart Van Assche669de8b2019-02-14 15:00:54 -08004278 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004279 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004280 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004281
Tejun Heod320c032010-06-29 10:07:14 +02004282 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004283 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004284
Tejun Heob196be82012-01-10 15:11:35 -08004285 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004286 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004287 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004288 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004289 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004290 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004291 INIT_LIST_HEAD(&wq->flusher_queue);
4292 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004293 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004294
Bart Van Assche669de8b2019-02-14 15:00:54 -08004295 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004296 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004297
Tejun Heo30cdf2492013-03-12 11:29:57 -07004298 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004299 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004300
Tejun Heo40c17f72018-01-08 05:38:37 -08004301 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004302 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004303
Tejun Heo226223a2013-03-12 11:30:05 -07004304 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4305 goto err_destroy;
4306
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004307 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004308 * wq_pool_mutex protects global freeze state and workqueues list.
4309 * Grab it, adjust max_active and add the new @wq to workqueues
4310 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004311 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004312 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004313
Lai Jiangshana357fc02013-03-25 16:57:19 -07004314 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004315 for_each_pwq(pwq, wq)
4316 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004317 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004318
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004319 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004320
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004321 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004322
Oleg Nesterov3af244332007-05-09 02:34:09 -07004323 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004324
Bart Van Assche82efcab2019-03-11 16:02:55 -07004325err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004326 wq_unregister_lockdep(wq);
4327 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004328err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004329 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004330 kfree(wq);
4331 return NULL;
4332err_destroy:
4333 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004334 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004335}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004336EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004337
Tejun Heoc29eb852019-09-23 11:08:58 -07004338static bool pwq_busy(struct pool_workqueue *pwq)
4339{
4340 int i;
4341
4342 for (i = 0; i < WORK_NR_COLORS; i++)
4343 if (pwq->nr_in_flight[i])
4344 return true;
4345
4346 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4347 return true;
4348 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4349 return true;
4350
4351 return false;
4352}
4353
Oleg Nesterov3af244332007-05-09 02:34:09 -07004354/**
4355 * destroy_workqueue - safely terminate a workqueue
4356 * @wq: target workqueue
4357 *
4358 * Safely destroy a workqueue. All work currently pending will be done first.
4359 */
4360void destroy_workqueue(struct workqueue_struct *wq)
4361{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004362 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004363 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004364
Tejun Heodef98c82019-09-18 18:43:40 -07004365 /*
4366 * Remove it from sysfs first so that sanity check failure doesn't
4367 * lead to sysfs name conflicts.
4368 */
4369 workqueue_sysfs_unregister(wq);
4370
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004371 /* drain it before proceeding with destruction */
4372 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004373
Tejun Heodef98c82019-09-18 18:43:40 -07004374 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4375 if (wq->rescuer) {
4376 struct worker *rescuer = wq->rescuer;
4377
4378 /* this prevents new queueing */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004379 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004380 wq->rescuer = NULL;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004381 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004382
4383 /* rescuer will empty maydays list before exiting */
4384 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004385 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004386 }
4387
Tejun Heoc29eb852019-09-23 11:08:58 -07004388 /*
4389 * Sanity checks - grab all the locks so that we wait for all
4390 * in-flight operations which may do put_pwq().
4391 */
4392 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004393 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004394 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004395 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heoc29eb852019-09-23 11:08:58 -07004396 if (WARN_ON(pwq_busy(pwq))) {
Kefeng Wang1d9a6152019-11-28 08:47:49 +08004397 pr_warn("%s: %s has the following busy pwq\n",
4398 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004399 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004400 raw_spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004401 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004402 mutex_unlock(&wq_pool_mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004403 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004404 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004405 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004406 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004407 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004408 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004409
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004410 /*
4411 * wq list is used to freeze wq, remove from list after
4412 * flushing is complete in case freeze races us.
4413 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004414 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004415 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004416
Tejun Heo8864b4e2013-03-12 11:30:04 -07004417 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004418 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004419 /*
4420 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004421 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004422 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004423 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004424 } else {
4425 /*
4426 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004427 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4428 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004429 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004430 for_each_node(node) {
4431 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4432 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4433 put_pwq_unlocked(pwq);
4434 }
4435
4436 /*
4437 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4438 * put. Don't access it afterwards.
4439 */
4440 pwq = wq->dfl_pwq;
4441 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004442 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004443 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004444}
4445EXPORT_SYMBOL_GPL(destroy_workqueue);
4446
Tejun Heodcd989c2010-06-29 10:07:14 +02004447/**
4448 * workqueue_set_max_active - adjust max_active of a workqueue
4449 * @wq: target workqueue
4450 * @max_active: new max_active value.
4451 *
4452 * Set max_active of @wq to @max_active.
4453 *
4454 * CONTEXT:
4455 * Don't call from IRQ context.
4456 */
4457void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4458{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004459 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004460
Tejun Heo8719dce2013-03-12 11:30:04 -07004461 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004462 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004463 return;
4464
Tejun Heof3421792010-07-02 10:03:51 +02004465 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004466
Lai Jiangshana357fc02013-03-25 16:57:19 -07004467 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004468
Tejun Heo0a94efb2017-07-23 08:36:15 -04004469 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004470 wq->saved_max_active = max_active;
4471
Tejun Heo699ce092013-03-13 16:51:35 -07004472 for_each_pwq(pwq, wq)
4473 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004474
Lai Jiangshana357fc02013-03-25 16:57:19 -07004475 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004476}
4477EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4478
4479/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004480 * current_work - retrieve %current task's work struct
4481 *
4482 * Determine if %current task is a workqueue worker and what it's working on.
4483 * Useful to find out the context that the %current task is running in.
4484 *
4485 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4486 */
4487struct work_struct *current_work(void)
4488{
4489 struct worker *worker = current_wq_worker();
4490
4491 return worker ? worker->current_work : NULL;
4492}
4493EXPORT_SYMBOL(current_work);
4494
4495/**
Tejun Heoe62676162013-03-12 17:41:37 -07004496 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4497 *
4498 * Determine whether %current is a workqueue rescuer. Can be used from
4499 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004500 *
4501 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004502 */
4503bool current_is_workqueue_rescuer(void)
4504{
4505 struct worker *worker = current_wq_worker();
4506
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004507 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004508}
4509
4510/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004511 * workqueue_congested - test whether a workqueue is congested
4512 * @cpu: CPU in question
4513 * @wq: target workqueue
4514 *
4515 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4516 * no synchronization around this function and the test result is
4517 * unreliable and only useful as advisory hints or for debugging.
4518 *
Tejun Heod3251852013-05-10 11:10:17 -07004519 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4520 * Note that both per-cpu and unbound workqueues may be associated with
4521 * multiple pool_workqueues which have separate congested states. A
4522 * workqueue being congested on one CPU doesn't mean the workqueue is also
4523 * contested on other CPUs / NUMA nodes.
4524 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004525 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004526 * %true if congested, %false otherwise.
4527 */
Tejun Heod84ff052013-03-12 11:29:59 -07004528bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004529{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004530 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004531 bool ret;
4532
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004533 rcu_read_lock();
4534 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004535
Tejun Heod3251852013-05-10 11:10:17 -07004536 if (cpu == WORK_CPU_UNBOUND)
4537 cpu = smp_processor_id();
4538
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004539 if (!(wq->flags & WQ_UNBOUND))
4540 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4541 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004542 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004543
Tejun Heo76af4d92013-03-12 11:30:00 -07004544 ret = !list_empty(&pwq->delayed_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004545 preempt_enable();
4546 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004547
4548 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004549}
4550EXPORT_SYMBOL_GPL(workqueue_congested);
4551
4552/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004553 * work_busy - test whether a work is currently pending or running
4554 * @work: the work to be tested
4555 *
4556 * Test whether @work is currently pending or running. There is no
4557 * synchronization around this function and the test result is
4558 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004559 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004560 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004561 * OR'd bitmask of WORK_BUSY_* bits.
4562 */
4563unsigned int work_busy(struct work_struct *work)
4564{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004565 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004566 unsigned long flags;
4567 unsigned int ret = 0;
4568
Tejun Heodcd989c2010-06-29 10:07:14 +02004569 if (work_pending(work))
4570 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004571
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004572 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004573 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004574 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004575 raw_spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004576 if (find_worker_executing_work(pool, work))
4577 ret |= WORK_BUSY_RUNNING;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004578 raw_spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004579 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004580 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004581
4582 return ret;
4583}
4584EXPORT_SYMBOL_GPL(work_busy);
4585
Tejun Heo3d1cb202013-04-30 15:27:22 -07004586/**
4587 * set_worker_desc - set description for the current work item
4588 * @fmt: printf-style format string
4589 * @...: arguments for the format string
4590 *
4591 * This function can be called by a running work function to describe what
4592 * the work item is about. If the worker task gets dumped, this
4593 * information will be printed out together to help debugging. The
4594 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4595 */
4596void set_worker_desc(const char *fmt, ...)
4597{
4598 struct worker *worker = current_wq_worker();
4599 va_list args;
4600
4601 if (worker) {
4602 va_start(args, fmt);
4603 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4604 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004605 }
4606}
Steffen Maier5c750d52018-05-17 19:14:57 +02004607EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004608
4609/**
4610 * print_worker_info - print out worker information and description
4611 * @log_lvl: the log level to use when printing
4612 * @task: target task
4613 *
4614 * If @task is a worker and currently executing a work item, print out the
4615 * name of the workqueue being serviced and worker description set with
4616 * set_worker_desc() by the currently executing work item.
4617 *
4618 * This function can be safely called on any task as long as the
4619 * task_struct itself is accessible. While safe, this function isn't
4620 * synchronized and may print out mixups or garbages of limited length.
4621 */
4622void print_worker_info(const char *log_lvl, struct task_struct *task)
4623{
4624 work_func_t *fn = NULL;
4625 char name[WQ_NAME_LEN] = { };
4626 char desc[WORKER_DESC_LEN] = { };
4627 struct pool_workqueue *pwq = NULL;
4628 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004629 struct worker *worker;
4630
4631 if (!(task->flags & PF_WQ_WORKER))
4632 return;
4633
4634 /*
4635 * This function is called without any synchronization and @task
4636 * could be in any state. Be careful with dereferences.
4637 */
Petr Mladeke7005912016-10-11 13:55:17 -07004638 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004639
4640 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004641 * Carefully copy the associated workqueue's workfn, name and desc.
4642 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004643 */
Christoph Hellwigfe557312020-06-17 09:37:53 +02004644 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4645 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4646 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4647 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4648 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004649
4650 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004651 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004652 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004653 pr_cont(" (%s)", desc);
4654 pr_cont("\n");
4655 }
4656}
4657
Tejun Heo3494fc32015-03-09 09:22:28 -04004658static void pr_cont_pool_info(struct worker_pool *pool)
4659{
4660 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4661 if (pool->node != NUMA_NO_NODE)
4662 pr_cont(" node=%d", pool->node);
4663 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4664}
4665
4666static void pr_cont_work(bool comma, struct work_struct *work)
4667{
4668 if (work->func == wq_barrier_func) {
4669 struct wq_barrier *barr;
4670
4671 barr = container_of(work, struct wq_barrier, work);
4672
4673 pr_cont("%s BAR(%d)", comma ? "," : "",
4674 task_pid_nr(barr->task));
4675 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004676 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004677 }
4678}
4679
4680static void show_pwq(struct pool_workqueue *pwq)
4681{
4682 struct worker_pool *pool = pwq->pool;
4683 struct work_struct *work;
4684 struct worker *worker;
4685 bool has_in_flight = false, has_pending = false;
4686 int bkt;
4687
4688 pr_info(" pwq %d:", pool->id);
4689 pr_cont_pool_info(pool);
4690
Tejun Heoe66b39a2019-09-25 06:59:15 -07004691 pr_cont(" active=%d/%d refcnt=%d%s\n",
4692 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004693 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4694
4695 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4696 if (worker->current_pwq == pwq) {
4697 has_in_flight = true;
4698 break;
4699 }
4700 }
4701 if (has_in_flight) {
4702 bool comma = false;
4703
4704 pr_info(" in-flight:");
4705 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4706 if (worker->current_pwq != pwq)
4707 continue;
4708
Sakari Ailusd75f7732019-03-25 21:32:28 +02004709 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004710 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004711 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004712 worker->current_func);
4713 list_for_each_entry(work, &worker->scheduled, entry)
4714 pr_cont_work(false, work);
4715 comma = true;
4716 }
4717 pr_cont("\n");
4718 }
4719
4720 list_for_each_entry(work, &pool->worklist, entry) {
4721 if (get_work_pwq(work) == pwq) {
4722 has_pending = true;
4723 break;
4724 }
4725 }
4726 if (has_pending) {
4727 bool comma = false;
4728
4729 pr_info(" pending:");
4730 list_for_each_entry(work, &pool->worklist, entry) {
4731 if (get_work_pwq(work) != pwq)
4732 continue;
4733
4734 pr_cont_work(comma, work);
4735 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4736 }
4737 pr_cont("\n");
4738 }
4739
4740 if (!list_empty(&pwq->delayed_works)) {
4741 bool comma = false;
4742
4743 pr_info(" delayed:");
4744 list_for_each_entry(work, &pwq->delayed_works, entry) {
4745 pr_cont_work(comma, work);
4746 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4747 }
4748 pr_cont("\n");
4749 }
4750}
4751
4752/**
4753 * show_workqueue_state - dump workqueue state
4754 *
Roger Lu7b776af2016-07-01 11:05:02 +08004755 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4756 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004757 */
4758void show_workqueue_state(void)
4759{
4760 struct workqueue_struct *wq;
4761 struct worker_pool *pool;
4762 unsigned long flags;
4763 int pi;
4764
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004765 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004766
4767 pr_info("Showing busy workqueues and worker pools:\n");
4768
4769 list_for_each_entry_rcu(wq, &workqueues, list) {
4770 struct pool_workqueue *pwq;
4771 bool idle = true;
4772
4773 for_each_pwq(pwq, wq) {
4774 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4775 idle = false;
4776 break;
4777 }
4778 }
4779 if (idle)
4780 continue;
4781
4782 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4783
4784 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004785 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004786 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4787 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004788 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004789 /*
4790 * We could be printing a lot from atomic context, e.g.
4791 * sysrq-t -> show_workqueue_state(). Avoid triggering
4792 * hard lockup.
4793 */
4794 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004795 }
4796 }
4797
4798 for_each_pool(pool, pi) {
4799 struct worker *worker;
4800 bool first = true;
4801
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004802 raw_spin_lock_irqsave(&pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004803 if (pool->nr_workers == pool->nr_idle)
4804 goto next_pool;
4805
4806 pr_info("pool %d:", pool->id);
4807 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004808 pr_cont(" hung=%us workers=%d",
4809 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4810 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004811 if (pool->manager)
4812 pr_cont(" manager: %d",
4813 task_pid_nr(pool->manager->task));
4814 list_for_each_entry(worker, &pool->idle_list, entry) {
4815 pr_cont(" %s%d", first ? "idle: " : "",
4816 task_pid_nr(worker->task));
4817 first = false;
4818 }
4819 pr_cont("\n");
4820 next_pool:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004821 raw_spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004822 /*
4823 * We could be printing a lot from atomic context, e.g.
4824 * sysrq-t -> show_workqueue_state(). Avoid triggering
4825 * hard lockup.
4826 */
4827 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004828 }
4829
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004830 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004831}
4832
Tejun Heo6b598082018-05-18 08:47:13 -07004833/* used to show worker information through /proc/PID/{comm,stat,status} */
4834void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4835{
Tejun Heo6b598082018-05-18 08:47:13 -07004836 int off;
4837
4838 /* always show the actual comm */
4839 off = strscpy(buf, task->comm, size);
4840 if (off < 0)
4841 return;
4842
Tejun Heo197f6ac2018-05-21 08:04:35 -07004843 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004844 mutex_lock(&wq_pool_attach_mutex);
4845
Tejun Heo197f6ac2018-05-21 08:04:35 -07004846 if (task->flags & PF_WQ_WORKER) {
4847 struct worker *worker = kthread_data(task);
4848 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004849
Tejun Heo197f6ac2018-05-21 08:04:35 -07004850 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004851 raw_spin_lock_irq(&pool->lock);
Tejun Heo197f6ac2018-05-21 08:04:35 -07004852 /*
4853 * ->desc tracks information (wq name or
4854 * set_worker_desc()) for the latest execution. If
4855 * current, prepend '+', otherwise '-'.
4856 */
4857 if (worker->desc[0] != '\0') {
4858 if (worker->current_work)
4859 scnprintf(buf + off, size - off, "+%s",
4860 worker->desc);
4861 else
4862 scnprintf(buf + off, size - off, "-%s",
4863 worker->desc);
4864 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004865 raw_spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004866 }
Tejun Heo6b598082018-05-18 08:47:13 -07004867 }
4868
4869 mutex_unlock(&wq_pool_attach_mutex);
4870}
4871
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004872#ifdef CONFIG_SMP
4873
Tejun Heodb7bccf2010-06-29 10:07:12 +02004874/*
4875 * CPU hotplug.
4876 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004877 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004878 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004879 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004880 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004881 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004882 * blocked draining impractical.
4883 *
Tejun Heo24647572013-01-24 11:01:33 -08004884 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004885 * running as an unbound one and allowing it to be reattached later if the
4886 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004887 */
4888
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004889static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004890{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004891 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004892 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004893
Tejun Heof02ae732013-03-12 11:30:03 -07004894 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004895 mutex_lock(&wq_pool_attach_mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004896 raw_spin_lock_irq(&pool->lock);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004897
4898 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004899 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004900 * unbound and set DISASSOCIATED. Before this, all workers
4901 * except for the ones which are still executing works from
4902 * before the last CPU down must be on the cpu. After
4903 * this, they may become diasporas.
4904 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004905 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004906 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004907
Tejun Heo24647572013-01-24 11:01:33 -08004908 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004909
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004910 raw_spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004911 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004912
Lai Jiangshaneb283422013-03-08 15:18:28 -08004913 /*
4914 * Call schedule() so that we cross rq->lock and thus can
4915 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4916 * This is necessary as scheduler callbacks may be invoked
4917 * from other cpus.
4918 */
4919 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004920
Lai Jiangshaneb283422013-03-08 15:18:28 -08004921 /*
4922 * Sched callbacks are disabled now. Zap nr_running.
4923 * After this, nr_running stays zero and need_more_worker()
4924 * and keep_working() are always true as long as the
4925 * worklist is not empty. This pool now behaves as an
4926 * unbound (in terms of concurrency management) pool which
4927 * are served by workers tied to the pool.
4928 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004929 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004930
4931 /*
4932 * With concurrency management just turned off, a busy
4933 * worker blocking could lead to lengthy stalls. Kick off
4934 * unbound chain execution of currently pending work items.
4935 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004936 raw_spin_lock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004937 wake_up_worker(pool);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004938 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004939 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004940}
4941
Tejun Heobd7c0892013-03-19 13:45:21 -07004942/**
4943 * rebind_workers - rebind all workers of a pool to the associated CPU
4944 * @pool: pool of interest
4945 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004946 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004947 */
4948static void rebind_workers(struct worker_pool *pool)
4949{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004950 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004951
Tejun Heo1258fae2018-05-18 08:47:13 -07004952 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004953
Tejun Heoa9ab7752013-03-19 13:45:21 -07004954 /*
4955 * Restore CPU affinity of all workers. As all idle workers should
4956 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304957 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004958 * of all workers first and then clear UNBOUND. As we're called
4959 * from CPU_ONLINE, the following shouldn't fail.
4960 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004961 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004962 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4963 pool->attrs->cpumask) < 0);
4964
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004965 raw_spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004966
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004967 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004968
Lai Jiangshanda028462014-05-20 17:46:31 +08004969 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004970 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004971
4972 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004973 * A bound idle worker should actually be on the runqueue
4974 * of the associated CPU for local wake-ups targeting it to
4975 * work. Kick all idle workers so that they migrate to the
4976 * associated CPU. Doing this in the same loop as
4977 * replacing UNBOUND with REBOUND is safe as no worker will
4978 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004979 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004980 if (worker_flags & WORKER_IDLE)
4981 wake_up_process(worker->task);
4982
4983 /*
4984 * We want to clear UNBOUND but can't directly call
4985 * worker_clr_flags() or adjust nr_running. Atomically
4986 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4987 * @worker will clear REBOUND using worker_clr_flags() when
4988 * it initiates the next execution cycle thus restoring
4989 * concurrency management. Note that when or whether
4990 * @worker clears REBOUND doesn't affect correctness.
4991 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004992 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004993 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01004994 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07004995 * fail incorrectly leading to premature concurrency
4996 * management operations.
4997 */
4998 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4999 worker_flags |= WORKER_REBOUND;
5000 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07005001 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07005002 }
5003
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005004 raw_spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07005005}
5006
Tejun Heo7dbc7252013-03-19 13:45:21 -07005007/**
5008 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5009 * @pool: unbound pool of interest
5010 * @cpu: the CPU which is coming up
5011 *
5012 * An unbound pool may end up with a cpumask which doesn't have any online
5013 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5014 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5015 * online CPU before, cpus_allowed of all its workers should be restored.
5016 */
5017static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5018{
5019 static cpumask_t cpumask;
5020 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005021
Tejun Heo1258fae2018-05-18 08:47:13 -07005022 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005023
5024 /* is @cpu allowed for @pool? */
5025 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5026 return;
5027
Tejun Heo7dbc7252013-03-19 13:45:21 -07005028 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005029
5030 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005031 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005032 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005033}
5034
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005035int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005036{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005037 struct worker_pool *pool;
5038
5039 for_each_cpu_worker_pool(pool, cpu) {
5040 if (pool->nr_workers)
5041 continue;
5042 if (!create_worker(pool))
5043 return -ENOMEM;
5044 }
5045 return 0;
5046}
5047
5048int workqueue_online_cpu(unsigned int cpu)
5049{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005050 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005051 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005052 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005053
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005054 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005055
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005056 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005057 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005058
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005059 if (pool->cpu == cpu)
5060 rebind_workers(pool);
5061 else if (pool->cpu < 0)
5062 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005063
Tejun Heo1258fae2018-05-18 08:47:13 -07005064 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005065 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005066
5067 /* update NUMA affinity of unbound workqueues */
5068 list_for_each_entry(wq, &workqueues, list)
5069 wq_update_unbound_numa(wq, cpu, true);
5070
5071 mutex_unlock(&wq_pool_mutex);
5072 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005073}
5074
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005075int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005076{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005077 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005078
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005079 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005080 if (WARN_ON(cpu != smp_processor_id()))
5081 return -1;
5082
5083 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005084
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005085 /* update NUMA affinity of unbound workqueues */
5086 mutex_lock(&wq_pool_mutex);
5087 list_for_each_entry(wq, &workqueues, list)
5088 wq_update_unbound_numa(wq, cpu, false);
5089 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005090
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005091 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005092}
5093
Rusty Russell2d3854a2008-11-05 13:39:10 +11005094struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005095 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005096 long (*fn)(void *);
5097 void *arg;
5098 long ret;
5099};
5100
Tejun Heoed48ece2012-09-18 12:48:43 -07005101static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005102{
Tejun Heoed48ece2012-09-18 12:48:43 -07005103 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5104
Rusty Russell2d3854a2008-11-05 13:39:10 +11005105 wfc->ret = wfc->fn(wfc->arg);
5106}
5107
5108/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005109 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005110 * @cpu: the cpu to run on
5111 * @fn: the function to run
5112 * @arg: the function arg
5113 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005114 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005115 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005116 *
5117 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005118 */
Tejun Heod84ff052013-03-12 11:29:59 -07005119long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005120{
Tejun Heoed48ece2012-09-18 12:48:43 -07005121 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005122
Tejun Heoed48ece2012-09-18 12:48:43 -07005123 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5124 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005125 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005126 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005127 return wfc.ret;
5128}
5129EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005130
5131/**
5132 * work_on_cpu_safe - run a function in thread context on a particular cpu
5133 * @cpu: the cpu to run on
5134 * @fn: the function to run
5135 * @arg: the function argument
5136 *
5137 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5138 * any locks which would prevent @fn from completing.
5139 *
5140 * Return: The value @fn returns.
5141 */
5142long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5143{
5144 long ret = -ENODEV;
5145
5146 get_online_cpus();
5147 if (cpu_online(cpu))
5148 ret = work_on_cpu(cpu, fn, arg);
5149 put_online_cpus();
5150 return ret;
5151}
5152EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005153#endif /* CONFIG_SMP */
5154
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005155#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305156
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005157/**
5158 * freeze_workqueues_begin - begin freezing workqueues
5159 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005160 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005161 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005162 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005163 *
5164 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005165 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005166 */
5167void freeze_workqueues_begin(void)
5168{
Tejun Heo24b8a842013-03-12 11:29:58 -07005169 struct workqueue_struct *wq;
5170 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005171
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005172 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005173
Tejun Heo6183c002013-03-12 11:29:57 -07005174 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005175 workqueue_freezing = true;
5176
Tejun Heo24b8a842013-03-12 11:29:58 -07005177 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005178 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005179 for_each_pwq(pwq, wq)
5180 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005181 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005182 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005183
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005184 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005185}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005186
5187/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005188 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005189 *
5190 * Check whether freezing is complete. This function must be called
5191 * between freeze_workqueues_begin() and thaw_workqueues().
5192 *
5193 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005194 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005195 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005196 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005197 * %true if some freezable workqueues are still busy. %false if freezing
5198 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005199 */
5200bool freeze_workqueues_busy(void)
5201{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005202 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005203 struct workqueue_struct *wq;
5204 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005205
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005206 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005207
Tejun Heo6183c002013-03-12 11:29:57 -07005208 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005209
Tejun Heo24b8a842013-03-12 11:29:58 -07005210 list_for_each_entry(wq, &workqueues, list) {
5211 if (!(wq->flags & WQ_FREEZABLE))
5212 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005213 /*
5214 * nr_active is monotonically decreasing. It's safe
5215 * to peek without lock.
5216 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005217 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005218 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005219 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005220 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005221 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005222 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005223 goto out_unlock;
5224 }
5225 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005226 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005227 }
5228out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005229 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005230 return busy;
5231}
5232
5233/**
5234 * thaw_workqueues - thaw workqueues
5235 *
5236 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005237 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005238 *
5239 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005240 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005241 */
5242void thaw_workqueues(void)
5243{
Tejun Heo24b8a842013-03-12 11:29:58 -07005244 struct workqueue_struct *wq;
5245 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005246
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005247 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005248
5249 if (!workqueue_freezing)
5250 goto out_unlock;
5251
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005252 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005253
Tejun Heo24b8a842013-03-12 11:29:58 -07005254 /* restore max_active and repopulate worklist */
5255 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005256 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005257 for_each_pwq(pwq, wq)
5258 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005259 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005260 }
5261
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005262out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005263 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005264}
5265#endif /* CONFIG_FREEZER */
5266
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005267static int workqueue_apply_unbound_cpumask(void)
5268{
5269 LIST_HEAD(ctxs);
5270 int ret = 0;
5271 struct workqueue_struct *wq;
5272 struct apply_wqattrs_ctx *ctx, *n;
5273
5274 lockdep_assert_held(&wq_pool_mutex);
5275
5276 list_for_each_entry(wq, &workqueues, list) {
5277 if (!(wq->flags & WQ_UNBOUND))
5278 continue;
5279 /* creating multiple pwqs breaks ordering guarantee */
5280 if (wq->flags & __WQ_ORDERED)
5281 continue;
5282
5283 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5284 if (!ctx) {
5285 ret = -ENOMEM;
5286 break;
5287 }
5288
5289 list_add_tail(&ctx->list, &ctxs);
5290 }
5291
5292 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5293 if (!ret)
5294 apply_wqattrs_commit(ctx);
5295 apply_wqattrs_cleanup(ctx);
5296 }
5297
5298 return ret;
5299}
5300
5301/**
5302 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5303 * @cpumask: the cpumask to set
5304 *
5305 * The low-level workqueues cpumask is a global cpumask that limits
5306 * the affinity of all unbound workqueues. This function check the @cpumask
5307 * and apply it to all unbound workqueues and updates all pwqs of them.
5308 *
5309 * Retun: 0 - Success
5310 * -EINVAL - Invalid @cpumask
5311 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5312 */
5313int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5314{
5315 int ret = -EINVAL;
5316 cpumask_var_t saved_cpumask;
5317
5318 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5319 return -ENOMEM;
5320
Tal Shorerc98a9802017-11-03 17:27:50 +02005321 /*
5322 * Not excluding isolated cpus on purpose.
5323 * If the user wishes to include them, we allow that.
5324 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005325 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5326 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005327 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005328
5329 /* save the old wq_unbound_cpumask. */
5330 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5331
5332 /* update wq_unbound_cpumask at first and apply it to wqs. */
5333 cpumask_copy(wq_unbound_cpumask, cpumask);
5334 ret = workqueue_apply_unbound_cpumask();
5335
5336 /* restore the wq_unbound_cpumask when failed. */
5337 if (ret < 0)
5338 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5339
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005340 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005341 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005342
5343 free_cpumask_var(saved_cpumask);
5344 return ret;
5345}
5346
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005347#ifdef CONFIG_SYSFS
5348/*
5349 * Workqueues with WQ_SYSFS flag set is visible to userland via
5350 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5351 * following attributes.
5352 *
5353 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5354 * max_active RW int : maximum number of in-flight work items
5355 *
5356 * Unbound workqueues have the following extra attributes.
5357 *
Wang Long9a19b462017-11-02 23:05:12 -04005358 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005359 * nice RW int : nice value of the workers
5360 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005361 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005362 */
5363struct wq_device {
5364 struct workqueue_struct *wq;
5365 struct device dev;
5366};
5367
5368static struct workqueue_struct *dev_to_wq(struct device *dev)
5369{
5370 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5371
5372 return wq_dev->wq;
5373}
5374
5375static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5376 char *buf)
5377{
5378 struct workqueue_struct *wq = dev_to_wq(dev);
5379
5380 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5381}
5382static DEVICE_ATTR_RO(per_cpu);
5383
5384static ssize_t max_active_show(struct device *dev,
5385 struct device_attribute *attr, char *buf)
5386{
5387 struct workqueue_struct *wq = dev_to_wq(dev);
5388
5389 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5390}
5391
5392static ssize_t max_active_store(struct device *dev,
5393 struct device_attribute *attr, const char *buf,
5394 size_t count)
5395{
5396 struct workqueue_struct *wq = dev_to_wq(dev);
5397 int val;
5398
5399 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5400 return -EINVAL;
5401
5402 workqueue_set_max_active(wq, val);
5403 return count;
5404}
5405static DEVICE_ATTR_RW(max_active);
5406
5407static struct attribute *wq_sysfs_attrs[] = {
5408 &dev_attr_per_cpu.attr,
5409 &dev_attr_max_active.attr,
5410 NULL,
5411};
5412ATTRIBUTE_GROUPS(wq_sysfs);
5413
5414static ssize_t wq_pool_ids_show(struct device *dev,
5415 struct device_attribute *attr, char *buf)
5416{
5417 struct workqueue_struct *wq = dev_to_wq(dev);
5418 const char *delim = "";
5419 int node, written = 0;
5420
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005421 get_online_cpus();
5422 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005423 for_each_node(node) {
5424 written += scnprintf(buf + written, PAGE_SIZE - written,
5425 "%s%d:%d", delim, node,
5426 unbound_pwq_by_node(wq, node)->pool->id);
5427 delim = " ";
5428 }
5429 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005430 rcu_read_unlock();
5431 put_online_cpus();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005432
5433 return written;
5434}
5435
5436static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5437 char *buf)
5438{
5439 struct workqueue_struct *wq = dev_to_wq(dev);
5440 int written;
5441
5442 mutex_lock(&wq->mutex);
5443 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5444 mutex_unlock(&wq->mutex);
5445
5446 return written;
5447}
5448
5449/* prepare workqueue_attrs for sysfs store operations */
5450static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5451{
5452 struct workqueue_attrs *attrs;
5453
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005454 lockdep_assert_held(&wq_pool_mutex);
5455
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005456 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005457 if (!attrs)
5458 return NULL;
5459
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005460 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005461 return attrs;
5462}
5463
5464static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5465 const char *buf, size_t count)
5466{
5467 struct workqueue_struct *wq = dev_to_wq(dev);
5468 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005469 int ret = -ENOMEM;
5470
5471 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005472
5473 attrs = wq_sysfs_prep_attrs(wq);
5474 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005475 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005476
5477 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5478 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005479 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005480 else
5481 ret = -EINVAL;
5482
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005483out_unlock:
5484 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005485 free_workqueue_attrs(attrs);
5486 return ret ?: count;
5487}
5488
5489static ssize_t wq_cpumask_show(struct device *dev,
5490 struct device_attribute *attr, char *buf)
5491{
5492 struct workqueue_struct *wq = dev_to_wq(dev);
5493 int written;
5494
5495 mutex_lock(&wq->mutex);
5496 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5497 cpumask_pr_args(wq->unbound_attrs->cpumask));
5498 mutex_unlock(&wq->mutex);
5499 return written;
5500}
5501
5502static ssize_t wq_cpumask_store(struct device *dev,
5503 struct device_attribute *attr,
5504 const char *buf, size_t count)
5505{
5506 struct workqueue_struct *wq = dev_to_wq(dev);
5507 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005508 int ret = -ENOMEM;
5509
5510 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005511
5512 attrs = wq_sysfs_prep_attrs(wq);
5513 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005514 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005515
5516 ret = cpumask_parse(buf, attrs->cpumask);
5517 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005518 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005519
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005520out_unlock:
5521 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005522 free_workqueue_attrs(attrs);
5523 return ret ?: count;
5524}
5525
5526static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5527 char *buf)
5528{
5529 struct workqueue_struct *wq = dev_to_wq(dev);
5530 int written;
5531
5532 mutex_lock(&wq->mutex);
5533 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5534 !wq->unbound_attrs->no_numa);
5535 mutex_unlock(&wq->mutex);
5536
5537 return written;
5538}
5539
5540static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5541 const char *buf, size_t count)
5542{
5543 struct workqueue_struct *wq = dev_to_wq(dev);
5544 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005545 int v, ret = -ENOMEM;
5546
5547 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005548
5549 attrs = wq_sysfs_prep_attrs(wq);
5550 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005551 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005552
5553 ret = -EINVAL;
5554 if (sscanf(buf, "%d", &v) == 1) {
5555 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005556 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005557 }
5558
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005559out_unlock:
5560 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005561 free_workqueue_attrs(attrs);
5562 return ret ?: count;
5563}
5564
5565static struct device_attribute wq_sysfs_unbound_attrs[] = {
5566 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5567 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5568 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5569 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5570 __ATTR_NULL,
5571};
5572
5573static struct bus_type wq_subsys = {
5574 .name = "workqueue",
5575 .dev_groups = wq_sysfs_groups,
5576};
5577
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005578static ssize_t wq_unbound_cpumask_show(struct device *dev,
5579 struct device_attribute *attr, char *buf)
5580{
5581 int written;
5582
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005583 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005584 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5585 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005586 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005587
5588 return written;
5589}
5590
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005591static ssize_t wq_unbound_cpumask_store(struct device *dev,
5592 struct device_attribute *attr, const char *buf, size_t count)
5593{
5594 cpumask_var_t cpumask;
5595 int ret;
5596
5597 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5598 return -ENOMEM;
5599
5600 ret = cpumask_parse(buf, cpumask);
5601 if (!ret)
5602 ret = workqueue_set_unbound_cpumask(cpumask);
5603
5604 free_cpumask_var(cpumask);
5605 return ret ? ret : count;
5606}
5607
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005608static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005609 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5610 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005611
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005612static int __init wq_sysfs_init(void)
5613{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005614 int err;
5615
5616 err = subsys_virtual_register(&wq_subsys, NULL);
5617 if (err)
5618 return err;
5619
5620 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005621}
5622core_initcall(wq_sysfs_init);
5623
5624static void wq_device_release(struct device *dev)
5625{
5626 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5627
5628 kfree(wq_dev);
5629}
5630
5631/**
5632 * workqueue_sysfs_register - make a workqueue visible in sysfs
5633 * @wq: the workqueue to register
5634 *
5635 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5636 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5637 * which is the preferred method.
5638 *
5639 * Workqueue user should use this function directly iff it wants to apply
5640 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5641 * apply_workqueue_attrs() may race against userland updating the
5642 * attributes.
5643 *
5644 * Return: 0 on success, -errno on failure.
5645 */
5646int workqueue_sysfs_register(struct workqueue_struct *wq)
5647{
5648 struct wq_device *wq_dev;
5649 int ret;
5650
5651 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305652 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005653 * attributes breaks ordering guarantee. Disallow exposing ordered
5654 * workqueues.
5655 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005656 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005657 return -EINVAL;
5658
5659 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5660 if (!wq_dev)
5661 return -ENOMEM;
5662
5663 wq_dev->wq = wq;
5664 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005665 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005666 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005667
5668 /*
5669 * unbound_attrs are created separately. Suppress uevent until
5670 * everything is ready.
5671 */
5672 dev_set_uevent_suppress(&wq_dev->dev, true);
5673
5674 ret = device_register(&wq_dev->dev);
5675 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305676 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005677 wq->wq_dev = NULL;
5678 return ret;
5679 }
5680
5681 if (wq->flags & WQ_UNBOUND) {
5682 struct device_attribute *attr;
5683
5684 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5685 ret = device_create_file(&wq_dev->dev, attr);
5686 if (ret) {
5687 device_unregister(&wq_dev->dev);
5688 wq->wq_dev = NULL;
5689 return ret;
5690 }
5691 }
5692 }
5693
5694 dev_set_uevent_suppress(&wq_dev->dev, false);
5695 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5696 return 0;
5697}
5698
5699/**
5700 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5701 * @wq: the workqueue to unregister
5702 *
5703 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5704 */
5705static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5706{
5707 struct wq_device *wq_dev = wq->wq_dev;
5708
5709 if (!wq->wq_dev)
5710 return;
5711
5712 wq->wq_dev = NULL;
5713 device_unregister(&wq_dev->dev);
5714}
5715#else /* CONFIG_SYSFS */
5716static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5717#endif /* CONFIG_SYSFS */
5718
Tejun Heo82607adc2015-12-08 11:28:04 -05005719/*
5720 * Workqueue watchdog.
5721 *
5722 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5723 * flush dependency, a concurrency managed work item which stays RUNNING
5724 * indefinitely. Workqueue stalls can be very difficult to debug as the
5725 * usual warning mechanisms don't trigger and internal workqueue state is
5726 * largely opaque.
5727 *
5728 * Workqueue watchdog monitors all worker pools periodically and dumps
5729 * state if some pools failed to make forward progress for a while where
5730 * forward progress is defined as the first item on ->worklist changing.
5731 *
5732 * This mechanism is controlled through the kernel parameter
5733 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5734 * corresponding sysfs parameter file.
5735 */
5736#ifdef CONFIG_WQ_WATCHDOG
5737
Tejun Heo82607adc2015-12-08 11:28:04 -05005738static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005739static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005740
5741static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5742static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5743
5744static void wq_watchdog_reset_touched(void)
5745{
5746 int cpu;
5747
5748 wq_watchdog_touched = jiffies;
5749 for_each_possible_cpu(cpu)
5750 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5751}
5752
Kees Cook5cd79d62017-10-04 16:27:00 -07005753static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005754{
5755 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5756 bool lockup_detected = false;
5757 struct worker_pool *pool;
5758 int pi;
5759
5760 if (!thresh)
5761 return;
5762
5763 rcu_read_lock();
5764
5765 for_each_pool(pool, pi) {
5766 unsigned long pool_ts, touched, ts;
5767
5768 if (list_empty(&pool->worklist))
5769 continue;
5770
5771 /* get the latest of pool and touched timestamps */
5772 pool_ts = READ_ONCE(pool->watchdog_ts);
5773 touched = READ_ONCE(wq_watchdog_touched);
5774
5775 if (time_after(pool_ts, touched))
5776 ts = pool_ts;
5777 else
5778 ts = touched;
5779
5780 if (pool->cpu >= 0) {
5781 unsigned long cpu_touched =
5782 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5783 pool->cpu));
5784 if (time_after(cpu_touched, ts))
5785 ts = cpu_touched;
5786 }
5787
5788 /* did we stall? */
5789 if (time_after(jiffies, ts + thresh)) {
5790 lockup_detected = true;
5791 pr_emerg("BUG: workqueue lockup - pool");
5792 pr_cont_pool_info(pool);
5793 pr_cont(" stuck for %us!\n",
5794 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5795 }
5796 }
5797
5798 rcu_read_unlock();
5799
5800 if (lockup_detected)
5801 show_workqueue_state();
5802
5803 wq_watchdog_reset_touched();
5804 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5805}
5806
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005807notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005808{
5809 if (cpu >= 0)
5810 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5811 else
5812 wq_watchdog_touched = jiffies;
5813}
5814
5815static void wq_watchdog_set_thresh(unsigned long thresh)
5816{
5817 wq_watchdog_thresh = 0;
5818 del_timer_sync(&wq_watchdog_timer);
5819
5820 if (thresh) {
5821 wq_watchdog_thresh = thresh;
5822 wq_watchdog_reset_touched();
5823 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5824 }
5825}
5826
5827static int wq_watchdog_param_set_thresh(const char *val,
5828 const struct kernel_param *kp)
5829{
5830 unsigned long thresh;
5831 int ret;
5832
5833 ret = kstrtoul(val, 0, &thresh);
5834 if (ret)
5835 return ret;
5836
5837 if (system_wq)
5838 wq_watchdog_set_thresh(thresh);
5839 else
5840 wq_watchdog_thresh = thresh;
5841
5842 return 0;
5843}
5844
5845static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5846 .set = wq_watchdog_param_set_thresh,
5847 .get = param_get_ulong,
5848};
5849
5850module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5851 0644);
5852
5853static void wq_watchdog_init(void)
5854{
Kees Cook5cd79d62017-10-04 16:27:00 -07005855 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005856 wq_watchdog_set_thresh(wq_watchdog_thresh);
5857}
5858
5859#else /* CONFIG_WQ_WATCHDOG */
5860
5861static inline void wq_watchdog_init(void) { }
5862
5863#endif /* CONFIG_WQ_WATCHDOG */
5864
Tejun Heobce90382013-04-01 11:23:32 -07005865static void __init wq_numa_init(void)
5866{
5867 cpumask_var_t *tbl;
5868 int node, cpu;
5869
Tejun Heobce90382013-04-01 11:23:32 -07005870 if (num_possible_nodes() <= 1)
5871 return;
5872
Tejun Heod55262c2013-04-01 11:23:38 -07005873 if (wq_disable_numa) {
5874 pr_info("workqueue: NUMA affinity support disabled\n");
5875 return;
5876 }
5877
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005878 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005879 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5880
Tejun Heobce90382013-04-01 11:23:32 -07005881 /*
5882 * We want masks of possible CPUs of each node which isn't readily
5883 * available. Build one from cpu_to_node() which should have been
5884 * fully initialized by now.
5885 */
Kees Cook6396bb22018-06-12 14:03:40 -07005886 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005887 BUG_ON(!tbl);
5888
5889 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005890 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005891 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005892
5893 for_each_possible_cpu(cpu) {
5894 node = cpu_to_node(cpu);
5895 if (WARN_ON(node == NUMA_NO_NODE)) {
5896 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5897 /* happens iff arch is bonkers, let's just proceed */
5898 return;
5899 }
5900 cpumask_set_cpu(cpu, tbl[node]);
5901 }
5902
5903 wq_numa_possible_cpumask = tbl;
5904 wq_numa_enabled = true;
5905}
5906
Tejun Heo3347fa02016-09-16 15:49:32 -04005907/**
5908 * workqueue_init_early - early init for workqueue subsystem
5909 *
5910 * This is the first half of two-staged workqueue subsystem initialization
5911 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5912 * idr are up. It sets up all the data structures and system workqueues
5913 * and allows early boot code to create workqueues and queue/cancel work
5914 * items. Actual work item execution starts only after kthreads can be
5915 * created and scheduled right before early initcalls.
5916 */
Yu Chen2333e822020-02-23 15:28:52 +08005917void __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005918{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005919 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005920 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005921 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005922
Lai Jiangshan10cdb152020-06-01 08:44:40 +00005923 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
Tejun Heoe904e6c2013-03-12 11:29:57 -07005924
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005925 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005926 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005927
Tejun Heoe904e6c2013-03-12 11:29:57 -07005928 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5929
Tejun Heo706026c2013-01-24 11:01:34 -08005930 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005931 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005932 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005933
Tejun Heo7a4e3442013-03-12 11:30:00 -07005934 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005935 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005936 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005937 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005938 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005939 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005940 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005941
Tejun Heo9daf9e62013-01-24 11:01:33 -08005942 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005943 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005944 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005945 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005946 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005947 }
5948
Tejun Heo8a2b7532013-09-05 12:30:04 -04005949 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005950 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5951 struct workqueue_attrs *attrs;
5952
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005953 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07005954 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005955 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005956
5957 /*
5958 * An ordered wq should have only one pwq as ordering is
5959 * guaranteed by max_active which is enforced by pwqs.
5960 * Turn off NUMA so that dfl_pwq is used for all nodes.
5961 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005962 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04005963 attrs->nice = std_nice[i];
5964 attrs->no_numa = true;
5965 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005966 }
5967
Tejun Heod320c032010-06-29 10:07:14 +02005968 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005969 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005970 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005971 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5972 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005973 system_freezable_wq = alloc_workqueue("events_freezable",
5974 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305975 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5976 WQ_POWER_EFFICIENT, 0);
5977 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5978 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5979 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005980 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305981 !system_unbound_wq || !system_freezable_wq ||
5982 !system_power_efficient_wq ||
5983 !system_freezable_power_efficient_wq);
Tejun Heo3347fa02016-09-16 15:49:32 -04005984}
5985
5986/**
5987 * workqueue_init - bring workqueue subsystem fully online
5988 *
5989 * This is the latter half of two-staged workqueue subsystem initialization
5990 * and invoked as soon as kthreads can be created and scheduled.
5991 * Workqueues have been created and work items queued on them, but there
5992 * are no kworkers executing the work items yet. Populate the worker pools
5993 * with the initial workers and enable future kworker creations.
5994 */
Yu Chen2333e822020-02-23 15:28:52 +08005995void __init workqueue_init(void)
Tejun Heo3347fa02016-09-16 15:49:32 -04005996{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005997 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005998 struct worker_pool *pool;
5999 int cpu, bkt;
6000
Tejun Heo2186d9f2016-10-19 12:01:27 -04006001 /*
6002 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6003 * CPU to node mapping may not be available that early on some
6004 * archs such as power and arm64. As per-cpu pools created
6005 * previously could be missing node hint and unbound pools NUMA
6006 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08006007 *
6008 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006009 */
6010 wq_numa_init();
6011
6012 mutex_lock(&wq_pool_mutex);
6013
6014 for_each_possible_cpu(cpu) {
6015 for_each_cpu_worker_pool(pool, cpu) {
6016 pool->node = cpu_to_node(cpu);
6017 }
6018 }
6019
Tejun Heo40c17f72018-01-08 05:38:37 -08006020 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006021 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006022 WARN(init_rescuer(wq),
6023 "workqueue: failed to create early rescuer for %s",
6024 wq->name);
6025 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006026
6027 mutex_unlock(&wq_pool_mutex);
6028
Tejun Heo3347fa02016-09-16 15:49:32 -04006029 /* create the initial workers */
6030 for_each_online_cpu(cpu) {
6031 for_each_cpu_worker_pool(pool, cpu) {
6032 pool->flags &= ~POOL_DISASSOCIATED;
6033 BUG_ON(!create_worker(pool));
6034 }
6035 }
6036
6037 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6038 BUG_ON(!create_worker(pool));
6039
6040 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006041 wq_watchdog_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006042}