blob: 33f1106b4f9992ca4e7444da1d2ea9ea53d373b0 [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>
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +090053#include <linux/kvm_para.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020054
Tejun Heoea138442013-01-18 14:05:55 -080055#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Tejun Heoc8e55f32010-06-29 10:07:12 +020057enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 /*
Tejun Heo24647572013-01-24 11:01:33 -080059 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 *
Tejun Heo24647572013-01-24 11:01:33 -080061 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070062 * While associated (!DISASSOCIATED), all workers are bound to the
63 * CPU and none has %WORKER_UNBOUND set and concurrency management
64 * is in effect.
65 *
66 * While DISASSOCIATED, the cpu may be offline and all workers have
67 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080068 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070069 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070070 * Note that DISASSOCIATED should be flipped only while holding
Tejun Heo1258fae2018-05-18 08:47:13 -070071 * wq_pool_attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080072 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070073 */
Tejun Heo692b4822017-10-09 08:04:13 -070074 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080075 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020076
Tejun Heoc8e55f32010-06-29 10:07:12 +020077 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020078 WORKER_DIE = 1 << 1, /* die die die */
79 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020080 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020081 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020082 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070083 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020084
Tejun Heoa9ab7752013-03-19 13:45:21 -070085 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
86 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020087
Tejun Heoe34cdddb2013-01-24 11:01:33 -080088 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070089
Tejun Heo29c91e92013-03-12 11:30:03 -070090 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020091 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020092
Tejun Heoe22bee72010-06-29 10:07:14 +020093 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
94 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
95
Tejun Heo3233cdb2011-02-16 18:10:19 +010096 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
97 /* call for help after 10ms
98 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020099 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
100 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +0200101
102 /*
103 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800104 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200105 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800106 RESCUER_NICE_LEVEL = MIN_NICE,
107 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700108
109 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200110};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 * Structure fields follow one of the following exclusion rules.
114 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200115 * I: Modifiable by initialization/destruction paths and read-only for
116 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200117 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200118 * P: Preemption protected. Disabling preemption is enough and should
119 * only be modified and accessed from the local cpu.
120 *
Tejun Heod565ed62013-01-24 11:01:33 -0800121 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200122 *
Tejun Heod565ed62013-01-24 11:01:33 -0800123 * X: During normal operation, modification requires pool->lock and should
124 * be done only from local cpu. Either disabling preemption on local
125 * cpu or grabbing pool->lock is enough for read access. If
126 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200127 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700128 * A: wq_pool_attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700129 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700130 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700131 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100132 * PR: wq_pool_mutex protected for writes. RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700133 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800134 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
135 *
136 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100137 * RCU for reads.
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800138 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700139 * WQ: wq->mutex protected.
140 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100141 * WR: wq->mutex protected for writes. RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700142 *
143 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200144 */
145
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800146/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200147
Tejun Heobd7bdd42012-07-12 14:46:37 -0700148struct worker_pool {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200149 raw_spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700150 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700151 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800152 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700153 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700154
Tejun Heo82607adc2015-12-08 11:28:04 -0500155 unsigned long watchdog_ts; /* L: watchdog timestamp */
156
Lai Jiangshan84f91c62021-12-07 15:35:42 +0800157 /* The current concurrency level. */
158 atomic_t nr_running;
159
Tejun Heobd7bdd42012-07-12 14:46:37 -0700160 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700161
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800162 int nr_workers; /* L: total number of workers */
163 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700164
165 struct list_head idle_list; /* X: list of idle workers */
166 struct timer_list idle_timer; /* L: worker idle timeout */
167 struct timer_list mayday_timer; /* L: SOS timer for workers */
168
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700169 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800170 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
171 /* L: hash of busy workers */
172
Tejun Heo2607d7a2015-03-09 09:22:28 -0400173 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800174 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800175 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800176
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800177 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800178
Tejun Heo7a4e3442013-03-12 11:30:00 -0700179 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700180 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
181 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700182
Tejun Heoe19e3972013-01-24 11:39:44 -0800183 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100184 * Destruction of pool is RCU protected to allow dereferences
Tejun Heo29c91e92013-03-12 11:30:03 -0700185 * from get_work_pool().
186 */
187 struct rcu_head rcu;
Lai Jiangshan84f91c62021-12-07 15:35:42 +0800188};
Tejun Heo8b03ae32010-06-29 10:07:12 +0200189
190/*
Tejun Heo112202d2013-02-13 19:29:12 -0800191 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
192 * of work_struct->data are used for flags and the remaining high bits
193 * point to the pwq; thus, pwqs need to be aligned at two's power of the
194 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 */
Tejun Heo112202d2013-02-13 19:29:12 -0800196struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700197 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200198 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200199 int work_color; /* L: current color */
200 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700201 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200202 int nr_in_flight[WORK_NR_COLORS];
203 /* L: nr of in_flight works */
Lai Jiangshan018f3a12021-08-17 09:32:37 +0800204
205 /*
206 * nr_active management and WORK_STRUCT_INACTIVE:
207 *
208 * When pwq->nr_active >= max_active, new work item is queued to
209 * pwq->inactive_works instead of pool->worklist and marked with
210 * WORK_STRUCT_INACTIVE.
211 *
212 * All work items marked with WORK_STRUCT_INACTIVE do not participate
213 * in pwq->nr_active and all work items in pwq->inactive_works are
214 * marked with WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE
215 * work items are in pwq->inactive_works. Some of them are ready to
216 * run in pool->worklist or worker->scheduled. Those work itmes are
217 * only struct wq_barrier which is used for flush_work() and should
218 * not participate in pwq->nr_active. For non-barrier work item, it
219 * is marked with WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
220 */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200221 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200222 int max_active; /* L: max active works */
Lai Jiangshanf97a4a12021-08-17 09:32:34 +0800223 struct list_head inactive_works; /* L: inactive works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700224 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700225 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700226
227 /*
228 * Release of unbound pwq is punted to system_wq. See put_pwq()
229 * and pwq_unbound_release_workfn() for details. pool_workqueue
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100230 * itself is also RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700231 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700232 */
233 struct work_struct unbound_release_work;
234 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700235} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200238 * Structure used to wait for workqueue flush.
239 */
240struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct list_head list; /* WQ: list of flushers */
242 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200243 struct completion done; /* flush completion */
244};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Tejun Heo226223a2013-03-12 11:30:05 -0700246struct wq_device;
247
Tejun Heo73f53c42010-06-29 10:07:11 +0200248/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700249 * The externally visible workqueue. It relays the issued work items to
250 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 */
252struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700253 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400254 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200255
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700256 struct mutex mutex; /* protects this wq */
257 int work_color; /* WQ: current work color */
258 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800259 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700260 struct wq_flusher *first_flusher; /* WQ: first flusher */
261 struct list_head flusher_queue; /* WQ: flush waiters */
262 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200263
Tejun Heo2e109a22013-03-13 19:47:40 -0700264 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heo30ae2fc2019-09-20 14:09:14 -0700265 struct worker *rescuer; /* MD: rescue worker */
Tejun Heoe22bee72010-06-29 10:07:14 +0200266
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700267 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700268 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700269
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800270 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
271 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700272
Tejun Heo226223a2013-03-12 11:30:05 -0700273#ifdef CONFIG_SYSFS
274 struct wq_device *wq_dev; /* I: for sysfs interface */
275#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700276#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800277 char *lock_name;
278 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200279 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700280#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700281 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700282
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400283 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100284 * Destruction of workqueue_struct is RCU protected to allow walking
285 * the workqueues list without grabbing wq_pool_mutex.
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400286 * This is used to dump all workqueues from sysrq.
287 */
288 struct rcu_head rcu;
289
Tejun Heo2728fd22013-04-01 11:23:35 -0700290 /* hot fields used during command issue, aligned to cacheline */
291 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
292 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800293 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294};
295
Tejun Heoe904e6c2013-03-12 11:29:57 -0700296static struct kmem_cache *pwq_cache;
297
Tejun Heobce90382013-04-01 11:23:32 -0700298static cpumask_var_t *wq_numa_possible_cpumask;
299 /* possible CPUs of each node */
300
Tejun Heod55262c2013-04-01 11:23:38 -0700301static bool wq_disable_numa;
302module_param_named(disable_numa, wq_disable_numa, bool, 0444);
303
Viresh Kumarcee22a12013-04-08 16:45:40 +0530304/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930305static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530306module_param_named(power_efficient, wq_power_efficient, bool, 0444);
307
Tejun Heo863b7102016-09-16 15:49:34 -0400308static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400309
Tejun Heobce90382013-04-01 11:23:32 -0700310static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
311
Tejun Heo4c16bd32013-04-01 11:23:36 -0700312/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
313static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
314
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700315static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700316static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200317static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +0200318/* wait for manager to go away */
319static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
Tejun Heo5bcab332013-03-13 19:47:40 -0700320
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400321static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700322static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700323
Mike Galbraithef5571802016-02-09 17:59:38 -0500324/* PL: allowable cpus for unbound wqs and work items */
325static cpumask_var_t wq_unbound_cpumask;
326
327/* CPU where unbound work was last round robin scheduled from this CPU */
328static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800329
Tejun Heof303fccb2016-02-09 17:59:38 -0500330/*
331 * Local execution of unbound work items is no longer guaranteed. The
332 * following always forces round-robin CPU selection on unbound work items
333 * to uncover usages which depend on it.
334 */
335#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
336static bool wq_debug_force_rr_cpu = true;
337#else
338static bool wq_debug_force_rr_cpu = false;
339#endif
340module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
341
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700342/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700343static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700344
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700345static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700346
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700347/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700348static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
349
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700350/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700351static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
352
Tejun Heo8a2b7532013-09-05 12:30:04 -0400353/* I: attributes used when instantiating ordered pools on demand */
354static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
355
Tejun Heod320c032010-06-29 10:07:14 +0200356struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400357EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300358struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900359EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300360struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200361EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300362struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200363EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300364struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100365EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530366struct workqueue_struct *system_power_efficient_wq __read_mostly;
367EXPORT_SYMBOL_GPL(system_power_efficient_wq);
368struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
369EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200370
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700371static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800372static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heoc29eb852019-09-23 11:08:58 -0700373static void show_pwq(struct pool_workqueue *pwq);
Imran Khan55df0932021-10-20 14:09:00 +1100374static void show_one_worker_pool(struct worker_pool *pool);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700375
Tejun Heo97bd2342010-10-05 10:41:14 +0200376#define CREATE_TRACE_POINTS
377#include <trace/events/workqueue.h>
378
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700379#define assert_rcu_or_pool_mutex() \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100380 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700381 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100382 "RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700383
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800384#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100385 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700386 !lockdep_is_held(&wq->mutex) && \
387 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100388 "RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800389
Tejun Heof02ae732013-03-12 11:30:03 -0700390#define for_each_cpu_worker_pool(pool, cpu) \
391 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
392 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700393 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700394
Tejun Heo49e3cf42013-03-12 11:29:58 -0700395/**
Tejun Heo17116962013-03-12 11:29:58 -0700396 * for_each_pool - iterate through all worker_pools in the system
397 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700398 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700399 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100400 * This must be called either with wq_pool_mutex held or RCU read
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700401 * locked. If the pool needs to be used beyond the locking in effect, the
402 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700403 *
404 * The if/else clause exists only for the lockdep assertion and can be
405 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700406 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700407#define for_each_pool(pool, pi) \
408 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700409 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700410 else
Tejun Heo17116962013-03-12 11:29:58 -0700411
412/**
Tejun Heo822d8402013-03-19 13:45:21 -0700413 * for_each_pool_worker - iterate through all workers of a worker_pool
414 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700415 * @pool: worker_pool to iterate workers of
416 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700417 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700418 *
419 * The if/else clause exists only for the lockdep assertion and can be
420 * ignored.
421 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800422#define for_each_pool_worker(worker, pool) \
423 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700424 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700425 else
426
427/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700428 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
429 * @pwq: iteration cursor
430 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700431 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100432 * This must be called either with wq->mutex held or RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700433 * If the pwq needs to be used beyond the locking in effect, the caller is
434 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700435 *
436 * The if/else clause exists only for the lockdep assertion and can be
437 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700438 */
439#define for_each_pwq(pwq, wq) \
Sebastian Andrzej Siewior49e9d1a2019-11-15 19:01:25 +0100440 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
Joel Fernandes (Google)5a644662019-08-15 10:18:42 -0400441 lockdep_is_held(&(wq->mutex)))
Tejun Heof3421792010-07-02 10:03:51 +0200442
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900443#ifdef CONFIG_DEBUG_OBJECTS_WORK
444
Stephen Boydf9e62f32020-08-14 17:40:27 -0700445static const struct debug_obj_descr work_debug_descr;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900446
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100447static void *work_debug_hint(void *addr)
448{
449 return ((struct work_struct *) addr)->func;
450}
451
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700452static bool work_is_static_object(void *addr)
453{
454 struct work_struct *work = addr;
455
456 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
457}
458
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900459/*
460 * fixup_init is called when:
461 * - an active object is initialized
462 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700463static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900464{
465 struct work_struct *work = addr;
466
467 switch (state) {
468 case ODEBUG_STATE_ACTIVE:
469 cancel_work_sync(work);
470 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700471 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900472 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700473 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900474 }
475}
476
477/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 * fixup_free is called when:
479 * - an active object is freed
480 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700481static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900482{
483 struct work_struct *work = addr;
484
485 switch (state) {
486 case ODEBUG_STATE_ACTIVE:
487 cancel_work_sync(work);
488 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700489 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900490 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700491 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900492 }
493}
494
Stephen Boydf9e62f32020-08-14 17:40:27 -0700495static const struct debug_obj_descr work_debug_descr = {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900496 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100497 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700498 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900499 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900500 .fixup_free = work_fixup_free,
501};
502
503static inline void debug_work_activate(struct work_struct *work)
504{
505 debug_object_activate(work, &work_debug_descr);
506}
507
508static inline void debug_work_deactivate(struct work_struct *work)
509{
510 debug_object_deactivate(work, &work_debug_descr);
511}
512
513void __init_work(struct work_struct *work, int onstack)
514{
515 if (onstack)
516 debug_object_init_on_stack(work, &work_debug_descr);
517 else
518 debug_object_init(work, &work_debug_descr);
519}
520EXPORT_SYMBOL_GPL(__init_work);
521
522void destroy_work_on_stack(struct work_struct *work)
523{
524 debug_object_free(work, &work_debug_descr);
525}
526EXPORT_SYMBOL_GPL(destroy_work_on_stack);
527
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000528void destroy_delayed_work_on_stack(struct delayed_work *work)
529{
530 destroy_timer_on_stack(&work->timer);
531 debug_object_free(&work->work, &work_debug_descr);
532}
533EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
534
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900535#else
536static inline void debug_work_activate(struct work_struct *work) { }
537static inline void debug_work_deactivate(struct work_struct *work) { }
538#endif
539
Li Bin4e8b22b2013-09-10 09:52:35 +0800540/**
Cai Huoqing67dc8322021-07-31 08:01:29 +0800541 * worker_pool_assign_id - allocate ID and assign it to @pool
Li Bin4e8b22b2013-09-10 09:52:35 +0800542 * @pool: the pool pointer of interest
543 *
544 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
545 * successfully, -errno on failure.
546 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800547static int worker_pool_assign_id(struct worker_pool *pool)
548{
549 int ret;
550
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700551 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700552
Li Bin4e8b22b2013-09-10 09:52:35 +0800553 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
554 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700555 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700556 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700557 return 0;
558 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800559 return ret;
560}
561
Tejun Heo76af4d92013-03-12 11:30:00 -0700562/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700563 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
564 * @wq: the target workqueue
565 * @node: the node ID
566 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100567 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800568 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700569 * If the pwq needs to be used beyond the locking in effect, the caller is
570 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700571 *
572 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700573 */
574static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
575 int node)
576{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800577 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500578
579 /*
580 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
581 * delayed item is pending. The plan is to keep CPU -> NODE
582 * mapping valid and stable across CPU on/offlines. Once that
583 * happens, this workaround can be removed.
584 */
585 if (unlikely(node == NUMA_NO_NODE))
586 return wq->dfl_pwq;
587
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700588 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
589}
590
Tejun Heo73f53c42010-06-29 10:07:11 +0200591static unsigned int work_color_to_flags(int color)
592{
593 return color << WORK_STRUCT_COLOR_SHIFT;
594}
595
Lai Jiangshanc4560c22021-08-17 09:32:35 +0800596static int get_work_color(unsigned long work_data)
Tejun Heo73f53c42010-06-29 10:07:11 +0200597{
Lai Jiangshanc4560c22021-08-17 09:32:35 +0800598 return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
Tejun Heo73f53c42010-06-29 10:07:11 +0200599 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
600}
601
602static int work_next_color(int color)
603{
604 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700605}
606
David Howells4594bf12006-12-07 11:33:26 +0000607/*
Tejun Heo112202d2013-02-13 19:29:12 -0800608 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
609 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800610 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200611 *
Tejun Heo112202d2013-02-13 19:29:12 -0800612 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
613 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700614 * work->data. These functions should only be called while the work is
615 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200616 *
Tejun Heo112202d2013-02-13 19:29:12 -0800617 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800618 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800619 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800620 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700621 *
622 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
623 * canceled. While being canceled, a work item may have its PENDING set
624 * but stay off timer and worklist for arbitrarily long and nobody should
625 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000626 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200627static inline void set_work_data(struct work_struct *work, unsigned long data,
628 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000629{
Tejun Heo6183c002013-03-12 11:29:57 -0700630 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200631 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000632}
David Howells365970a2006-11-22 14:54:49 +0000633
Tejun Heo112202d2013-02-13 19:29:12 -0800634static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200635 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200636{
Tejun Heo112202d2013-02-13 19:29:12 -0800637 set_work_data(work, (unsigned long)pwq,
638 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200639}
640
Lai Jiangshan4468a002013-02-06 18:04:53 -0800641static void set_work_pool_and_keep_pending(struct work_struct *work,
642 int pool_id)
643{
644 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
645 WORK_STRUCT_PENDING);
646}
647
Tejun Heo7c3eed52013-01-24 11:01:33 -0800648static void set_work_pool_and_clear_pending(struct work_struct *work,
649 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000650{
Tejun Heo23657bb2012-08-13 17:08:19 -0700651 /*
652 * The following wmb is paired with the implied mb in
653 * test_and_set_bit(PENDING) and ensures all updates to @work made
654 * here are visible to and precede any updates by the next PENDING
655 * owner.
656 */
657 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800658 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200659 /*
660 * The following mb guarantees that previous clear of a PENDING bit
661 * will not be reordered with any speculative LOADS or STORES from
662 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800663 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200664 * the same @work. E.g. consider this case:
665 *
666 * CPU#0 CPU#1
667 * ---------------------------- --------------------------------
668 *
669 * 1 STORE event_indicated
670 * 2 queue_work_on() {
671 * 3 test_and_set_bit(PENDING)
672 * 4 } set_..._and_clear_pending() {
673 * 5 set_work_data() # clear bit
674 * 6 smp_mb()
675 * 7 work->current_func() {
676 * 8 LOAD event_indicated
677 * }
678 *
679 * Without an explicit full barrier speculative LOAD on line 8 can
680 * be executed before CPU#0 does STORE on line 1. If that happens,
681 * CPU#0 observes the PENDING bit is still set and new execution of
682 * a @work is not queued in a hope, that CPU#1 will eventually
683 * finish the queued @work. Meanwhile CPU#1 does not see
684 * event_indicated is set, because speculative LOAD was executed
685 * before actual STORE.
686 */
687 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200688}
689
690static void clear_work_data(struct work_struct *work)
691{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800692 smp_wmb(); /* see set_work_pool_and_clear_pending() */
693 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200694}
695
Tejun Heo112202d2013-02-13 19:29:12 -0800696static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200697{
Tejun Heoe1201532010-07-22 14:14:25 +0200698 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200699
Tejun Heo112202d2013-02-13 19:29:12 -0800700 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200701 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
702 else
703 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200704}
705
Tejun Heo7c3eed52013-01-24 11:01:33 -0800706/**
707 * get_work_pool - return the worker_pool a given work was associated with
708 * @work: the work item of interest
709 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700710 * Pools are created and destroyed under wq_pool_mutex, and allows read
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100711 * access under RCU read lock. As such, this function should be
712 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700713 *
714 * All fields of the returned pool are accessible as long as the above
715 * mentioned locking is in effect. If the returned pool needs to be used
716 * beyond the critical section, the caller is responsible for ensuring the
717 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700718 *
719 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800720 */
721static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200722{
Tejun Heoe1201532010-07-22 14:14:25 +0200723 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800724 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200725
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700726 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700727
Tejun Heo112202d2013-02-13 19:29:12 -0800728 if (data & WORK_STRUCT_PWQ)
729 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800730 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200731
Tejun Heo7c3eed52013-01-24 11:01:33 -0800732 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
733 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200734 return NULL;
735
Tejun Heofa1b54e2013-03-12 11:30:00 -0700736 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800737}
738
739/**
740 * get_work_pool_id - return the worker pool ID a given work is associated with
741 * @work: the work item of interest
742 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700743 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800744 * %WORK_OFFQ_POOL_NONE if none.
745 */
746static int get_work_pool_id(struct work_struct *work)
747{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800748 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800749
Tejun Heo112202d2013-02-13 19:29:12 -0800750 if (data & WORK_STRUCT_PWQ)
751 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800752 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
753
754 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800755}
756
Tejun Heobbb68df2012-08-03 10:30:46 -0700757static void mark_work_canceling(struct work_struct *work)
758{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800759 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700760
Tejun Heo7c3eed52013-01-24 11:01:33 -0800761 pool_id <<= WORK_OFFQ_POOL_SHIFT;
762 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700763}
764
765static bool work_is_canceling(struct work_struct *work)
766{
767 unsigned long data = atomic_long_read(&work->data);
768
Tejun Heo112202d2013-02-13 19:29:12 -0800769 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700770}
771
David Howells365970a2006-11-22 14:54:49 +0000772/*
Tejun Heo32704762012-07-13 22:16:45 -0700773 * Policy functions. These define the policies on how the global worker
774 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800775 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000776 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200777
Tejun Heo63d95a92012-07-12 14:46:37 -0700778static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000779{
Tejun Heoe19e3972013-01-24 11:39:44 -0800780 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000781}
782
Tejun Heoe22bee72010-06-29 10:07:14 +0200783/*
784 * Need to wake up a worker? Called from anything but currently
785 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700786 *
787 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800788 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700789 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200790 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700791static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000792{
Tejun Heo63d95a92012-07-12 14:46:37 -0700793 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000794}
795
Tejun Heoe22bee72010-06-29 10:07:14 +0200796/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700797static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200798{
Tejun Heo63d95a92012-07-12 14:46:37 -0700799 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200800}
801
802/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700803static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200804{
Tejun Heoe19e3972013-01-24 11:39:44 -0800805 return !list_empty(&pool->worklist) &&
806 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807}
808
809/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700810static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200811{
Tejun Heo63d95a92012-07-12 14:46:37 -0700812 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200813}
814
Tejun Heoe22bee72010-06-29 10:07:14 +0200815/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700816static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200817{
Tejun Heo692b4822017-10-09 08:04:13 -0700818 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700819 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
820 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200821
822 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
823}
824
825/*
826 * Wake up functions.
827 */
828
Lai Jiangshan1037de32014-05-22 16:44:07 +0800829/* Return the first idle worker. Safe with preemption disabled */
830static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200831{
Tejun Heo63d95a92012-07-12 14:46:37 -0700832 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200833 return NULL;
834
Tejun Heo63d95a92012-07-12 14:46:37 -0700835 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200836}
837
838/**
839 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700840 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200841 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700842 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200843 *
844 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200845 * raw_spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200846 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700847static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200848{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800849 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200850
851 if (likely(worker))
852 wake_up_process(worker->task);
853}
854
Tejun Heo4690c4a2010-06-29 10:07:10 +0200855/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100856 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200857 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200858 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100859 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200860 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100861void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200862{
863 struct worker *worker = kthread_data(task);
864
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100865 if (!worker->sleeping)
866 return;
Frederic Weisbecker07edfec2021-12-01 16:19:44 +0100867
868 /*
869 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
870 * and the nr_running increment below, we may ruin the nr_running reset
871 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
872 * pool. Protect against such race.
873 */
874 preempt_disable();
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100875 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800876 atomic_inc(&worker->pool->nr_running);
Frederic Weisbecker07edfec2021-12-01 16:19:44 +0100877 preempt_enable();
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100878 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200879}
880
881/**
882 * wq_worker_sleeping - a worker is going to sleep
883 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200884 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100885 * This function is called from schedule() when a busy worker is
Lai Jiangshanccf45152021-12-07 15:35:37 +0800886 * going to sleep.
Tejun Heoe22bee72010-06-29 10:07:14 +0200887 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100888void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200889{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100890 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800891 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200892
Tejun Heo111c2252013-01-17 17:16:24 -0800893 /*
894 * Rescuers, which may not have all the fields set up like normal
895 * workers, also reach here, let's not access anything before
896 * checking NOT_RUNNING.
897 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500898 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100899 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200900
Tejun Heo111c2252013-01-17 17:16:24 -0800901 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800902
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100903 /* Return if preempted before wq_worker_running() was reached */
904 if (worker->sleeping)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100905 return;
906
907 worker->sleeping = 1;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200908 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200909
910 /*
Frederic Weisbecker45c753f2021-12-01 16:19:45 +0100911 * Recheck in case unbind_workers() preempted us. We don't
912 * want to decrement nr_running after the worker is unbound
913 * and nr_running has been reset.
914 */
915 if (worker->flags & WORKER_NOT_RUNNING) {
916 raw_spin_unlock_irq(&pool->lock);
917 return;
918 }
919
920 /*
Tejun Heoe22bee72010-06-29 10:07:14 +0200921 * The counterpart of the following dec_and_test, implied mb,
922 * worklist not empty test sequence is in insert_work().
923 * Please read comment there.
924 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700925 * NOT_RUNNING is clear. This means that we're bound to and
926 * running on the local cpu w/ rq lock held and preemption
927 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800928 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700929 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200930 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800931 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100932 !list_empty(&pool->worklist)) {
933 next = first_idle_worker(pool);
934 if (next)
935 wake_up_process(next->task);
936 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200937 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200938}
939
940/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800941 * wq_worker_last_func - retrieve worker's last work function
Bart Van Assche8194fe92019-03-19 10:45:09 -0700942 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800943 *
944 * Determine the last function a worker executed. This is called from
945 * the scheduler to get a worker's last known identity.
946 *
947 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200948 * raw_spin_lock_irq(rq->lock)
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800949 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800950 * This function is called during schedule() when a kworker is going
951 * to sleep. It's used by psi to identify aggregation workers during
952 * dequeuing, to allow periodic aggregation to shut-off when that
953 * worker is the last task in the system or cgroup to go to sleep.
954 *
955 * As this function doesn't involve any workqueue-related locking, it
956 * only returns stable values when called from inside the scheduler's
957 * queuing and dequeuing paths, when @task, which must be a kworker,
958 * is guaranteed to not be processing any works.
959 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800960 * Return:
961 * The last work function %current executed as a worker, NULL if it
962 * hasn't executed any work yet.
963 */
964work_func_t wq_worker_last_func(struct task_struct *task)
965{
966 struct worker *worker = kthread_data(task);
967
968 return worker->last_func;
969}
970
971/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200972 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200973 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200974 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200975 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800976 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200977 *
Tejun Heocb444762010-07-02 10:03:50 +0200978 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200979 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200980 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800981static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200982{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700983 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200984
Tejun Heocb444762010-07-02 10:03:50 +0200985 WARN_ON_ONCE(worker->task != current);
986
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800987 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200988 if ((flags & WORKER_NOT_RUNNING) &&
989 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800990 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200991 }
992
Tejun Heod302f012010-06-29 10:07:13 +0200993 worker->flags |= flags;
994}
995
996/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200997 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200998 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200999 * @flags: flags to clear
1000 *
Tejun Heoe22bee72010-06-29 10:07:14 +02001001 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +02001002 *
Tejun Heocb444762010-07-02 10:03:50 +02001003 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001004 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +02001005 */
1006static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
1007{
Tejun Heo63d95a92012-07-12 14:46:37 -07001008 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001009 unsigned int oflags = worker->flags;
1010
Tejun Heocb444762010-07-02 10:03:50 +02001011 WARN_ON_ONCE(worker->task != current);
1012
Tejun Heod302f012010-06-29 10:07:13 +02001013 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +02001014
Tejun Heo42c025f2011-01-11 15:58:49 +01001015 /*
1016 * If transitioning out of NOT_RUNNING, increment nr_running. Note
1017 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
1018 * of multiple flags, not a single flag.
1019 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001020 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1021 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -08001022 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +02001023}
1024
1025/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001026 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001027 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001028 * @work: work to find worker for
1029 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001030 * Find a worker which is executing @work on @pool by searching
1031 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001032 * to match, its current execution should match the address of @work and
1033 * its work function. This is to avoid unwanted dependency between
1034 * unrelated work executions through a work item being recycled while still
1035 * being executed.
1036 *
1037 * This is a bit tricky. A work item may be freed once its execution
1038 * starts and nothing prevents the freed area from being recycled for
1039 * another work item. If the same work item address ends up being reused
1040 * before the original execution finishes, workqueue will identify the
1041 * recycled work item as currently executing and make it wait until the
1042 * current execution finishes, introducing an unwanted dependency.
1043 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001044 * This function checks the work item address and work function to avoid
1045 * false positives. Note that this isn't complete as one may construct a
1046 * work function which can introduce dependency onto itself through a
1047 * recycled work item. Well, if somebody wants to shoot oneself in the
1048 * foot that badly, there's only so much we can do, and if such deadlock
1049 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001050 *
1051 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001052 * raw_spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001053 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001054 * Return:
1055 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001056 * otherwise.
1057 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001058static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001059 struct work_struct *work)
1060{
Sasha Levin42f85702012-12-17 10:01:23 -05001061 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001062
Sasha Levinb67bfe02013-02-27 17:06:00 -08001063 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001064 (unsigned long)work)
1065 if (worker->current_work == work &&
1066 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001067 return worker;
1068
1069 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001070}
1071
1072/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001073 * move_linked_works - move linked works to a list
1074 * @work: start of series of works to be scheduled
1075 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301076 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001077 *
1078 * Schedule linked works starting from @work to @head. Work series to
1079 * be scheduled starts at @work and includes any consecutive work with
1080 * WORK_STRUCT_LINKED set in its predecessor.
1081 *
1082 * If @nextp is not NULL, it's updated to point to the next work of
1083 * the last scheduled work. This allows move_linked_works() to be
1084 * nested inside outer list_for_each_entry_safe().
1085 *
1086 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001087 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001088 */
1089static void move_linked_works(struct work_struct *work, struct list_head *head,
1090 struct work_struct **nextp)
1091{
1092 struct work_struct *n;
1093
1094 /*
1095 * Linked worklist will always end before the end of the list,
1096 * use NULL for list head.
1097 */
1098 list_for_each_entry_safe_from(work, n, NULL, entry) {
1099 list_move_tail(&work->entry, head);
1100 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1101 break;
1102 }
1103
1104 /*
1105 * If we're already inside safe list traversal and have moved
1106 * multiple works to the scheduled queue, the next position
1107 * needs to be updated.
1108 */
1109 if (nextp)
1110 *nextp = n;
1111}
1112
Tejun Heo8864b4e2013-03-12 11:30:04 -07001113/**
1114 * get_pwq - get an extra reference on the specified pool_workqueue
1115 * @pwq: pool_workqueue to get
1116 *
1117 * Obtain an extra reference on @pwq. The caller should guarantee that
1118 * @pwq has positive refcnt and be holding the matching pool->lock.
1119 */
1120static void get_pwq(struct pool_workqueue *pwq)
1121{
1122 lockdep_assert_held(&pwq->pool->lock);
1123 WARN_ON_ONCE(pwq->refcnt <= 0);
1124 pwq->refcnt++;
1125}
1126
1127/**
1128 * put_pwq - put a pool_workqueue reference
1129 * @pwq: pool_workqueue to put
1130 *
1131 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1132 * destruction. The caller should be holding the matching pool->lock.
1133 */
1134static void put_pwq(struct pool_workqueue *pwq)
1135{
1136 lockdep_assert_held(&pwq->pool->lock);
1137 if (likely(--pwq->refcnt))
1138 return;
1139 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1140 return;
1141 /*
1142 * @pwq can't be released under pool->lock, bounce to
1143 * pwq_unbound_release_workfn(). This never recurses on the same
1144 * pool->lock as this path is taken only for unbound workqueues and
1145 * the release work item is scheduled on a per-cpu workqueue. To
1146 * avoid lockdep warning, unbound pool->locks are given lockdep
1147 * subclass of 1 in get_unbound_pool().
1148 */
1149 schedule_work(&pwq->unbound_release_work);
1150}
1151
Tejun Heodce90d42013-04-01 11:23:35 -07001152/**
1153 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1154 * @pwq: pool_workqueue to put (can be %NULL)
1155 *
1156 * put_pwq() with locking. This function also allows %NULL @pwq.
1157 */
1158static void put_pwq_unlocked(struct pool_workqueue *pwq)
1159{
1160 if (pwq) {
1161 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001162 * As both pwqs and pools are RCU protected, the
Tejun Heodce90d42013-04-01 11:23:35 -07001163 * following lock operations are safe.
1164 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001165 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001166 put_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001167 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001168 }
1169}
1170
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001171static void pwq_activate_inactive_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001172{
Tejun Heo112202d2013-02-13 19:29:12 -08001173 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001174
1175 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001176 if (list_empty(&pwq->pool->worklist))
1177 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001178 move_linked_works(work, &pwq->pool->worklist, NULL);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001179 __clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001180 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001181}
1182
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001183static void pwq_activate_first_inactive(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001184{
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001185 struct work_struct *work = list_first_entry(&pwq->inactive_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001186 struct work_struct, entry);
1187
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001188 pwq_activate_inactive_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001189}
1190
Tejun Heobf4ede02012-08-03 10:30:46 -07001191/**
Tejun Heo112202d2013-02-13 19:29:12 -08001192 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1193 * @pwq: pwq of interest
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001194 * @work_data: work_data of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001195 *
1196 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001197 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001198 *
1199 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001200 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001201 */
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001202static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
Tejun Heobf4ede02012-08-03 10:30:46 -07001203{
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001204 int color = get_work_color(work_data);
1205
Lai Jiangshan018f3a12021-08-17 09:32:37 +08001206 if (!(work_data & WORK_STRUCT_INACTIVE)) {
1207 pwq->nr_active--;
1208 if (!list_empty(&pwq->inactive_works)) {
1209 /* one down, submit an inactive one */
1210 if (pwq->nr_active < pwq->max_active)
1211 pwq_activate_first_inactive(pwq);
1212 }
1213 }
1214
Tejun Heo112202d2013-02-13 19:29:12 -08001215 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001216
Tejun Heobf4ede02012-08-03 10:30:46 -07001217 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001218 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001219 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001220
1221 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001222 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001223 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001224
Tejun Heo112202d2013-02-13 19:29:12 -08001225 /* this pwq is done, clear flush_color */
1226 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001227
1228 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001229 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001230 * will handle the rest.
1231 */
Tejun Heo112202d2013-02-13 19:29:12 -08001232 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1233 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001234out_put:
1235 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001236}
1237
Tejun Heo36e227d2012-08-03 10:30:46 -07001238/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001239 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001240 * @work: work item to steal
1241 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001242 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001243 *
1244 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001245 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001246 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001247 * Return:
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001248 *
1249 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001250 * 1 if @work was pending and we successfully stole PENDING
1251 * 0 if @work was idle and we claimed PENDING
1252 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001253 * -ENOENT if someone else is canceling @work, this state may persist
1254 * for arbitrarily long
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001255 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001256 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001257 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001258 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001259 * interrupted while holding PENDING and @work off queue, irq must be
1260 * disabled on entry. This, combined with delayed_work->timer being
1261 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001262 *
1263 * On successful return, >= 0, irq is disabled and the caller is
1264 * responsible for releasing it using local_irq_restore(*@flags).
1265 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001266 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001267 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001268static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1269 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001270{
Tejun Heod565ed62013-01-24 11:01:33 -08001271 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001272 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001273
Tejun Heobbb68df2012-08-03 10:30:46 -07001274 local_irq_save(*flags);
1275
Tejun Heo36e227d2012-08-03 10:30:46 -07001276 /* try to steal the timer if it exists */
1277 if (is_dwork) {
1278 struct delayed_work *dwork = to_delayed_work(work);
1279
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001280 /*
1281 * dwork->timer is irqsafe. If del_timer() fails, it's
1282 * guaranteed that the timer is not queued anywhere and not
1283 * running on the local CPU.
1284 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001285 if (likely(del_timer(&dwork->timer)))
1286 return 1;
1287 }
1288
1289 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001290 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1291 return 0;
1292
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001293 rcu_read_lock();
Tejun Heobf4ede02012-08-03 10:30:46 -07001294 /*
1295 * The queueing is in progress, or it is already queued. Try to
1296 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1297 */
Tejun Heod565ed62013-01-24 11:01:33 -08001298 pool = get_work_pool(work);
1299 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001300 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001301
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001302 raw_spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001303 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001304 * work->data is guaranteed to point to pwq only while the work
1305 * item is queued on pwq->wq, and both updating work->data to point
1306 * to pwq on queueing and to pool on dequeueing are done under
1307 * pwq->pool->lock. This in turn guarantees that, if work->data
1308 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001309 * item is currently queued on that pool.
1310 */
Tejun Heo112202d2013-02-13 19:29:12 -08001311 pwq = get_work_pwq(work);
1312 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001313 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001314
Tejun Heo16062832013-02-06 18:04:53 -08001315 /*
Lai Jiangshan018f3a12021-08-17 09:32:37 +08001316 * A cancelable inactive work item must be in the
1317 * pwq->inactive_works since a queued barrier can't be
1318 * canceled (see the comments in insert_wq_barrier()).
1319 *
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001320 * An inactive work item cannot be grabbed directly because
Lai Jiangshand8127962021-08-17 09:32:38 +08001321 * it might have linked barrier work items which, if left
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001322 * on the inactive_works list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001323 * management later on and cause stall. Make sure the work
1324 * item is activated before grabbing.
1325 */
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001326 if (*work_data_bits(work) & WORK_STRUCT_INACTIVE)
1327 pwq_activate_inactive_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001328
Tejun Heo16062832013-02-06 18:04:53 -08001329 list_del_init(&work->entry);
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001330 pwq_dec_nr_in_flight(pwq, *work_data_bits(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001331
Tejun Heo112202d2013-02-13 19:29:12 -08001332 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001333 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001334
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001335 raw_spin_unlock(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001336 rcu_read_unlock();
Tejun Heo16062832013-02-06 18:04:53 -08001337 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001338 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001339 raw_spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001340fail:
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001341 rcu_read_unlock();
Tejun Heobbb68df2012-08-03 10:30:46 -07001342 local_irq_restore(*flags);
1343 if (work_is_canceling(work))
1344 return -ENOENT;
1345 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001346 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001347}
1348
1349/**
Tejun Heo706026c2013-01-24 11:01:34 -08001350 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001351 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001352 * @work: work to insert
1353 * @head: insertion point
1354 * @extra_flags: extra WORK_STRUCT_* flags to set
1355 *
Tejun Heo112202d2013-02-13 19:29:12 -08001356 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001357 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001358 *
1359 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001360 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001361 */
Tejun Heo112202d2013-02-13 19:29:12 -08001362static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1363 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001364{
Tejun Heo112202d2013-02-13 19:29:12 -08001365 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001366
Walter Wue89a85d2020-12-14 19:09:09 -08001367 /* record the work call stack in order to print it in KASAN reports */
Marco Elverf70da742021-11-05 13:35:50 -07001368 kasan_record_aux_stack_noalloc(work);
Walter Wue89a85d2020-12-14 19:09:09 -08001369
Tejun Heo4690c4a2010-06-29 10:07:10 +02001370 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001371 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001372 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001373 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001374
1375 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001376 * Ensure either wq_worker_sleeping() sees the above
1377 * list_add_tail() or we see zero nr_running to avoid workers lying
1378 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001379 */
1380 smp_mb();
1381
Tejun Heo63d95a92012-07-12 14:46:37 -07001382 if (__need_more_worker(pool))
1383 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001384}
1385
Tejun Heoc8efcc22010-12-20 19:32:04 +01001386/*
1387 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001388 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001389 */
1390static bool is_chained_work(struct workqueue_struct *wq)
1391{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001392 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001393
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001394 worker = current_wq_worker();
1395 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001396 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001397 * I'm @worker, it's safe to dereference it without locking.
1398 */
Tejun Heo112202d2013-02-13 19:29:12 -08001399 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001400}
1401
Mike Galbraithef5571802016-02-09 17:59:38 -05001402/*
1403 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1404 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1405 * avoid perturbing sensitive tasks.
1406 */
1407static int wq_select_unbound_cpu(int cpu)
1408{
Tejun Heof303fccb2016-02-09 17:59:38 -05001409 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001410 int new_cpu;
1411
Tejun Heof303fccb2016-02-09 17:59:38 -05001412 if (likely(!wq_debug_force_rr_cpu)) {
1413 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1414 return cpu;
1415 } else if (!printed_dbg_warning) {
1416 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1417 printed_dbg_warning = true;
1418 }
1419
Mike Galbraithef5571802016-02-09 17:59:38 -05001420 if (cpumask_empty(wq_unbound_cpumask))
1421 return cpu;
1422
1423 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1424 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1425 if (unlikely(new_cpu >= nr_cpu_ids)) {
1426 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1427 if (unlikely(new_cpu >= nr_cpu_ids))
1428 return cpu;
1429 }
1430 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1431
1432 return new_cpu;
1433}
1434
Tejun Heod84ff052013-03-12 11:29:59 -07001435static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 struct work_struct *work)
1437{
Tejun Heo112202d2013-02-13 19:29:12 -08001438 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001439 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001440 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001441 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001442 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001443
1444 /*
1445 * While a work item is PENDING && off queue, a task trying to
1446 * steal the PENDING will busy-loop waiting for it to either get
1447 * queued or lose PENDING. Grabbing PENDING and queueing should
1448 * happen with IRQ disabled.
1449 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001450 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001452
Li Bin9ef28a72013-09-09 13:13:58 +08001453 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001454 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001455 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001456 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001457 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001458retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001459 /* pwq which will be used unless @work is executing elsewhere */
Hillf Dantonaa202f12020-01-24 20:14:45 -05001460 if (wq->flags & WQ_UNBOUND) {
1461 if (req_cpu == WORK_CPU_UNBOUND)
1462 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001463 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Dantonaa202f12020-01-24 20:14:45 -05001464 } else {
1465 if (req_cpu == WORK_CPU_UNBOUND)
1466 cpu = raw_smp_processor_id();
1467 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1468 }
Tejun Heodbf25762012-08-20 14:51:23 -07001469
Tejun Heoc9178082013-03-12 11:30:04 -07001470 /*
1471 * If @work was previously on a different pool, it might still be
1472 * running there, in which case the work needs to be queued on that
1473 * pool to guarantee non-reentrancy.
1474 */
1475 last_pool = get_work_pool(work);
1476 if (last_pool && last_pool != pwq->pool) {
1477 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001478
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001479 raw_spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001480
Tejun Heoc9178082013-03-12 11:30:04 -07001481 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001482
Tejun Heoc9178082013-03-12 11:30:04 -07001483 if (worker && worker->current_pwq->wq == wq) {
1484 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001485 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001486 /* meh... not running there, queue here */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001487 raw_spin_unlock(&last_pool->lock);
1488 raw_spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001489 }
Tejun Heof3421792010-07-02 10:03:51 +02001490 } else {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001491 raw_spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001492 }
1493
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001494 /*
1495 * pwq is determined and locked. For unbound pools, we could have
1496 * raced with pwq release and it could already be dead. If its
1497 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001498 * without another pwq replacing it in the numa_pwq_tbl or while
1499 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001500 * make forward-progress.
1501 */
1502 if (unlikely(!pwq->refcnt)) {
1503 if (wq->flags & WQ_UNBOUND) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001504 raw_spin_unlock(&pwq->pool->lock);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001505 cpu_relax();
1506 goto retry;
1507 }
1508 /* oops */
1509 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1510 wq->name, cpu);
1511 }
1512
Tejun Heo112202d2013-02-13 19:29:12 -08001513 /* pwq determined, queue */
1514 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001515
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001516 if (WARN_ON(!list_empty(&work->entry)))
1517 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001518
Tejun Heo112202d2013-02-13 19:29:12 -08001519 pwq->nr_in_flight[pwq->work_color]++;
1520 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001521
Tejun Heo112202d2013-02-13 19:29:12 -08001522 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001523 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001524 pwq->nr_active++;
1525 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001526 if (list_empty(worklist))
1527 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001528 } else {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001529 work_flags |= WORK_STRUCT_INACTIVE;
1530 worklist = &pwq->inactive_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001531 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001532
Zqiang0687c662021-02-18 11:16:49 +08001533 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001534 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001535
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001536out:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001537 raw_spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001538 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539}
1540
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001541/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001542 * queue_work_on - queue work on specific cpu
1543 * @cpu: CPU number to execute work on
1544 * @wq: workqueue to use
1545 * @work: work to queue
1546 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001547 * We queue the work to a specific CPU, the caller must ensure it
Paul E. McKenney443378f2021-11-30 17:00:30 -08001548 * can't go away. Callers that fail to ensure that the specified
1549 * CPU cannot go away will execute on a randomly chosen CPU.
Yacine Belkadid185af32013-07-31 14:59:24 -07001550 *
1551 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001552 */
Tejun Heod4283e92012-08-03 10:30:44 -07001553bool queue_work_on(int cpu, struct workqueue_struct *wq,
1554 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001555{
Tejun Heod4283e92012-08-03 10:30:44 -07001556 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001557 unsigned long flags;
1558
1559 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001560
Tejun Heo22df02b2010-06-29 10:07:10 +02001561 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001562 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001563 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001564 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001565
1566 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001567 return ret;
1568}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001569EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001570
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001571/**
1572 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1573 * @node: NUMA node ID that we want to select a CPU from
1574 *
1575 * This function will attempt to find a "random" cpu available on a given
1576 * node. If there are no CPUs available on the given node it will return
1577 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1578 * available CPU if we need to schedule this work.
1579 */
1580static int workqueue_select_cpu_near(int node)
1581{
1582 int cpu;
1583
1584 /* No point in doing this if NUMA isn't enabled for workqueues */
1585 if (!wq_numa_enabled)
1586 return WORK_CPU_UNBOUND;
1587
1588 /* Delay binding to CPU if node is not valid or online */
1589 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1590 return WORK_CPU_UNBOUND;
1591
1592 /* Use local node/cpu if we are already there */
1593 cpu = raw_smp_processor_id();
1594 if (node == cpu_to_node(cpu))
1595 return cpu;
1596
1597 /* Use "random" otherwise know as "first" online CPU of node */
1598 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1599
1600 /* If CPU is valid return that, otherwise just defer */
1601 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1602}
1603
1604/**
1605 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1606 * @node: NUMA node that we are targeting the work for
1607 * @wq: workqueue to use
1608 * @work: work to queue
1609 *
1610 * We queue the work to a "random" CPU within a given NUMA node. The basic
1611 * idea here is to provide a way to somehow associate work with a given
1612 * NUMA node.
1613 *
1614 * This function will only make a best effort attempt at getting this onto
1615 * the right NUMA node. If no node is requested or the requested node is
1616 * offline then we just fall back to standard queue_work behavior.
1617 *
1618 * Currently the "random" CPU ends up being the first available CPU in the
1619 * intersection of cpu_online_mask and the cpumask of the node, unless we
1620 * are running on the node. In that case we just use the current CPU.
1621 *
1622 * Return: %false if @work was already on a queue, %true otherwise.
1623 */
1624bool queue_work_node(int node, struct workqueue_struct *wq,
1625 struct work_struct *work)
1626{
1627 unsigned long flags;
1628 bool ret = false;
1629
1630 /*
1631 * This current implementation is specific to unbound workqueues.
1632 * Specifically we only return the first available CPU for a given
1633 * node instead of cycling through individual CPUs within the node.
1634 *
1635 * If this is used with a per-cpu workqueue then the logic in
1636 * workqueue_select_cpu_near would need to be updated to allow for
1637 * some round robin type logic.
1638 */
1639 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1640
1641 local_irq_save(flags);
1642
1643 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1644 int cpu = workqueue_select_cpu_near(node);
1645
1646 __queue_work(cpu, wq, work);
1647 ret = true;
1648 }
1649
1650 local_irq_restore(flags);
1651 return ret;
1652}
1653EXPORT_SYMBOL_GPL(queue_work_node);
1654
Kees Cook8c20feb2017-10-04 16:27:07 -07001655void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656{
Kees Cook8c20feb2017-10-04 16:27:07 -07001657 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001659 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001660 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001662EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001664static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1665 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001667 struct timer_list *timer = &dwork->timer;
1668 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
Tejun Heo637fdba2017-03-06 15:33:42 -05001670 WARN_ON_ONCE(!wq);
Sami Tolvanen98173112021-04-08 11:28:30 -07001671 WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001672 WARN_ON_ONCE(timer_pending(timer));
1673 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001674
Tejun Heo8852aac2012-12-01 16:23:42 -08001675 /*
1676 * If @delay is 0, queue @dwork->work immediately. This is for
1677 * both optimization and correctness. The earliest @timer can
1678 * expire is on the closest next tick and delayed_work users depend
1679 * on that there's no such delay when @delay is 0.
1680 */
1681 if (!delay) {
1682 __queue_work(cpu, wq, &dwork->work);
1683 return;
1684 }
1685
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001686 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001687 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001688 timer->expires = jiffies + delay;
1689
Tejun Heo041bd122016-02-09 16:11:26 -05001690 if (unlikely(cpu != WORK_CPU_UNBOUND))
1691 add_timer_on(timer, cpu);
1692 else
1693 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694}
1695
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001696/**
1697 * queue_delayed_work_on - queue work on specific CPU after delay
1698 * @cpu: CPU number to execute work on
1699 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001700 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001701 * @delay: number of jiffies to wait before queueing
1702 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001703 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001704 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1705 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001706 */
Tejun Heod4283e92012-08-03 10:30:44 -07001707bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1708 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001709{
David Howells52bad642006-11-22 14:54:01 +00001710 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001711 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001712 unsigned long flags;
1713
1714 /* read the comment in __queue_work() */
1715 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001716
Tejun Heo22df02b2010-06-29 10:07:10 +02001717 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001718 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001719 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001720 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001721
1722 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001723 return ret;
1724}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001725EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
Tejun Heoc8e55f32010-06-29 10:07:12 +02001727/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001728 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1729 * @cpu: CPU number to execute work on
1730 * @wq: workqueue to use
1731 * @dwork: work to queue
1732 * @delay: number of jiffies to wait before queueing
1733 *
1734 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1735 * modify @dwork's timer so that it expires after @delay. If @delay is
1736 * zero, @work is guaranteed to be scheduled immediately regardless of its
1737 * current state.
1738 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001739 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001740 * pending and its timer was modified.
1741 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001742 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001743 * See try_to_grab_pending() for details.
1744 */
1745bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1746 struct delayed_work *dwork, unsigned long delay)
1747{
1748 unsigned long flags;
1749 int ret;
1750
1751 do {
1752 ret = try_to_grab_pending(&dwork->work, true, &flags);
1753 } while (unlikely(ret == -EAGAIN));
1754
1755 if (likely(ret >= 0)) {
1756 __queue_delayed_work(cpu, wq, dwork, delay);
1757 local_irq_restore(flags);
1758 }
1759
1760 /* -ENOENT from try_to_grab_pending() becomes %true */
1761 return ret;
1762}
1763EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1764
Tejun Heo05f0fe62018-03-14 12:45:13 -07001765static void rcu_work_rcufn(struct rcu_head *rcu)
1766{
1767 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1768
1769 /* read the comment in __queue_work() */
1770 local_irq_disable();
1771 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1772 local_irq_enable();
1773}
1774
1775/**
1776 * queue_rcu_work - queue work after a RCU grace period
1777 * @wq: workqueue to use
1778 * @rwork: work to queue
1779 *
1780 * Return: %false if @rwork was already pending, %true otherwise. Note
1781 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001782 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001783 * execution may happen before a full RCU grace period has passed.
1784 */
1785bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1786{
1787 struct work_struct *work = &rwork->work;
1788
1789 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1790 rwork->wq = wq;
1791 call_rcu(&rwork->rcu, rcu_work_rcufn);
1792 return true;
1793 }
1794
1795 return false;
1796}
1797EXPORT_SYMBOL(queue_rcu_work);
1798
Tejun Heo8376fe22012-08-03 10:30:47 -07001799/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001800 * worker_enter_idle - enter idle state
1801 * @worker: worker which is entering idle state
1802 *
1803 * @worker is entering idle state. Update stats and idle timer if
1804 * necessary.
1805 *
1806 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001807 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001808 */
1809static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001811 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812
Tejun Heo6183c002013-03-12 11:29:57 -07001813 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1814 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1815 (worker->hentry.next || worker->hentry.pprev)))
1816 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
Lai Jiangshan051e1852014-07-22 13:03:02 +08001818 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001819 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001820 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001821 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001822
Tejun Heoc8e55f32010-06-29 10:07:12 +02001823 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001824 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001825
Tejun Heo628c78e2012-07-17 12:39:27 -07001826 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1827 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001828
Lai Jiangshan989442d72021-12-07 15:35:41 +08001829 /* Sanity check nr_running. */
1830 WARN_ON_ONCE(pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001831 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832}
1833
Tejun Heoc8e55f32010-06-29 10:07:12 +02001834/**
1835 * worker_leave_idle - leave idle state
1836 * @worker: worker which is leaving idle state
1837 *
1838 * @worker is leaving idle state. Update stats.
1839 *
1840 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001841 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001842 */
1843static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001845 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
Tejun Heo6183c002013-03-12 11:29:57 -07001847 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1848 return;
Tejun Heod302f012010-06-29 10:07:13 +02001849 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001850 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001851 list_del_init(&worker->entry);
1852}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001854static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001855{
1856 struct worker *worker;
1857
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001858 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001859 if (worker) {
1860 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001861 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001862 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001863 /* on creation a worker is in !idle && prep state */
1864 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001865 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001866 return worker;
1867}
1868
1869/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001870 * worker_attach_to_pool() - attach a worker to a pool
1871 * @worker: worker to be attached
1872 * @pool: the target pool
1873 *
1874 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1875 * cpu-binding of @worker are kept coordinated with the pool across
1876 * cpu-[un]hotplugs.
1877 */
1878static void worker_attach_to_pool(struct worker *worker,
1879 struct worker_pool *pool)
1880{
Tejun Heo1258fae2018-05-18 08:47:13 -07001881 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001882
1883 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001884 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1885 * stable across this function. See the comments above the flag
1886 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001887 */
1888 if (pool->flags & POOL_DISASSOCIATED)
1889 worker->flags |= WORKER_UNBOUND;
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001890 else
1891 kthread_set_per_cpu(worker->task, pool->cpu);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001892
Peter Zijlstra640f17c2021-01-15 19:08:36 +01001893 if (worker->rescue_wq)
1894 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1895
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001896 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001897 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001898
Tejun Heo1258fae2018-05-18 08:47:13 -07001899 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001900}
1901
1902/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001903 * worker_detach_from_pool() - detach a worker from its pool
1904 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001905 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001906 * Undo the attaching which had been done in worker_attach_to_pool(). The
1907 * caller worker shouldn't access to the pool after detached except it has
1908 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001909 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001910static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001911{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001912 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001913 struct completion *detach_completion = NULL;
1914
Tejun Heo1258fae2018-05-18 08:47:13 -07001915 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001916
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001917 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshanda028462014-05-20 17:46:31 +08001918 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001919 worker->pool = NULL;
1920
Lai Jiangshanda028462014-05-20 17:46:31 +08001921 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001922 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001923 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001924
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001925 /* clear leftover flags without pool->lock after it is detached */
1926 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1927
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001928 if (detach_completion)
1929 complete(detach_completion);
1930}
1931
1932/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001933 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001935 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001936 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001937 *
1938 * CONTEXT:
1939 * Might sleep. Does GFP_KERNEL allocations.
1940 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001941 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001942 * Pointer to the newly created worker.
1943 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001944static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001945{
Zhen Leie441b562021-08-04 11:50:36 +08001946 struct worker *worker;
1947 int id;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001948 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001949
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001950 /* ID is needed to determine kthread name */
Zhen Leie441b562021-08-04 11:50:36 +08001951 id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001952 if (id < 0)
Zhen Leie441b562021-08-04 11:50:36 +08001953 return NULL;
Tejun Heoc34056a2010-06-29 10:07:11 +02001954
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001955 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001956 if (!worker)
1957 goto fail;
1958
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 worker->id = id;
1960
Tejun Heo29c91e92013-03-12 11:30:03 -07001961 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001962 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1963 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001964 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001965 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1966
Tejun Heof3f90ad2013-04-01 11:23:34 -07001967 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001968 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001969 if (IS_ERR(worker->task))
1970 goto fail;
1971
Oleg Nesterov91151222013-11-14 12:56:18 +01001972 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001973 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001974
Lai Jiangshanda028462014-05-20 17:46:31 +08001975 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001976 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001977
Lai Jiangshan051e1852014-07-22 13:03:02 +08001978 /* start the newly created worker */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001979 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001980 worker->pool->nr_workers++;
1981 worker_enter_idle(worker);
1982 wake_up_process(worker->task);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001983 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001984
Tejun Heoc34056a2010-06-29 10:07:11 +02001985 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001986
Tejun Heoc34056a2010-06-29 10:07:11 +02001987fail:
Zhen Leie441b562021-08-04 11:50:36 +08001988 ida_free(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001989 kfree(worker);
1990 return NULL;
1991}
1992
1993/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001994 * destroy_worker - destroy a workqueue worker
1995 * @worker: worker to be destroyed
1996 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001997 * Destroy @worker and adjust @pool stats accordingly. The worker should
1998 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001999 *
2000 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002001 * raw_spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02002002 */
2003static void destroy_worker(struct worker *worker)
2004{
Tejun Heobd7bdd42012-07-12 14:46:37 -07002005 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02002006
Tejun Heocd549682013-03-13 19:47:39 -07002007 lockdep_assert_held(&pool->lock);
2008
Tejun Heoc34056a2010-06-29 10:07:11 +02002009 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07002010 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08002011 WARN_ON(!list_empty(&worker->scheduled)) ||
2012 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07002013 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02002014
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08002015 pool->nr_workers--;
2016 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08002017
Tejun Heoc8e55f32010-06-29 10:07:12 +02002018 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02002019 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002020 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02002021}
2022
Kees Cook32a6c722017-10-16 15:58:25 -07002023static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002024{
Kees Cook32a6c722017-10-16 15:58:25 -07002025 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002026
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002027 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002028
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002029 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002030 struct worker *worker;
2031 unsigned long expires;
2032
2033 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07002034 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2036
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002037 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002038 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002039 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002040 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002041
2042 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002043 }
2044
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002045 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002046}
2047
Tejun Heo493a1722013-03-12 11:29:59 -07002048static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002049{
Tejun Heo112202d2013-02-13 19:29:12 -08002050 struct pool_workqueue *pwq = get_work_pwq(work);
2051 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002052
Tejun Heo2e109a22013-03-13 19:47:40 -07002053 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002054
Tejun Heo493008a2013-03-12 11:30:03 -07002055 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002056 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002057
2058 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002059 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002060 /*
2061 * If @pwq is for an unbound wq, its base ref may be put at
2062 * any time due to an attribute change. Pin @pwq until the
2063 * rescuer is done with it.
2064 */
2065 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002066 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002067 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002068 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002069}
2070
Kees Cook32a6c722017-10-16 15:58:25 -07002071static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002072{
Kees Cook32a6c722017-10-16 15:58:25 -07002073 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002074 struct work_struct *work;
2075
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002076 raw_spin_lock_irq(&pool->lock);
2077 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002078
Tejun Heo63d95a92012-07-12 14:46:37 -07002079 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002080 /*
2081 * We've been trying to create a new worker but
2082 * haven't been successful. We might be hitting an
2083 * allocation deadlock. Send distress signals to
2084 * rescuers.
2085 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002086 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002087 send_mayday(work);
2088 }
2089
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002090 raw_spin_unlock(&wq_mayday_lock);
2091 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002092
Tejun Heo63d95a92012-07-12 14:46:37 -07002093 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002094}
2095
2096/**
2097 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002098 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002099 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002100 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002101 * have at least one idle worker on return from this function. If
2102 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002103 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002104 * possible allocation deadlock.
2105 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002106 * On return, need_to_create_worker() is guaranteed to be %false and
2107 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002108 *
2109 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002110 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002111 * multiple times. Does GFP_KERNEL allocations. Called only from
2112 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002113 */
Tejun Heo29187a92015-01-16 14:21:16 -05002114static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002115__releases(&pool->lock)
2116__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002117{
Tejun Heoe22bee72010-06-29 10:07:14 +02002118restart:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002119 raw_spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002120
Tejun Heoe22bee72010-06-29 10:07:14 +02002121 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002122 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002123
2124 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002125 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002126 break;
2127
Lai Jiangshane212f362014-06-03 15:32:17 +08002128 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002129
Tejun Heo63d95a92012-07-12 14:46:37 -07002130 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002131 break;
2132 }
2133
Tejun Heo63d95a92012-07-12 14:46:37 -07002134 del_timer_sync(&pool->mayday_timer);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002135 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002136 /*
2137 * This is necessary even after a new worker was just successfully
2138 * created as @pool->lock was dropped and the new worker might have
2139 * already become busy.
2140 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002141 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002142 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002143}
2144
2145/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002146 * manage_workers - manage worker pool
2147 * @worker: self
2148 *
Tejun Heo706026c2013-01-24 11:01:34 -08002149 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002150 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002151 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002152 *
2153 * The caller can safely start processing works on false return. On
2154 * true return, it's guaranteed that need_to_create_worker() is false
2155 * and may_start_working() is true.
2156 *
2157 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002158 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002159 * multiple times. Does GFP_KERNEL allocations.
2160 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002161 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002162 * %false if the pool doesn't need management and the caller can safely
2163 * start processing works, %true if management function was performed and
2164 * the conditions that the caller verified before calling the function may
2165 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002166 */
2167static bool manage_workers(struct worker *worker)
2168{
Tejun Heo63d95a92012-07-12 14:46:37 -07002169 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002170
Tejun Heo692b4822017-10-09 08:04:13 -07002171 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002172 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002173
2174 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002175 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002176
Tejun Heo29187a92015-01-16 14:21:16 -05002177 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002178
Tejun Heo2607d7a2015-03-09 09:22:28 -04002179 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002180 pool->flags &= ~POOL_MANAGER_ACTIVE;
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02002181 rcuwait_wake_up(&manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002182 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002183}
2184
Tejun Heoa62428c2010-06-29 10:07:10 +02002185/**
2186 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002187 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002188 * @work: work to process
2189 *
2190 * Process @work. This function contains all the logics necessary to
2191 * process a single work including synchronization against and
2192 * interaction with other workers on the same cpu, queueing and
2193 * flushing. As long as context requirement is met, any worker can
2194 * call this function to process a work.
2195 *
2196 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002197 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002198 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002199static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002200__releases(&pool->lock)
2201__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002202{
Tejun Heo112202d2013-02-13 19:29:12 -08002203 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002204 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002205 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002206 unsigned long work_data;
Tejun Heo7e116292010-06-29 10:07:13 +02002207 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002208#ifdef CONFIG_LOCKDEP
2209 /*
2210 * It is permissible to free the struct work_struct from
2211 * inside the function that is called from it, this we need to
2212 * take into account for lockdep too. To avoid bogus "held
2213 * lock freed" warnings as well as problems when looking into
2214 * work->lockdep_map, make a copy and use that here.
2215 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002216 struct lockdep_map lockdep_map;
2217
2218 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002219#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002220 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002221 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002222 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002223
Tejun Heo7e116292010-06-29 10:07:13 +02002224 /*
2225 * A single work shouldn't be executed concurrently by
2226 * multiple workers on a single cpu. Check whether anyone is
2227 * already processing the work. If so, defer the work to the
2228 * currently executing one.
2229 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002230 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002231 if (unlikely(collision)) {
2232 move_linked_works(work, &collision->scheduled, NULL);
2233 return;
2234 }
2235
Tejun Heo8930cab2012-08-03 10:30:45 -07002236 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002237 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002238 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002239 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002240 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002241 worker->current_pwq = pwq;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002242 work_data = *work_data_bits(work);
Lai Jiangshand8127962021-08-17 09:32:38 +08002243 worker->current_color = get_work_color(work_data);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002244
Tejun Heo8bf89592018-05-18 08:47:13 -07002245 /*
2246 * Record wq name for cmdline and debug reporting, may get
2247 * overridden through set_worker_desc().
2248 */
2249 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2250
Tejun Heoa62428c2010-06-29 10:07:10 +02002251 list_del_init(&work->entry);
2252
Tejun Heo649027d2010-06-29 10:07:14 +02002253 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002254 * CPU intensive works don't participate in concurrency management.
2255 * They're the scheduler's responsibility. This takes @worker out
2256 * of concurrency management and the next code block will chain
2257 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002258 */
2259 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002260 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002261
Tejun Heo974271c2012-07-12 14:46:37 -07002262 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002263 * Wake up another worker if necessary. The condition is always
2264 * false for normal per-cpu workers since nr_running would always
2265 * be >= 1 at this point. This is used to chain execution of the
2266 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002267 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002268 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002269 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002270 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002271
Tejun Heo8930cab2012-08-03 10:30:45 -07002272 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002273 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002274 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002275 * PENDING and queued state changes happen together while IRQ is
2276 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002277 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002278 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002279
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002280 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002281
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002282 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002283 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002284 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002285 * Strictly speaking we should mark the invariant state without holding
2286 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002287 *
2288 * However, that would result in:
2289 *
2290 * A(W1)
2291 * WFC(C)
2292 * A(W1)
2293 * C(C)
2294 *
2295 * Which would create W1->C->W1 dependencies, even though there is no
2296 * actual deadlock possible. There are two solutions, using a
2297 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002298 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002299 * these locks.
2300 *
2301 * AFAICT there is no possible deadlock scenario between the
2302 * flush_work() and complete() primitives (except for single-threaded
2303 * workqueues), so hiding them isn't a problem.
2304 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002305 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002306 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002307 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002308 /*
2309 * While we must be careful to not use "work" after this, the trace
2310 * point will only record its address.
2311 */
Daniel Jordan1c5da0e2020-01-13 17:52:39 -05002312 trace_workqueue_execute_end(work, worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002313 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002314 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002315
2316 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002317 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002318 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002319 current->comm, preempt_count(), task_pid_nr(current),
2320 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002321 debug_show_held_locks(current);
2322 dump_stack();
2323 }
2324
Tejun Heob22ce272013-08-28 17:33:37 -04002325 /*
Sebastian Andrzej Siewior025f50f2019-10-15 21:18:21 +02002326 * The following prevents a kworker from hogging CPU on !PREEMPTION
Tejun Heob22ce272013-08-28 17:33:37 -04002327 * kernels, where a requeueing work item waiting for something to
2328 * happen could deadlock with stop_machine as such work item could
2329 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002330 * stop_machine. At the same time, report a quiescent RCU state so
2331 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002332 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002333 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002334
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002335 raw_spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002336
Tejun Heofb0e7be2010-06-29 10:07:15 +02002337 /* clear cpu intensive status */
2338 if (unlikely(cpu_intensive))
2339 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2340
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002341 /* tag the worker for identification in schedule() */
2342 worker->last_func = worker->current_func;
2343
Tejun Heoa62428c2010-06-29 10:07:10 +02002344 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002345 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002346 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002347 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002348 worker->current_pwq = NULL;
Lai Jiangshand8127962021-08-17 09:32:38 +08002349 worker->current_color = INT_MAX;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002350 pwq_dec_nr_in_flight(pwq, work_data);
Tejun Heoa62428c2010-06-29 10:07:10 +02002351}
2352
Tejun Heoaffee4b2010-06-29 10:07:12 +02002353/**
2354 * process_scheduled_works - process scheduled works
2355 * @worker: self
2356 *
2357 * Process all scheduled works. Please note that the scheduled list
2358 * may change while processing a work, so this function repeatedly
2359 * fetches a work from the top and executes it.
2360 *
2361 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002362 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002363 * multiple times.
2364 */
2365static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002367 while (!list_empty(&worker->scheduled)) {
2368 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002370 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372}
2373
Tejun Heo197f6ac2018-05-21 08:04:35 -07002374static void set_pf_worker(bool val)
2375{
2376 mutex_lock(&wq_pool_attach_mutex);
2377 if (val)
2378 current->flags |= PF_WQ_WORKER;
2379 else
2380 current->flags &= ~PF_WQ_WORKER;
2381 mutex_unlock(&wq_pool_attach_mutex);
2382}
2383
Tejun Heo4690c4a2010-06-29 10:07:10 +02002384/**
2385 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002386 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002387 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002388 * The worker thread function. All workers belong to a worker_pool -
2389 * either a per-cpu one or dynamic unbound one. These workers process all
2390 * work items regardless of their specific target workqueue. The only
2391 * exception is work items which belong to workqueues with a rescuer which
2392 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002393 *
2394 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002395 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002396static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397{
Tejun Heoc34056a2010-06-29 10:07:11 +02002398 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002399 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
Tejun Heoe22bee72010-06-29 10:07:14 +02002401 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002402 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002403woke_up:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002404 raw_spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002405
Tejun Heoa9ab7752013-03-19 13:45:21 -07002406 /* am I supposed to die? */
2407 if (unlikely(worker->flags & WORKER_DIE)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002408 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002409 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002410 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002411
2412 set_task_comm(worker->task, "kworker/dying");
Zhen Leie441b562021-08-04 11:50:36 +08002413 ida_free(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002414 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002415 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002416 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002418
Tejun Heoc8e55f32010-06-29 10:07:12 +02002419 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002420recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002421 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002422 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002423 goto sleep;
2424
2425 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002426 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002427 goto recheck;
2428
Tejun Heoc8e55f32010-06-29 10:07:12 +02002429 /*
2430 * ->scheduled list can only be filled while a worker is
2431 * preparing to process a work or actually processing it.
2432 * Make sure nobody diddled with it while I was sleeping.
2433 */
Tejun Heo6183c002013-03-12 11:29:57 -07002434 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002435
Tejun Heoe22bee72010-06-29 10:07:14 +02002436 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002437 * Finish PREP stage. We're guaranteed to have at least one idle
2438 * worker or that someone else has already assumed the manager
2439 * role. This is where @worker starts participating in concurrency
2440 * management if applicable and concurrency management is restored
2441 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002442 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002443 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002444
2445 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002446 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002447 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002448 struct work_struct, entry);
2449
Tejun Heo82607adc2015-12-08 11:28:04 -05002450 pool->watchdog_ts = jiffies;
2451
Tejun Heoc8e55f32010-06-29 10:07:12 +02002452 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2453 /* optimization path, not strictly necessary */
2454 process_one_work(worker, work);
2455 if (unlikely(!list_empty(&worker->scheduled)))
2456 process_scheduled_works(worker);
2457 } else {
2458 move_linked_works(work, &worker->scheduled, NULL);
2459 process_scheduled_works(worker);
2460 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002461 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002462
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002463 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002464sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002465 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002466 * pool->lock is held and there's no work to process and no need to
2467 * manage, sleep. Workers are woken up only while holding
2468 * pool->lock or from local cpu, so setting the current state
2469 * before releasing pool->lock is enough to prevent losing any
2470 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002471 */
2472 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002473 __set_current_state(TASK_IDLE);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002474 raw_spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002475 schedule();
2476 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477}
2478
Tejun Heoe22bee72010-06-29 10:07:14 +02002479/**
2480 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002481 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002482 *
2483 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002484 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002485 *
Tejun Heo706026c2013-01-24 11:01:34 -08002486 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002487 * worker which uses GFP_KERNEL allocation which has slight chance of
2488 * developing into deadlock if some works currently on the same queue
2489 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2490 * the problem rescuer solves.
2491 *
Tejun Heo706026c2013-01-24 11:01:34 -08002492 * When such condition is possible, the pool summons rescuers of all
2493 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002494 * those works so that forward progress can be guaranteed.
2495 *
2496 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002497 *
2498 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002499 */
Tejun Heo111c2252013-01-17 17:16:24 -08002500static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002501{
Tejun Heo111c2252013-01-17 17:16:24 -08002502 struct worker *rescuer = __rescuer;
2503 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002504 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002505 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002506
2507 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002508
2509 /*
2510 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2511 * doesn't participate in concurrency management.
2512 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002513 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002514repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002515 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002516
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002517 /*
2518 * By the time the rescuer is requested to stop, the workqueue
2519 * shouldn't have any work pending, but @wq->maydays may still have
2520 * pwq(s) queued. This can happen by non-rescuer workers consuming
2521 * all the work items before the rescuer got to them. Go through
2522 * @wq->maydays processing before acting on should_stop so that the
2523 * list is always empty on exit.
2524 */
2525 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002526
Tejun Heo493a1722013-03-12 11:29:59 -07002527 /* see whether any pwq is asking for help */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002528 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002529
2530 while (!list_empty(&wq->maydays)) {
2531 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2532 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002533 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002534 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002535 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002536
2537 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002538 list_del_init(&pwq->mayday_node);
2539
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002540 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002541
Lai Jiangshan51697d392014-05-20 17:46:36 +08002542 worker_attach_to_pool(rescuer, pool);
2543
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002544 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002545
2546 /*
2547 * Slurp in all works issued via this workqueue and
2548 * process'em.
2549 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002550 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002551 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2552 if (get_work_pwq(work) == pwq) {
2553 if (first)
2554 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002555 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002556 }
2557 first = false;
2558 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002559
NeilBrown008847f2014-12-08 12:39:16 -05002560 if (!list_empty(scheduled)) {
2561 process_scheduled_works(rescuer);
2562
2563 /*
2564 * The above execution of rescued work items could
2565 * have created more to rescue through
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08002566 * pwq_activate_first_inactive() or chained
NeilBrown008847f2014-12-08 12:39:16 -05002567 * queueing. Let's put @pwq back on mayday list so
2568 * that such back-to-back work items, which may be
2569 * being used to relieve memory pressure, don't
2570 * incur MAYDAY_INTERVAL delay inbetween.
2571 */
Lai Jiangshan4f3f4cf2020-05-29 06:58:59 +00002572 if (pwq->nr_active && need_to_create_worker(pool)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002573 raw_spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002574 /*
2575 * Queue iff we aren't racing destruction
2576 * and somebody else hasn't queued it already.
2577 */
2578 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2579 get_pwq(pwq);
2580 list_add_tail(&pwq->mayday_node, &wq->maydays);
2581 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002582 raw_spin_unlock(&wq_mayday_lock);
NeilBrown008847f2014-12-08 12:39:16 -05002583 }
2584 }
Tejun Heo75769582011-02-14 14:04:46 +01002585
2586 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002587 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002588 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002589 */
2590 put_pwq(pwq);
2591
2592 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002593 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002594 * regular worker; otherwise, we end up with 0 concurrency
2595 * and stalling the execution.
2596 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002597 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002598 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002599
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002600 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002601
Tejun Heoa2d812a2018-05-18 08:47:13 -07002602 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002603
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002604 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002605 }
2606
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002607 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002608
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002609 if (should_stop) {
2610 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002611 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002612 return 0;
2613 }
2614
Tejun Heo111c2252013-01-17 17:16:24 -08002615 /* rescuers should never participate in concurrency management */
2616 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002617 schedule();
2618 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619}
2620
Tejun Heofca839c2015-12-07 10:58:57 -05002621/**
2622 * check_flush_dependency - check for flush dependency sanity
2623 * @target_wq: workqueue being flushed
2624 * @target_work: work item being flushed (NULL for workqueue flushes)
2625 *
2626 * %current is trying to flush the whole @target_wq or @target_work on it.
2627 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2628 * reclaiming memory or running on a workqueue which doesn't have
2629 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2630 * a deadlock.
2631 */
2632static void check_flush_dependency(struct workqueue_struct *target_wq,
2633 struct work_struct *target_work)
2634{
2635 work_func_t target_func = target_work ? target_work->func : NULL;
2636 struct worker *worker;
2637
2638 if (target_wq->flags & WQ_MEM_RECLAIM)
2639 return;
2640
2641 worker = current_wq_worker();
2642
2643 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002644 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002645 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002646 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2647 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002648 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002649 worker->current_pwq->wq->name, worker->current_func,
2650 target_wq->name, target_func);
2651}
2652
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002653struct wq_barrier {
2654 struct work_struct work;
2655 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002656 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002657};
2658
2659static void wq_barrier_func(struct work_struct *work)
2660{
2661 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2662 complete(&barr->done);
2663}
2664
Tejun Heo4690c4a2010-06-29 10:07:10 +02002665/**
2666 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002667 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002668 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002669 * @target: target work to attach @barr to
2670 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002671 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002672 * @barr is linked to @target such that @barr is completed only after
2673 * @target finishes execution. Please note that the ordering
2674 * guarantee is observed only with respect to @target and on the local
2675 * cpu.
2676 *
2677 * Currently, a queued barrier can't be canceled. This is because
2678 * try_to_grab_pending() can't determine whether the work to be
2679 * grabbed is at the head of the queue and thus can't clear LINKED
2680 * flag of the previous work while there must be a valid next work
2681 * after a work with LINKED flag set.
2682 *
2683 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002684 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002685 *
2686 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002687 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002688 */
Tejun Heo112202d2013-02-13 19:29:12 -08002689static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002690 struct wq_barrier *barr,
2691 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002692{
Lai Jiangshand8127962021-08-17 09:32:38 +08002693 unsigned int work_flags = 0;
2694 unsigned int work_color;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002695 struct list_head *head;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002696
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002697 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002698 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002699 * as we know for sure that this will not trigger any of the
2700 * checks and call back into the fixup functions where we
2701 * might deadlock.
2702 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002703 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002704 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002705
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002706 init_completion_map(&barr->done, &target->lockdep_map);
2707
Tejun Heo2607d7a2015-03-09 09:22:28 -04002708 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002709
Lai Jiangshan018f3a12021-08-17 09:32:37 +08002710 /* The barrier work item does not participate in pwq->nr_active. */
2711 work_flags |= WORK_STRUCT_INACTIVE;
2712
Tejun Heoaffee4b2010-06-29 10:07:12 +02002713 /*
2714 * If @target is currently being executed, schedule the
2715 * barrier to the worker; otherwise, put it after @target.
2716 */
Lai Jiangshand8127962021-08-17 09:32:38 +08002717 if (worker) {
Tejun Heoaffee4b2010-06-29 10:07:12 +02002718 head = worker->scheduled.next;
Lai Jiangshand8127962021-08-17 09:32:38 +08002719 work_color = worker->current_color;
2720 } else {
Tejun Heoaffee4b2010-06-29 10:07:12 +02002721 unsigned long *bits = work_data_bits(target);
2722
2723 head = target->entry.next;
2724 /* there can already be other linked works, inherit and set */
Lai Jiangshand21cece2021-08-17 09:32:36 +08002725 work_flags |= *bits & WORK_STRUCT_LINKED;
Lai Jiangshand8127962021-08-17 09:32:38 +08002726 work_color = get_work_color(*bits);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002727 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2728 }
2729
Lai Jiangshand8127962021-08-17 09:32:38 +08002730 pwq->nr_in_flight[work_color]++;
2731 work_flags |= work_color_to_flags(work_color);
2732
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002733 debug_work_activate(&barr->work);
Lai Jiangshand21cece2021-08-17 09:32:36 +08002734 insert_work(pwq, &barr->work, head, work_flags);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002735}
2736
Tejun Heo73f53c42010-06-29 10:07:11 +02002737/**
Tejun Heo112202d2013-02-13 19:29:12 -08002738 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002739 * @wq: workqueue being flushed
2740 * @flush_color: new flush color, < 0 for no-op
2741 * @work_color: new work color, < 0 for no-op
2742 *
Tejun Heo112202d2013-02-13 19:29:12 -08002743 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002744 *
Tejun Heo112202d2013-02-13 19:29:12 -08002745 * If @flush_color is non-negative, flush_color on all pwqs should be
2746 * -1. If no pwq has in-flight commands at the specified color, all
2747 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2748 * has in flight commands, its pwq->flush_color is set to
2749 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002750 * wakeup logic is armed and %true is returned.
2751 *
2752 * The caller should have initialized @wq->first_flusher prior to
2753 * calling this function with non-negative @flush_color. If
2754 * @flush_color is negative, no flush color update is done and %false
2755 * is returned.
2756 *
Tejun Heo112202d2013-02-13 19:29:12 -08002757 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002758 * work_color which is previous to @work_color and all will be
2759 * advanced to @work_color.
2760 *
2761 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002762 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002763 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002764 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002765 * %true if @flush_color >= 0 and there's something to flush. %false
2766 * otherwise.
2767 */
Tejun Heo112202d2013-02-13 19:29:12 -08002768static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002769 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770{
Tejun Heo73f53c42010-06-29 10:07:11 +02002771 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002772 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002773
Tejun Heo73f53c42010-06-29 10:07:11 +02002774 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002775 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002776 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002777 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002778
Tejun Heo49e3cf42013-03-12 11:29:58 -07002779 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002780 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002781
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002782 raw_spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002783
2784 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002785 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002786
Tejun Heo112202d2013-02-13 19:29:12 -08002787 if (pwq->nr_in_flight[flush_color]) {
2788 pwq->flush_color = flush_color;
2789 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002790 wait = true;
2791 }
2792 }
2793
2794 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002795 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002796 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002797 }
2798
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002799 raw_spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002800 }
2801
Tejun Heo112202d2013-02-13 19:29:12 -08002802 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002803 complete(&wq->first_flusher->done);
2804
2805 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806}
2807
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002808/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002810 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002812 * This function sleeps until all work items which were queued on entry
2813 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002815void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816{
Tejun Heo73f53c42010-06-29 10:07:11 +02002817 struct wq_flusher this_flusher = {
2818 .list = LIST_HEAD_INIT(this_flusher.list),
2819 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002820 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002821 };
2822 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002823
Tejun Heo3347fa02016-09-16 15:49:32 -04002824 if (WARN_ON(!wq_online))
2825 return;
2826
Johannes Berg87915ad2018-08-22 11:49:04 +02002827 lock_map_acquire(&wq->lockdep_map);
2828 lock_map_release(&wq->lockdep_map);
2829
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002830 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002831
2832 /*
2833 * Start-to-wait phase
2834 */
2835 next_color = work_next_color(wq->work_color);
2836
2837 if (next_color != wq->flush_color) {
2838 /*
2839 * Color space is not full. The current work_color
2840 * becomes our flush_color and work_color is advanced
2841 * by one.
2842 */
Tejun Heo6183c002013-03-12 11:29:57 -07002843 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002844 this_flusher.flush_color = wq->work_color;
2845 wq->work_color = next_color;
2846
2847 if (!wq->first_flusher) {
2848 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002849 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002850
2851 wq->first_flusher = &this_flusher;
2852
Tejun Heo112202d2013-02-13 19:29:12 -08002853 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002854 wq->work_color)) {
2855 /* nothing to flush, done */
2856 wq->flush_color = next_color;
2857 wq->first_flusher = NULL;
2858 goto out_unlock;
2859 }
2860 } else {
2861 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002862 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002863 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002864 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002865 }
2866 } else {
2867 /*
2868 * Oops, color space is full, wait on overflow queue.
2869 * The next flush completion will assign us
2870 * flush_color and transfer to flusher_queue.
2871 */
2872 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2873 }
2874
Tejun Heofca839c2015-12-07 10:58:57 -05002875 check_flush_dependency(wq, NULL);
2876
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002877 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002878
2879 wait_for_completion(&this_flusher.done);
2880
2881 /*
2882 * Wake-up-and-cascade phase
2883 *
2884 * First flushers are responsible for cascading flushes and
2885 * handling overflow. Non-first flushers can simply return.
2886 */
Chris Wilson00d5d152020-03-10 16:23:19 +00002887 if (READ_ONCE(wq->first_flusher) != &this_flusher)
Tejun Heo73f53c42010-06-29 10:07:11 +02002888 return;
2889
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002890 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002891
Tejun Heo4ce48b32010-07-02 10:03:51 +02002892 /* we might have raced, check again with mutex held */
2893 if (wq->first_flusher != &this_flusher)
2894 goto out_unlock;
2895
Chris Wilson00d5d152020-03-10 16:23:19 +00002896 WRITE_ONCE(wq->first_flusher, NULL);
Tejun Heo73f53c42010-06-29 10:07:11 +02002897
Tejun Heo6183c002013-03-12 11:29:57 -07002898 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2899 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002900
2901 while (true) {
2902 struct wq_flusher *next, *tmp;
2903
2904 /* complete all the flushers sharing the current flush color */
2905 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2906 if (next->flush_color != wq->flush_color)
2907 break;
2908 list_del_init(&next->list);
2909 complete(&next->done);
2910 }
2911
Tejun Heo6183c002013-03-12 11:29:57 -07002912 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2913 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002914
2915 /* this flush_color is finished, advance by one */
2916 wq->flush_color = work_next_color(wq->flush_color);
2917
2918 /* one color has been freed, handle overflow queue */
2919 if (!list_empty(&wq->flusher_overflow)) {
2920 /*
2921 * Assign the same color to all overflowed
2922 * flushers, advance work_color and append to
2923 * flusher_queue. This is the start-to-wait
2924 * phase for these overflowed flushers.
2925 */
2926 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2927 tmp->flush_color = wq->work_color;
2928
2929 wq->work_color = work_next_color(wq->work_color);
2930
2931 list_splice_tail_init(&wq->flusher_overflow,
2932 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002933 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002934 }
2935
2936 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002937 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002938 break;
2939 }
2940
2941 /*
2942 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002943 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002944 */
Tejun Heo6183c002013-03-12 11:29:57 -07002945 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2946 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002947
2948 list_del_init(&next->list);
2949 wq->first_flusher = next;
2950
Tejun Heo112202d2013-02-13 19:29:12 -08002951 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002952 break;
2953
2954 /*
2955 * Meh... this color is already done, clear first
2956 * flusher and repeat cascading.
2957 */
2958 wq->first_flusher = NULL;
2959 }
2960
2961out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002962 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002964EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002965
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002966/**
2967 * drain_workqueue - drain a workqueue
2968 * @wq: workqueue to drain
2969 *
2970 * Wait until the workqueue becomes empty. While draining is in progress,
2971 * only chain queueing is allowed. IOW, only currently pending or running
2972 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002973 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002974 * by the depth of chaining and should be relatively short. Whine if it
2975 * takes too long.
2976 */
2977void drain_workqueue(struct workqueue_struct *wq)
2978{
2979 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002980 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002981
2982 /*
2983 * __queue_work() needs to test whether there are drainers, is much
2984 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002985 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002986 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002987 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002988 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002989 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002990 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002991reflush:
2992 flush_workqueue(wq);
2993
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002994 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002995
Tejun Heo49e3cf42013-03-12 11:29:58 -07002996 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002997 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002998
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002999 raw_spin_lock_irq(&pwq->pool->lock);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003000 drained = !pwq->nr_active && list_empty(&pwq->inactive_works);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003001 raw_spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07003002
3003 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003004 continue;
3005
3006 if (++flush_cnt == 10 ||
3007 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Stephen Zhange9ad2eb2021-01-23 16:04:00 +08003008 pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3009 wq->name, __func__, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07003010
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003011 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003012 goto reflush;
3013 }
3014
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003015 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07003016 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07003017 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003018}
3019EXPORT_SYMBOL_GPL(drain_workqueue);
3020
Johannes Bergd6e89782018-08-22 11:49:03 +02003021static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3022 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02003023{
3024 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003025 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08003026 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02003027
3028 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02003029
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003030 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07003031 pool = get_work_pool(work);
3032 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003033 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07003034 return false;
3035 }
3036
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003037 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08003038 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08003039 pwq = get_work_pwq(work);
3040 if (pwq) {
3041 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02003042 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07003043 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003044 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003045 if (!worker)
3046 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003047 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003048 }
Tejun Heobaf59022010-09-16 10:42:16 +02003049
Tejun Heofca839c2015-12-07 10:58:57 -05003050 check_flush_dependency(pwq->wq, work);
3051
Tejun Heo112202d2013-02-13 19:29:12 -08003052 insert_wq_barrier(pwq, barr, work, worker);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003053 raw_spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003054
Tejun Heoe159489b2011-01-09 23:32:15 +01003055 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003056 * Force a lock recursion deadlock when using flush_work() inside a
3057 * single-threaded or rescuer equipped workqueue.
3058 *
3059 * For single threaded workqueues the deadlock happens when the work
3060 * is after the work issuing the flush_work(). For rescuer equipped
3061 * workqueues the deadlock happens when the rescuer stalls, blocking
3062 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003063 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003064 if (!from_cancel &&
3065 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003066 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003067 lock_map_release(&pwq->wq->lockdep_map);
3068 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003069 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003070 return true;
3071already_gone:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003072 raw_spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003073 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003074 return false;
3075}
3076
Johannes Bergd6e89782018-08-22 11:49:03 +02003077static bool __flush_work(struct work_struct *work, bool from_cancel)
3078{
3079 struct wq_barrier barr;
3080
3081 if (WARN_ON(!wq_online))
3082 return false;
3083
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003084 if (WARN_ON(!work->func))
3085 return false;
3086
Johannes Berg87915ad2018-08-22 11:49:04 +02003087 if (!from_cancel) {
3088 lock_map_acquire(&work->lockdep_map);
3089 lock_map_release(&work->lockdep_map);
3090 }
3091
Johannes Bergd6e89782018-08-22 11:49:03 +02003092 if (start_flush_work(work, &barr, from_cancel)) {
3093 wait_for_completion(&barr.done);
3094 destroy_work_on_stack(&barr.work);
3095 return true;
3096 } else {
3097 return false;
3098 }
3099}
3100
Oleg Nesterovdb700892008-07-25 01:47:49 -07003101/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003102 * flush_work - wait for a work to finish executing the last queueing instance
3103 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003104 *
Tejun Heo606a5022012-08-20 14:51:23 -07003105 * Wait until @work has finished execution. @work is guaranteed to be idle
3106 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003107 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003108 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003109 * %true if flush_work() waited for the work to finish execution,
3110 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003111 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003112bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003113{
Johannes Bergd6e89782018-08-22 11:49:03 +02003114 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003115}
3116EXPORT_SYMBOL_GPL(flush_work);
3117
Tejun Heo8603e1b32015-03-05 08:04:13 -05003118struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003119 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003120 struct work_struct *work;
3121};
3122
Ingo Molnarac6424b2017-06-20 12:06:13 +02003123static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003124{
3125 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3126
3127 if (cwait->work != key)
3128 return 0;
3129 return autoremove_wake_function(wait, mode, sync, key);
3130}
3131
Tejun Heo36e227d2012-08-03 10:30:46 -07003132static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003133{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003134 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003135 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003136 int ret;
3137
3138 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003139 ret = try_to_grab_pending(work, is_dwork, &flags);
3140 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003141 * If someone else is already canceling, wait for it to
3142 * finish. flush_work() doesn't work for PREEMPT_NONE
3143 * because we may get scheduled between @work's completion
3144 * and the other canceling task resuming and clearing
3145 * CANCELING - flush_work() will return false immediately
3146 * as @work is no longer busy, try_to_grab_pending() will
3147 * return -ENOENT as @work is still being canceled and the
3148 * other canceling task won't be able to clear CANCELING as
3149 * we're hogging the CPU.
3150 *
3151 * Let's wait for completion using a waitqueue. As this
3152 * may lead to the thundering herd problem, use a custom
3153 * wake function which matches @work along with exclusive
3154 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003155 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003156 if (unlikely(ret == -ENOENT)) {
3157 struct cwt_wait cwait;
3158
3159 init_wait(&cwait.wait);
3160 cwait.wait.func = cwt_wakefn;
3161 cwait.work = work;
3162
3163 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3164 TASK_UNINTERRUPTIBLE);
3165 if (work_is_canceling(work))
3166 schedule();
3167 finish_wait(&cancel_waitq, &cwait.wait);
3168 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003169 } while (unlikely(ret < 0));
3170
Tejun Heobbb68df2012-08-03 10:30:46 -07003171 /* tell other tasks trying to grab @work to back off */
3172 mark_work_canceling(work);
3173 local_irq_restore(flags);
3174
Tejun Heo3347fa02016-09-16 15:49:32 -04003175 /*
3176 * This allows canceling during early boot. We know that @work
3177 * isn't executing.
3178 */
3179 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003180 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003181
Tejun Heo7a22ad72010-06-29 10:07:13 +02003182 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003183
3184 /*
3185 * Paired with prepare_to_wait() above so that either
3186 * waitqueue_active() is visible here or !work_is_canceling() is
3187 * visible there.
3188 */
3189 smp_mb();
3190 if (waitqueue_active(&cancel_waitq))
3191 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3192
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003193 return ret;
3194}
3195
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003196/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003197 * cancel_work_sync - cancel a work and wait for it to finish
3198 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003199 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003200 * Cancel @work and wait for its execution to finish. This function
3201 * can be used even if the work re-queues itself or migrates to
3202 * another workqueue. On return from this function, @work is
3203 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003204 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003205 * cancel_work_sync(&delayed_work->work) must not be used for
3206 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003207 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003208 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003209 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003210 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003211 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003212 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003213 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003214bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003215{
Tejun Heo36e227d2012-08-03 10:30:46 -07003216 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003217}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003218EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003219
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003220/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003221 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3222 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003223 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003224 * Delayed timer is cancelled and the pending work is queued for
3225 * immediate execution. Like flush_work(), this function only
3226 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003227 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003228 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003229 * %true if flush_work() waited for the work to finish execution,
3230 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003231 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003232bool flush_delayed_work(struct delayed_work *dwork)
3233{
Tejun Heo8930cab2012-08-03 10:30:45 -07003234 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003235 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003236 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003237 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003238 return flush_work(&dwork->work);
3239}
3240EXPORT_SYMBOL(flush_delayed_work);
3241
Tejun Heo05f0fe62018-03-14 12:45:13 -07003242/**
3243 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3244 * @rwork: the rcu work to flush
3245 *
3246 * Return:
3247 * %true if flush_rcu_work() waited for the work to finish execution,
3248 * %false if it was already idle.
3249 */
3250bool flush_rcu_work(struct rcu_work *rwork)
3251{
3252 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3253 rcu_barrier();
3254 flush_work(&rwork->work);
3255 return true;
3256 } else {
3257 return flush_work(&rwork->work);
3258 }
3259}
3260EXPORT_SYMBOL(flush_rcu_work);
3261
Jens Axboef72b8792016-08-24 15:51:50 -06003262static bool __cancel_work(struct work_struct *work, bool is_dwork)
3263{
3264 unsigned long flags;
3265 int ret;
3266
3267 do {
3268 ret = try_to_grab_pending(work, is_dwork, &flags);
3269 } while (unlikely(ret == -EAGAIN));
3270
3271 if (unlikely(ret < 0))
3272 return false;
3273
3274 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3275 local_irq_restore(flags);
3276 return ret;
3277}
3278
Tejun Heo401a8d02010-09-16 10:36:00 +02003279/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003280 * cancel_delayed_work - cancel a delayed work
3281 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003282 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003283 * Kill off a pending delayed_work.
3284 *
3285 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3286 * pending.
3287 *
3288 * Note:
3289 * The work callback function may still be running on return, unless
3290 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3291 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003292 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003293 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003294 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003295bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003296{
Jens Axboef72b8792016-08-24 15:51:50 -06003297 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003298}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003299EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003300
3301/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003302 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3303 * @dwork: the delayed work cancel
3304 *
3305 * This is cancel_work_sync() for delayed works.
3306 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003307 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003308 * %true if @dwork was pending, %false otherwise.
3309 */
3310bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003311{
Tejun Heo36e227d2012-08-03 10:30:46 -07003312 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003313}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003314EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003316/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003317 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003318 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003319 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003320 * schedule_on_each_cpu() executes @func on each online CPU using the
3321 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003322 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003323 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003324 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003325 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003326 */
David Howells65f27f32006-11-22 14:55:48 +00003327int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003328{
3329 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003330 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003331
Andrew Mortonb6136772006-06-25 05:47:49 -07003332 works = alloc_percpu(struct work_struct);
3333 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003334 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003335
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02003336 cpus_read_lock();
Tejun Heo93981802009-11-17 14:06:20 -08003337
Christoph Lameter15316ba2006-01-08 01:00:43 -08003338 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003339 struct work_struct *work = per_cpu_ptr(works, cpu);
3340
3341 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003342 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003343 }
Tejun Heo93981802009-11-17 14:06:20 -08003344
3345 for_each_online_cpu(cpu)
3346 flush_work(per_cpu_ptr(works, cpu));
3347
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02003348 cpus_read_unlock();
Andrew Mortonb6136772006-06-25 05:47:49 -07003349 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003350 return 0;
3351}
3352
Alan Sterneef6a7d2010-02-12 17:39:21 +09003353/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003354 * execute_in_process_context - reliably execute the routine with user context
3355 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003356 * @ew: guaranteed storage for the execute work structure (must
3357 * be available when the work executes)
3358 *
3359 * Executes the function immediately if process context is available,
3360 * otherwise schedules the function for delayed execution.
3361 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003362 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003363 * 1 - function was scheduled for execution
3364 */
David Howells65f27f32006-11-22 14:55:48 +00003365int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003366{
3367 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003368 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003369 return 0;
3370 }
3371
David Howells65f27f32006-11-22 14:55:48 +00003372 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003373 schedule_work(&ew->work);
3374
3375 return 1;
3376}
3377EXPORT_SYMBOL_GPL(execute_in_process_context);
3378
Tejun Heo7a4e3442013-03-12 11:30:00 -07003379/**
3380 * free_workqueue_attrs - free a workqueue_attrs
3381 * @attrs: workqueue_attrs to free
3382 *
3383 * Undo alloc_workqueue_attrs().
3384 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003385void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003386{
3387 if (attrs) {
3388 free_cpumask_var(attrs->cpumask);
3389 kfree(attrs);
3390 }
3391}
3392
3393/**
3394 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003395 *
3396 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003397 * return it.
3398 *
3399 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003400 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003401struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003402{
3403 struct workqueue_attrs *attrs;
3404
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003405 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003406 if (!attrs)
3407 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003408 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003409 goto fail;
3410
Tejun Heo13e2e552013-04-01 11:23:31 -07003411 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003412 return attrs;
3413fail:
3414 free_workqueue_attrs(attrs);
3415 return NULL;
3416}
3417
Tejun Heo29c91e92013-03-12 11:30:03 -07003418static void copy_workqueue_attrs(struct workqueue_attrs *to,
3419 const struct workqueue_attrs *from)
3420{
3421 to->nice = from->nice;
3422 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003423 /*
3424 * Unlike hash and equality test, this function doesn't ignore
3425 * ->no_numa as it is used for both pool and wq attrs. Instead,
3426 * get_unbound_pool() explicitly clears ->no_numa after copying.
3427 */
3428 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003429}
3430
Tejun Heo29c91e92013-03-12 11:30:03 -07003431/* hash value of the content of @attr */
3432static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3433{
3434 u32 hash = 0;
3435
3436 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003437 hash = jhash(cpumask_bits(attrs->cpumask),
3438 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003439 return hash;
3440}
3441
3442/* content equality test */
3443static bool wqattrs_equal(const struct workqueue_attrs *a,
3444 const struct workqueue_attrs *b)
3445{
3446 if (a->nice != b->nice)
3447 return false;
3448 if (!cpumask_equal(a->cpumask, b->cpumask))
3449 return false;
3450 return true;
3451}
3452
Tejun Heo7a4e3442013-03-12 11:30:00 -07003453/**
3454 * init_worker_pool - initialize a newly zalloc'd worker_pool
3455 * @pool: worker_pool to initialize
3456 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303457 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003458 *
3459 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003460 * inside @pool proper are initialized and put_unbound_pool() can be called
3461 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003462 */
3463static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003464{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003465 raw_spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003466 pool->id = -1;
3467 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003468 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003469 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003470 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003471 INIT_LIST_HEAD(&pool->worklist);
3472 INIT_LIST_HEAD(&pool->idle_list);
3473 hash_init(pool->busy_hash);
3474
Kees Cook32a6c722017-10-16 15:58:25 -07003475 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003476
Kees Cook32a6c722017-10-16 15:58:25 -07003477 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003478
Lai Jiangshanda028462014-05-20 17:46:31 +08003479 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003480
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003481 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003482 INIT_HLIST_NODE(&pool->hash_node);
3483 pool->refcnt = 1;
3484
3485 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003486 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003487 if (!pool->attrs)
3488 return -ENOMEM;
3489 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003490}
3491
Bart Van Assche669de8b2019-02-14 15:00:54 -08003492#ifdef CONFIG_LOCKDEP
3493static void wq_init_lockdep(struct workqueue_struct *wq)
3494{
3495 char *lock_name;
3496
3497 lockdep_register_key(&wq->key);
3498 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3499 if (!lock_name)
3500 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003501
3502 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003503 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3504}
3505
3506static void wq_unregister_lockdep(struct workqueue_struct *wq)
3507{
3508 lockdep_unregister_key(&wq->key);
3509}
3510
3511static void wq_free_lockdep(struct workqueue_struct *wq)
3512{
3513 if (wq->lock_name != wq->name)
3514 kfree(wq->lock_name);
3515}
3516#else
3517static void wq_init_lockdep(struct workqueue_struct *wq)
3518{
3519}
3520
3521static void wq_unregister_lockdep(struct workqueue_struct *wq)
3522{
3523}
3524
3525static void wq_free_lockdep(struct workqueue_struct *wq)
3526{
3527}
3528#endif
3529
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003530static void rcu_free_wq(struct rcu_head *rcu)
3531{
3532 struct workqueue_struct *wq =
3533 container_of(rcu, struct workqueue_struct, rcu);
3534
Bart Van Assche669de8b2019-02-14 15:00:54 -08003535 wq_free_lockdep(wq);
3536
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003537 if (!(wq->flags & WQ_UNBOUND))
3538 free_percpu(wq->cpu_pwqs);
3539 else
3540 free_workqueue_attrs(wq->unbound_attrs);
3541
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003542 kfree(wq);
3543}
3544
Tejun Heo29c91e92013-03-12 11:30:03 -07003545static void rcu_free_pool(struct rcu_head *rcu)
3546{
3547 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3548
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003549 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003550 free_workqueue_attrs(pool->attrs);
3551 kfree(pool);
3552}
3553
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003554/* This returns with the lock held on success (pool manager is inactive). */
3555static bool wq_manager_inactive(struct worker_pool *pool)
3556{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003557 raw_spin_lock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003558
3559 if (pool->flags & POOL_MANAGER_ACTIVE) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003560 raw_spin_unlock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003561 return false;
3562 }
3563 return true;
3564}
3565
Tejun Heo29c91e92013-03-12 11:30:03 -07003566/**
3567 * put_unbound_pool - put a worker_pool
3568 * @pool: worker_pool to put
3569 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003570 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003571 * safe manner. get_unbound_pool() calls this function on its failure path
3572 * and this function should be able to release pools which went through,
3573 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003574 *
3575 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003576 */
3577static void put_unbound_pool(struct worker_pool *pool)
3578{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003579 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003580 struct worker *worker;
3581
Tejun Heoa892cac2013-04-01 11:23:32 -07003582 lockdep_assert_held(&wq_pool_mutex);
3583
3584 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003585 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003586
3587 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003588 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003589 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003590 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003591
3592 /* release id and unhash */
3593 if (pool->id >= 0)
3594 idr_remove(&worker_pool_idr, pool->id);
3595 hash_del(&pool->hash_node);
3596
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003597 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003598 * Become the manager and destroy all workers. This prevents
3599 * @pool's workers from blocking on attach_mutex. We're the last
3600 * manager and @pool gets freed with the flag set.
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003601 * Because of how wq_manager_inactive() works, we will hold the
3602 * spinlock after a successful wait.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003603 */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003604 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3605 TASK_UNINTERRUPTIBLE);
Tejun Heo692b4822017-10-09 08:04:13 -07003606 pool->flags |= POOL_MANAGER_ACTIVE;
3607
Lai Jiangshan1037de32014-05-22 16:44:07 +08003608 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003609 destroy_worker(worker);
3610 WARN_ON(pool->nr_workers || pool->nr_idle);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003611 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003612
Tejun Heo1258fae2018-05-18 08:47:13 -07003613 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003614 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003615 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003616 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003617
3618 if (pool->detach_completion)
3619 wait_for_completion(pool->detach_completion);
3620
Tejun Heo29c91e92013-03-12 11:30:03 -07003621 /* shut down the timers */
3622 del_timer_sync(&pool->idle_timer);
3623 del_timer_sync(&pool->mayday_timer);
3624
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003625 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003626 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003627}
3628
3629/**
3630 * get_unbound_pool - get a worker_pool with the specified attributes
3631 * @attrs: the attributes of the worker_pool to get
3632 *
3633 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3634 * reference count and return it. If there already is a matching
3635 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003636 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003637 *
3638 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003639 *
3640 * Return: On success, a worker_pool with the same attributes as @attrs.
3641 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003642 */
3643static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3644{
Tejun Heo29c91e92013-03-12 11:30:03 -07003645 u32 hash = wqattrs_hash(attrs);
3646 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003647 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003648 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003649
Tejun Heoa892cac2013-04-01 11:23:32 -07003650 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003651
3652 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003653 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3654 if (wqattrs_equal(pool->attrs, attrs)) {
3655 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003656 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003657 }
3658 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003659
Xunlei Pange22735842015-10-09 11:53:12 +08003660 /* if cpumask is contained inside a NUMA node, we belong to that node */
3661 if (wq_numa_enabled) {
3662 for_each_node(node) {
3663 if (cpumask_subset(attrs->cpumask,
3664 wq_numa_possible_cpumask[node])) {
3665 target_node = node;
3666 break;
3667 }
3668 }
3669 }
3670
Tejun Heo29c91e92013-03-12 11:30:03 -07003671 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003672 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003673 if (!pool || init_worker_pool(pool) < 0)
3674 goto fail;
3675
Tejun Heo8864b4e2013-03-12 11:30:04 -07003676 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003677 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003678 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003679
Shaohua Li2865a8f2013-08-01 09:56:36 +08003680 /*
3681 * no_numa isn't a worker_pool attribute, always clear it. See
3682 * 'struct workqueue_attrs' comments for detail.
3683 */
3684 pool->attrs->no_numa = false;
3685
Tejun Heo29c91e92013-03-12 11:30:03 -07003686 if (worker_pool_assign_id(pool) < 0)
3687 goto fail;
3688
3689 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003690 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003691 goto fail;
3692
Tejun Heo29c91e92013-03-12 11:30:03 -07003693 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003694 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003695
Tejun Heo29c91e92013-03-12 11:30:03 -07003696 return pool;
3697fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003698 if (pool)
3699 put_unbound_pool(pool);
3700 return NULL;
3701}
3702
Tejun Heo8864b4e2013-03-12 11:30:04 -07003703static void rcu_free_pwq(struct rcu_head *rcu)
3704{
3705 kmem_cache_free(pwq_cache,
3706 container_of(rcu, struct pool_workqueue, rcu));
3707}
3708
3709/*
3710 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3711 * and needs to be destroyed.
3712 */
3713static void pwq_unbound_release_workfn(struct work_struct *work)
3714{
3715 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3716 unbound_release_work);
3717 struct workqueue_struct *wq = pwq->wq;
3718 struct worker_pool *pool = pwq->pool;
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003719 bool is_last = false;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003720
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003721 /*
3722 * when @pwq is not linked, it doesn't hold any reference to the
3723 * @wq, and @wq is invalid to access.
3724 */
3725 if (!list_empty(&pwq->pwqs_node)) {
3726 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3727 return;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003728
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003729 mutex_lock(&wq->mutex);
3730 list_del_rcu(&pwq->pwqs_node);
3731 is_last = list_empty(&wq->pwqs);
3732 mutex_unlock(&wq->mutex);
3733 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003734
Tejun Heoa892cac2013-04-01 11:23:32 -07003735 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003736 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003737 mutex_unlock(&wq_pool_mutex);
3738
Paul E. McKenney25b00772018-11-06 19:18:45 -08003739 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003740
3741 /*
3742 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003743 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003744 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003745 if (is_last) {
3746 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003747 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003748 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003749}
3750
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003751/**
Tejun Heo699ce092013-03-13 16:51:35 -07003752 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003753 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003754 *
Tejun Heo699ce092013-03-13 16:51:35 -07003755 * If @pwq isn't freezing, set @pwq->max_active to the associated
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003756 * workqueue's saved_max_active and activate inactive work items
Tejun Heo699ce092013-03-13 16:51:35 -07003757 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003758 */
Tejun Heo699ce092013-03-13 16:51:35 -07003759static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003760{
Tejun Heo699ce092013-03-13 16:51:35 -07003761 struct workqueue_struct *wq = pwq->wq;
3762 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003763 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003764
Tejun Heo699ce092013-03-13 16:51:35 -07003765 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003766 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003767
3768 /* fast exit for non-freezable wqs */
3769 if (!freezable && pwq->max_active == wq->saved_max_active)
3770 return;
3771
Tejun Heo3347fa02016-09-16 15:49:32 -04003772 /* this function can be called during early boot w/ irq disabled */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003773 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003774
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003775 /*
3776 * During [un]freezing, the caller is responsible for ensuring that
3777 * this function is called at least once after @workqueue_freezing
3778 * is updated and visible.
3779 */
3780 if (!freezable || !workqueue_freezing) {
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003781 bool kick = false;
3782
Tejun Heo699ce092013-03-13 16:51:35 -07003783 pwq->max_active = wq->saved_max_active;
3784
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003785 while (!list_empty(&pwq->inactive_works) &&
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003786 pwq->nr_active < pwq->max_active) {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003787 pwq_activate_first_inactive(pwq);
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003788 kick = true;
3789 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003790
3791 /*
3792 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003793 * max_active is bumped. In realtime scenarios, always kicking a
3794 * worker will cause interference on the isolated cpu cores, so
3795 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003796 */
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003797 if (kick)
3798 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003799 } else {
3800 pwq->max_active = 0;
3801 }
3802
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003803 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003804}
3805
Cai Huoqing67dc8322021-07-31 08:01:29 +08003806/* initialize newly allocated @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003807static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3808 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003809{
3810 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3811
Tejun Heoe50aba92013-04-01 11:23:35 -07003812 memset(pwq, 0, sizeof(*pwq));
3813
Tejun Heod2c1d402013-03-12 11:30:04 -07003814 pwq->pool = pool;
3815 pwq->wq = wq;
3816 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003817 pwq->refcnt = 1;
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003818 INIT_LIST_HEAD(&pwq->inactive_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003819 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003820 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003821 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003822}
Tejun Heod2c1d402013-03-12 11:30:04 -07003823
Tejun Heof147f292013-04-01 11:23:35 -07003824/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003825static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003826{
3827 struct workqueue_struct *wq = pwq->wq;
3828
3829 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003830
Tejun Heo1befcf32013-04-01 11:23:35 -07003831 /* may be called multiple times, ignore if already linked */
3832 if (!list_empty(&pwq->pwqs_node))
3833 return;
3834
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003835 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003836 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003837
3838 /* sync max_active to the current setting */
3839 pwq_adjust_max_active(pwq);
3840
3841 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003842 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003843}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003844
Tejun Heof147f292013-04-01 11:23:35 -07003845/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3846static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3847 const struct workqueue_attrs *attrs)
3848{
3849 struct worker_pool *pool;
3850 struct pool_workqueue *pwq;
3851
3852 lockdep_assert_held(&wq_pool_mutex);
3853
3854 pool = get_unbound_pool(attrs);
3855 if (!pool)
3856 return NULL;
3857
Tejun Heoe50aba92013-04-01 11:23:35 -07003858 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003859 if (!pwq) {
3860 put_unbound_pool(pool);
3861 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003862 }
Tejun Heo6029a912013-04-01 11:23:34 -07003863
Tejun Heof147f292013-04-01 11:23:35 -07003864 init_pwq(pwq, wq, pool);
3865 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003866}
3867
Tejun Heo4c16bd32013-04-01 11:23:36 -07003868/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003869 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003870 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003871 * @node: the target NUMA node
3872 * @cpu_going_down: if >= 0, the CPU to consider as offline
3873 * @cpumask: outarg, the resulting cpumask
3874 *
3875 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3876 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003877 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003878 *
3879 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3880 * enabled and @node has online CPUs requested by @attrs, the returned
3881 * cpumask is the intersection of the possible CPUs of @node and
3882 * @attrs->cpumask.
3883 *
3884 * The caller is responsible for ensuring that the cpumask of @node stays
3885 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003886 *
3887 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3888 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003889 */
3890static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3891 int cpu_going_down, cpumask_t *cpumask)
3892{
Tejun Heod55262c2013-04-01 11:23:38 -07003893 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003894 goto use_dfl;
3895
3896 /* does @node have any online CPUs @attrs wants? */
3897 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3898 if (cpu_going_down >= 0)
3899 cpumask_clear_cpu(cpu_going_down, cpumask);
3900
3901 if (cpumask_empty(cpumask))
3902 goto use_dfl;
3903
3904 /* yeap, return possible CPUs in @node that @attrs wants */
3905 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003906
3907 if (cpumask_empty(cpumask)) {
3908 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3909 "possible intersect\n");
3910 return false;
3911 }
3912
Tejun Heo4c16bd32013-04-01 11:23:36 -07003913 return !cpumask_equal(cpumask, attrs->cpumask);
3914
3915use_dfl:
3916 cpumask_copy(cpumask, attrs->cpumask);
3917 return false;
3918}
3919
Tejun Heo1befcf32013-04-01 11:23:35 -07003920/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3921static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3922 int node,
3923 struct pool_workqueue *pwq)
3924{
3925 struct pool_workqueue *old_pwq;
3926
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003927 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003928 lockdep_assert_held(&wq->mutex);
3929
3930 /* link_pwq() can handle duplicate calls */
3931 link_pwq(pwq);
3932
3933 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3934 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3935 return old_pwq;
3936}
3937
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003938/* context to store the prepared attrs & pwqs before applying */
3939struct apply_wqattrs_ctx {
3940 struct workqueue_struct *wq; /* target workqueue */
3941 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003942 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003943 struct pool_workqueue *dfl_pwq;
3944 struct pool_workqueue *pwq_tbl[];
3945};
3946
3947/* free the resources after success or abort */
3948static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3949{
3950 if (ctx) {
3951 int node;
3952
3953 for_each_node(node)
3954 put_pwq_unlocked(ctx->pwq_tbl[node]);
3955 put_pwq_unlocked(ctx->dfl_pwq);
3956
3957 free_workqueue_attrs(ctx->attrs);
3958
3959 kfree(ctx);
3960 }
3961}
3962
3963/* allocate the attrs and pwqs for later installation */
3964static struct apply_wqattrs_ctx *
3965apply_wqattrs_prepare(struct workqueue_struct *wq,
3966 const struct workqueue_attrs *attrs)
3967{
3968 struct apply_wqattrs_ctx *ctx;
3969 struct workqueue_attrs *new_attrs, *tmp_attrs;
3970 int node;
3971
3972 lockdep_assert_held(&wq_pool_mutex);
3973
Kees Cookacafe7e2018-05-08 13:45:50 -07003974 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003975
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003976 new_attrs = alloc_workqueue_attrs();
3977 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003978 if (!ctx || !new_attrs || !tmp_attrs)
3979 goto out_free;
3980
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003981 /*
3982 * Calculate the attrs of the default pwq.
3983 * If the user configured cpumask doesn't overlap with the
3984 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3985 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003986 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003987 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003988 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3989 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003990
3991 /*
3992 * We may create multiple pwqs with differing cpumasks. Make a
3993 * copy of @new_attrs which will be modified and used to obtain
3994 * pools.
3995 */
3996 copy_workqueue_attrs(tmp_attrs, new_attrs);
3997
3998 /*
3999 * If something goes wrong during CPU up/down, we'll fall back to
4000 * the default pwq covering whole @attrs->cpumask. Always create
4001 * it even if we don't use it immediately.
4002 */
4003 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
4004 if (!ctx->dfl_pwq)
4005 goto out_free;
4006
4007 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004008 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004009 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
4010 if (!ctx->pwq_tbl[node])
4011 goto out_free;
4012 } else {
4013 ctx->dfl_pwq->refcnt++;
4014 ctx->pwq_tbl[node] = ctx->dfl_pwq;
4015 }
4016 }
4017
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004018 /* save the user configured attrs and sanitize it. */
4019 copy_workqueue_attrs(new_attrs, attrs);
4020 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004021 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004022
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004023 ctx->wq = wq;
4024 free_workqueue_attrs(tmp_attrs);
4025 return ctx;
4026
4027out_free:
4028 free_workqueue_attrs(tmp_attrs);
4029 free_workqueue_attrs(new_attrs);
4030 apply_wqattrs_cleanup(ctx);
4031 return NULL;
4032}
4033
4034/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
4035static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
4036{
4037 int node;
4038
4039 /* all pwqs have been created successfully, let's install'em */
4040 mutex_lock(&ctx->wq->mutex);
4041
4042 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
4043
4044 /* save the previous pwq and install the new one */
4045 for_each_node(node)
4046 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4047 ctx->pwq_tbl[node]);
4048
4049 /* @dfl_pwq might not have been used, ensure it's linked */
4050 link_pwq(ctx->dfl_pwq);
4051 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
4052
4053 mutex_unlock(&ctx->wq->mutex);
4054}
4055
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004056static void apply_wqattrs_lock(void)
4057{
4058 /* CPUs should stay stable across pwq creations and installations */
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004059 cpus_read_lock();
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004060 mutex_lock(&wq_pool_mutex);
4061}
4062
4063static void apply_wqattrs_unlock(void)
4064{
4065 mutex_unlock(&wq_pool_mutex);
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004066 cpus_read_unlock();
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004067}
4068
4069static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4070 const struct workqueue_attrs *attrs)
4071{
4072 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004073
4074 /* only unbound workqueues can change attributes */
4075 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4076 return -EINVAL;
4077
4078 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004079 if (!list_empty(&wq->pwqs)) {
4080 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4081 return -EINVAL;
4082
4083 wq->flags &= ~__WQ_ORDERED;
4084 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004085
4086 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004087 if (!ctx)
4088 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004089
4090 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004091 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004092 apply_wqattrs_cleanup(ctx);
4093
wanghaibin62011712016-01-07 20:38:59 +08004094 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004095}
4096
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004097/**
4098 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4099 * @wq: the target workqueue
4100 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4101 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004102 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4103 * machines, this function maps a separate pwq to each NUMA node with
4104 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4105 * NUMA node it was issued on. Older pwqs are released as in-flight work
4106 * items finish. Note that a work item which repeatedly requeues itself
4107 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004108 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004109 * Performs GFP_KERNEL allocations.
4110 *
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004111 * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
Daniel Jordan509b3202019-09-05 21:40:23 -04004112 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004113 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004114 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004115int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004116 const struct workqueue_attrs *attrs)
4117{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004118 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004119
Daniel Jordan509b3202019-09-05 21:40:23 -04004120 lockdep_assert_cpus_held();
4121
4122 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004123 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004124 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004125
Tejun Heo48621252013-04-01 11:23:31 -07004126 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004127}
4128
Tejun Heo4c16bd32013-04-01 11:23:36 -07004129/**
4130 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4131 * @wq: the target workqueue
4132 * @cpu: the CPU coming up or going down
4133 * @online: whether @cpu is coming up or going down
4134 *
4135 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4136 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4137 * @wq accordingly.
4138 *
4139 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4140 * falls back to @wq->dfl_pwq which may not be optimal but is always
4141 * correct.
4142 *
4143 * Note that when the last allowed CPU of a NUMA node goes offline for a
4144 * workqueue with a cpumask spanning multiple nodes, the workers which were
4145 * already executing the work items for the workqueue will lose their CPU
4146 * affinity and may execute on any CPU. This is similar to how per-cpu
4147 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4148 * affinity, it's the user's responsibility to flush the work item from
4149 * CPU_DOWN_PREPARE.
4150 */
4151static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4152 bool online)
4153{
4154 int node = cpu_to_node(cpu);
4155 int cpu_off = online ? -1 : cpu;
4156 struct pool_workqueue *old_pwq = NULL, *pwq;
4157 struct workqueue_attrs *target_attrs;
4158 cpumask_t *cpumask;
4159
4160 lockdep_assert_held(&wq_pool_mutex);
4161
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004162 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4163 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004164 return;
4165
4166 /*
4167 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4168 * Let's use a preallocated one. The following buf is protected by
4169 * CPU hotplug exclusion.
4170 */
4171 target_attrs = wq_update_unbound_numa_attrs_buf;
4172 cpumask = target_attrs->cpumask;
4173
Tejun Heo4c16bd32013-04-01 11:23:36 -07004174 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4175 pwq = unbound_pwq_by_node(wq, node);
4176
4177 /*
4178 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004179 * different from the default pwq's, we need to compare it to @pwq's
4180 * and create a new one if they don't match. If the target cpumask
4181 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004182 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004183 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004184 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004185 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004186 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004187 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004188 }
4189
Tejun Heo4c16bd32013-04-01 11:23:36 -07004190 /* create a new pwq */
4191 pwq = alloc_unbound_pwq(wq, target_attrs);
4192 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004193 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4194 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004195 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004196 }
4197
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004198 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004199 mutex_lock(&wq->mutex);
4200 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4201 goto out_unlock;
4202
4203use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004204 mutex_lock(&wq->mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004205 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004206 get_pwq(wq->dfl_pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004207 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004208 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4209out_unlock:
4210 mutex_unlock(&wq->mutex);
4211 put_pwq_unlocked(old_pwq);
4212}
4213
Tejun Heo30cdf2492013-03-12 11:29:57 -07004214static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004215{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004216 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004217 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004218
Tejun Heo30cdf2492013-03-12 11:29:57 -07004219 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004220 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4221 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004222 return -ENOMEM;
4223
4224 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004225 struct pool_workqueue *pwq =
4226 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004227 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004228 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004229
Tejun Heof147f292013-04-01 11:23:35 -07004230 init_pwq(pwq, wq, &cpu_pools[highpri]);
4231
4232 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004233 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004234 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004235 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004236 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004237 }
4238
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004239 cpus_read_lock();
Daniel Jordan509b3202019-09-05 21:40:23 -04004240 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004241 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4242 /* there should only be single pwq for ordering guarantee */
4243 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4244 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4245 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004246 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004247 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004248 }
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004249 cpus_read_unlock();
Daniel Jordan509b3202019-09-05 21:40:23 -04004250
4251 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004252}
4253
Tejun Heof3421792010-07-02 10:03:51 +02004254static int wq_clamp_max_active(int max_active, unsigned int flags,
4255 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004256{
Tejun Heof3421792010-07-02 10:03:51 +02004257 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4258
4259 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004260 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4261 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004262
Tejun Heof3421792010-07-02 10:03:51 +02004263 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004264}
4265
Tejun Heo983c7512018-01-08 05:38:32 -08004266/*
4267 * Workqueues which may be used during memory reclaim should have a rescuer
4268 * to guarantee forward progress.
4269 */
4270static int init_rescuer(struct workqueue_struct *wq)
4271{
4272 struct worker *rescuer;
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004273 int ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004274
4275 if (!(wq->flags & WQ_MEM_RECLAIM))
4276 return 0;
4277
4278 rescuer = alloc_worker(NUMA_NO_NODE);
4279 if (!rescuer)
4280 return -ENOMEM;
4281
4282 rescuer->rescue_wq = wq;
4283 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
Sean Fuf187b692020-04-29 12:04:13 +08004284 if (IS_ERR(rescuer->task)) {
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004285 ret = PTR_ERR(rescuer->task);
Tejun Heo983c7512018-01-08 05:38:32 -08004286 kfree(rescuer);
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004287 return ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004288 }
4289
4290 wq->rescuer = rescuer;
4291 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4292 wake_up_process(rescuer->task);
4293
4294 return 0;
4295}
4296
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004297__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004298struct workqueue_struct *alloc_workqueue(const char *fmt,
4299 unsigned int flags,
4300 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004301{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004302 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004303 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004304 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004305 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004306
Tejun Heo5c0338c2017-07-18 18:41:52 -04004307 /*
4308 * Unbound && max_active == 1 used to imply ordered, which is no
4309 * longer the case on NUMA machines due to per-node pools. While
4310 * alloc_ordered_workqueue() is the right way to create an ordered
4311 * workqueue, keep the previous behavior to avoid subtle breakages
4312 * on NUMA.
4313 */
4314 if ((flags & WQ_UNBOUND) && max_active == 1)
4315 flags |= __WQ_ORDERED;
4316
Viresh Kumarcee22a12013-04-08 16:45:40 +05304317 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4318 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4319 flags |= WQ_UNBOUND;
4320
Tejun Heoecf68812013-04-01 11:23:34 -07004321 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004322 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004323 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004324
4325 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004326 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004327 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004328
Tejun Heo6029a912013-04-01 11:23:34 -07004329 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004330 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004331 if (!wq->unbound_attrs)
4332 goto err_free_wq;
4333 }
4334
Bart Van Assche669de8b2019-02-14 15:00:54 -08004335 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004336 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004337 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004338
Tejun Heod320c032010-06-29 10:07:14 +02004339 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004340 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004341
Tejun Heob196be82012-01-10 15:11:35 -08004342 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004343 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004344 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004345 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004346 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004347 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004348 INIT_LIST_HEAD(&wq->flusher_queue);
4349 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004350 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004351
Bart Van Assche669de8b2019-02-14 15:00:54 -08004352 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004353 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004354
Tejun Heo30cdf2492013-03-12 11:29:57 -07004355 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004356 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004357
Tejun Heo40c17f72018-01-08 05:38:37 -08004358 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004359 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004360
Tejun Heo226223a2013-03-12 11:30:05 -07004361 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4362 goto err_destroy;
4363
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004364 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004365 * wq_pool_mutex protects global freeze state and workqueues list.
4366 * Grab it, adjust max_active and add the new @wq to workqueues
4367 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004368 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004369 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004370
Lai Jiangshana357fc02013-03-25 16:57:19 -07004371 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004372 for_each_pwq(pwq, wq)
4373 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004374 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004375
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004376 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004377
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004378 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004379
Oleg Nesterov3af244332007-05-09 02:34:09 -07004380 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004381
Bart Van Assche82efcab2019-03-11 16:02:55 -07004382err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004383 wq_unregister_lockdep(wq);
4384 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004385err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004386 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004387 kfree(wq);
4388 return NULL;
4389err_destroy:
4390 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004391 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004392}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004393EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004394
Tejun Heoc29eb852019-09-23 11:08:58 -07004395static bool pwq_busy(struct pool_workqueue *pwq)
4396{
4397 int i;
4398
4399 for (i = 0; i < WORK_NR_COLORS; i++)
4400 if (pwq->nr_in_flight[i])
4401 return true;
4402
4403 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4404 return true;
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004405 if (pwq->nr_active || !list_empty(&pwq->inactive_works))
Tejun Heoc29eb852019-09-23 11:08:58 -07004406 return true;
4407
4408 return false;
4409}
4410
Oleg Nesterov3af244332007-05-09 02:34:09 -07004411/**
4412 * destroy_workqueue - safely terminate a workqueue
4413 * @wq: target workqueue
4414 *
4415 * Safely destroy a workqueue. All work currently pending will be done first.
4416 */
4417void destroy_workqueue(struct workqueue_struct *wq)
4418{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004419 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004420 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004421
Tejun Heodef98c82019-09-18 18:43:40 -07004422 /*
4423 * Remove it from sysfs first so that sanity check failure doesn't
4424 * lead to sysfs name conflicts.
4425 */
4426 workqueue_sysfs_unregister(wq);
4427
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004428 /* drain it before proceeding with destruction */
4429 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004430
Tejun Heodef98c82019-09-18 18:43:40 -07004431 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4432 if (wq->rescuer) {
4433 struct worker *rescuer = wq->rescuer;
4434
4435 /* this prevents new queueing */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004436 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004437 wq->rescuer = NULL;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004438 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004439
4440 /* rescuer will empty maydays list before exiting */
4441 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004442 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004443 }
4444
Tejun Heoc29eb852019-09-23 11:08:58 -07004445 /*
4446 * Sanity checks - grab all the locks so that we wait for all
4447 * in-flight operations which may do put_pwq().
4448 */
4449 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004450 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004451 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004452 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heoc29eb852019-09-23 11:08:58 -07004453 if (WARN_ON(pwq_busy(pwq))) {
Kefeng Wang1d9a6152019-11-28 08:47:49 +08004454 pr_warn("%s: %s has the following busy pwq\n",
4455 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004456 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004457 raw_spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004458 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004459 mutex_unlock(&wq_pool_mutex);
Imran Khan55df0932021-10-20 14:09:00 +11004460 show_one_workqueue(wq);
Tejun Heo6183c002013-03-12 11:29:57 -07004461 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004462 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004463 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004464 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004465 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004466
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004467 /*
4468 * wq list is used to freeze wq, remove from list after
4469 * flushing is complete in case freeze races us.
4470 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004471 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004472 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004473
Tejun Heo8864b4e2013-03-12 11:30:04 -07004474 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004475 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004476 /*
4477 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004478 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004479 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004480 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004481 } else {
4482 /*
4483 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004484 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4485 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004486 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004487 for_each_node(node) {
4488 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4489 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4490 put_pwq_unlocked(pwq);
4491 }
4492
4493 /*
4494 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4495 * put. Don't access it afterwards.
4496 */
4497 pwq = wq->dfl_pwq;
4498 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004499 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004500 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004501}
4502EXPORT_SYMBOL_GPL(destroy_workqueue);
4503
Tejun Heodcd989c2010-06-29 10:07:14 +02004504/**
4505 * workqueue_set_max_active - adjust max_active of a workqueue
4506 * @wq: target workqueue
4507 * @max_active: new max_active value.
4508 *
4509 * Set max_active of @wq to @max_active.
4510 *
4511 * CONTEXT:
4512 * Don't call from IRQ context.
4513 */
4514void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4515{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004516 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004517
Tejun Heo8719dce2013-03-12 11:30:04 -07004518 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004519 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004520 return;
4521
Tejun Heof3421792010-07-02 10:03:51 +02004522 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004523
Lai Jiangshana357fc02013-03-25 16:57:19 -07004524 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004525
Tejun Heo0a94efb2017-07-23 08:36:15 -04004526 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004527 wq->saved_max_active = max_active;
4528
Tejun Heo699ce092013-03-13 16:51:35 -07004529 for_each_pwq(pwq, wq)
4530 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004531
Lai Jiangshana357fc02013-03-25 16:57:19 -07004532 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004533}
4534EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4535
4536/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004537 * current_work - retrieve %current task's work struct
4538 *
4539 * Determine if %current task is a workqueue worker and what it's working on.
4540 * Useful to find out the context that the %current task is running in.
4541 *
4542 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4543 */
4544struct work_struct *current_work(void)
4545{
4546 struct worker *worker = current_wq_worker();
4547
4548 return worker ? worker->current_work : NULL;
4549}
4550EXPORT_SYMBOL(current_work);
4551
4552/**
Tejun Heoe62676162013-03-12 17:41:37 -07004553 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4554 *
4555 * Determine whether %current is a workqueue rescuer. Can be used from
4556 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004557 *
4558 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004559 */
4560bool current_is_workqueue_rescuer(void)
4561{
4562 struct worker *worker = current_wq_worker();
4563
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004564 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004565}
4566
4567/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004568 * workqueue_congested - test whether a workqueue is congested
4569 * @cpu: CPU in question
4570 * @wq: target workqueue
4571 *
4572 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4573 * no synchronization around this function and the test result is
4574 * unreliable and only useful as advisory hints or for debugging.
4575 *
Tejun Heod3251852013-05-10 11:10:17 -07004576 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4577 * Note that both per-cpu and unbound workqueues may be associated with
4578 * multiple pool_workqueues which have separate congested states. A
4579 * workqueue being congested on one CPU doesn't mean the workqueue is also
4580 * contested on other CPUs / NUMA nodes.
4581 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004582 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004583 * %true if congested, %false otherwise.
4584 */
Tejun Heod84ff052013-03-12 11:29:59 -07004585bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004586{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004587 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004588 bool ret;
4589
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004590 rcu_read_lock();
4591 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004592
Tejun Heod3251852013-05-10 11:10:17 -07004593 if (cpu == WORK_CPU_UNBOUND)
4594 cpu = smp_processor_id();
4595
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004596 if (!(wq->flags & WQ_UNBOUND))
4597 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4598 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004599 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004600
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004601 ret = !list_empty(&pwq->inactive_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004602 preempt_enable();
4603 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004604
4605 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004606}
4607EXPORT_SYMBOL_GPL(workqueue_congested);
4608
4609/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004610 * work_busy - test whether a work is currently pending or running
4611 * @work: the work to be tested
4612 *
4613 * Test whether @work is currently pending or running. There is no
4614 * synchronization around this function and the test result is
4615 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004616 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004617 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004618 * OR'd bitmask of WORK_BUSY_* bits.
4619 */
4620unsigned int work_busy(struct work_struct *work)
4621{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004622 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004623 unsigned long flags;
4624 unsigned int ret = 0;
4625
Tejun Heodcd989c2010-06-29 10:07:14 +02004626 if (work_pending(work))
4627 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004628
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004629 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004630 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004631 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004632 raw_spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004633 if (find_worker_executing_work(pool, work))
4634 ret |= WORK_BUSY_RUNNING;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004635 raw_spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004636 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004637 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004638
4639 return ret;
4640}
4641EXPORT_SYMBOL_GPL(work_busy);
4642
Tejun Heo3d1cb202013-04-30 15:27:22 -07004643/**
4644 * set_worker_desc - set description for the current work item
4645 * @fmt: printf-style format string
4646 * @...: arguments for the format string
4647 *
4648 * This function can be called by a running work function to describe what
4649 * the work item is about. If the worker task gets dumped, this
4650 * information will be printed out together to help debugging. The
4651 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4652 */
4653void set_worker_desc(const char *fmt, ...)
4654{
4655 struct worker *worker = current_wq_worker();
4656 va_list args;
4657
4658 if (worker) {
4659 va_start(args, fmt);
4660 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4661 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004662 }
4663}
Steffen Maier5c750d52018-05-17 19:14:57 +02004664EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004665
4666/**
4667 * print_worker_info - print out worker information and description
4668 * @log_lvl: the log level to use when printing
4669 * @task: target task
4670 *
4671 * If @task is a worker and currently executing a work item, print out the
4672 * name of the workqueue being serviced and worker description set with
4673 * set_worker_desc() by the currently executing work item.
4674 *
4675 * This function can be safely called on any task as long as the
4676 * task_struct itself is accessible. While safe, this function isn't
4677 * synchronized and may print out mixups or garbages of limited length.
4678 */
4679void print_worker_info(const char *log_lvl, struct task_struct *task)
4680{
4681 work_func_t *fn = NULL;
4682 char name[WQ_NAME_LEN] = { };
4683 char desc[WORKER_DESC_LEN] = { };
4684 struct pool_workqueue *pwq = NULL;
4685 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004686 struct worker *worker;
4687
4688 if (!(task->flags & PF_WQ_WORKER))
4689 return;
4690
4691 /*
4692 * This function is called without any synchronization and @task
4693 * could be in any state. Be careful with dereferences.
4694 */
Petr Mladeke7005912016-10-11 13:55:17 -07004695 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004696
4697 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004698 * Carefully copy the associated workqueue's workfn, name and desc.
4699 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004700 */
Christoph Hellwigfe557312020-06-17 09:37:53 +02004701 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4702 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4703 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4704 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4705 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004706
4707 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004708 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004709 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004710 pr_cont(" (%s)", desc);
4711 pr_cont("\n");
4712 }
4713}
4714
Tejun Heo3494fc32015-03-09 09:22:28 -04004715static void pr_cont_pool_info(struct worker_pool *pool)
4716{
4717 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4718 if (pool->node != NUMA_NO_NODE)
4719 pr_cont(" node=%d", pool->node);
4720 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4721}
4722
4723static void pr_cont_work(bool comma, struct work_struct *work)
4724{
4725 if (work->func == wq_barrier_func) {
4726 struct wq_barrier *barr;
4727
4728 barr = container_of(work, struct wq_barrier, work);
4729
4730 pr_cont("%s BAR(%d)", comma ? "," : "",
4731 task_pid_nr(barr->task));
4732 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004733 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004734 }
4735}
4736
4737static void show_pwq(struct pool_workqueue *pwq)
4738{
4739 struct worker_pool *pool = pwq->pool;
4740 struct work_struct *work;
4741 struct worker *worker;
4742 bool has_in_flight = false, has_pending = false;
4743 int bkt;
4744
4745 pr_info(" pwq %d:", pool->id);
4746 pr_cont_pool_info(pool);
4747
Tejun Heoe66b39a2019-09-25 06:59:15 -07004748 pr_cont(" active=%d/%d refcnt=%d%s\n",
4749 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004750 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4751
4752 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4753 if (worker->current_pwq == pwq) {
4754 has_in_flight = true;
4755 break;
4756 }
4757 }
4758 if (has_in_flight) {
4759 bool comma = false;
4760
4761 pr_info(" in-flight:");
4762 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4763 if (worker->current_pwq != pwq)
4764 continue;
4765
Sakari Ailusd75f7732019-03-25 21:32:28 +02004766 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004767 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004768 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004769 worker->current_func);
4770 list_for_each_entry(work, &worker->scheduled, entry)
4771 pr_cont_work(false, work);
4772 comma = true;
4773 }
4774 pr_cont("\n");
4775 }
4776
4777 list_for_each_entry(work, &pool->worklist, entry) {
4778 if (get_work_pwq(work) == pwq) {
4779 has_pending = true;
4780 break;
4781 }
4782 }
4783 if (has_pending) {
4784 bool comma = false;
4785
4786 pr_info(" pending:");
4787 list_for_each_entry(work, &pool->worklist, entry) {
4788 if (get_work_pwq(work) != pwq)
4789 continue;
4790
4791 pr_cont_work(comma, work);
4792 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4793 }
4794 pr_cont("\n");
4795 }
4796
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004797 if (!list_empty(&pwq->inactive_works)) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004798 bool comma = false;
4799
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004800 pr_info(" inactive:");
4801 list_for_each_entry(work, &pwq->inactive_works, entry) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004802 pr_cont_work(comma, work);
4803 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4804 }
4805 pr_cont("\n");
4806 }
4807}
4808
4809/**
Imran Khan55df0932021-10-20 14:09:00 +11004810 * show_one_workqueue - dump state of specified workqueue
4811 * @wq: workqueue whose state will be printed
4812 */
4813void show_one_workqueue(struct workqueue_struct *wq)
4814{
4815 struct pool_workqueue *pwq;
4816 bool idle = true;
4817 unsigned long flags;
4818
4819 for_each_pwq(pwq, wq) {
4820 if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
4821 idle = false;
4822 break;
4823 }
4824 }
4825 if (idle) /* Nothing to print for idle workqueue */
4826 return;
4827
4828 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4829
4830 for_each_pwq(pwq, wq) {
4831 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
4832 if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
4833 /*
4834 * Defer printing to avoid deadlocks in console
4835 * drivers that queue work while holding locks
4836 * also taken in their write paths.
4837 */
4838 printk_deferred_enter();
4839 show_pwq(pwq);
4840 printk_deferred_exit();
4841 }
4842 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
4843 /*
4844 * We could be printing a lot from atomic context, e.g.
4845 * sysrq-t -> show_all_workqueues(). Avoid triggering
4846 * hard lockup.
4847 */
4848 touch_nmi_watchdog();
4849 }
4850
4851}
4852
4853/**
4854 * show_one_worker_pool - dump state of specified worker pool
4855 * @pool: worker pool whose state will be printed
4856 */
4857static void show_one_worker_pool(struct worker_pool *pool)
4858{
4859 struct worker *worker;
4860 bool first = true;
4861 unsigned long flags;
4862
4863 raw_spin_lock_irqsave(&pool->lock, flags);
4864 if (pool->nr_workers == pool->nr_idle)
4865 goto next_pool;
4866 /*
4867 * Defer printing to avoid deadlocks in console drivers that
4868 * queue work while holding locks also taken in their write
4869 * paths.
4870 */
4871 printk_deferred_enter();
4872 pr_info("pool %d:", pool->id);
4873 pr_cont_pool_info(pool);
4874 pr_cont(" hung=%us workers=%d",
4875 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4876 pool->nr_workers);
4877 if (pool->manager)
4878 pr_cont(" manager: %d",
4879 task_pid_nr(pool->manager->task));
4880 list_for_each_entry(worker, &pool->idle_list, entry) {
4881 pr_cont(" %s%d", first ? "idle: " : "",
4882 task_pid_nr(worker->task));
4883 first = false;
4884 }
4885 pr_cont("\n");
4886 printk_deferred_exit();
4887next_pool:
4888 raw_spin_unlock_irqrestore(&pool->lock, flags);
4889 /*
4890 * We could be printing a lot from atomic context, e.g.
4891 * sysrq-t -> show_all_workqueues(). Avoid triggering
4892 * hard lockup.
4893 */
4894 touch_nmi_watchdog();
4895
4896}
4897
4898/**
4899 * show_all_workqueues - dump workqueue state
Tejun Heo3494fc32015-03-09 09:22:28 -04004900 *
Roger Lu7b776af2016-07-01 11:05:02 +08004901 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4902 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004903 */
Imran Khan55df0932021-10-20 14:09:00 +11004904void show_all_workqueues(void)
Tejun Heo3494fc32015-03-09 09:22:28 -04004905{
4906 struct workqueue_struct *wq;
4907 struct worker_pool *pool;
Tejun Heo3494fc32015-03-09 09:22:28 -04004908 int pi;
4909
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004910 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004911
4912 pr_info("Showing busy workqueues and worker pools:\n");
4913
Imran Khan55df0932021-10-20 14:09:00 +11004914 list_for_each_entry_rcu(wq, &workqueues, list)
4915 show_one_workqueue(wq);
Tejun Heo3494fc32015-03-09 09:22:28 -04004916
Imran Khan55df0932021-10-20 14:09:00 +11004917 for_each_pool(pool, pi)
4918 show_one_worker_pool(pool);
Tejun Heo3494fc32015-03-09 09:22:28 -04004919
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004920 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004921}
4922
Tejun Heo6b598082018-05-18 08:47:13 -07004923/* used to show worker information through /proc/PID/{comm,stat,status} */
4924void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4925{
Tejun Heo6b598082018-05-18 08:47:13 -07004926 int off;
4927
4928 /* always show the actual comm */
4929 off = strscpy(buf, task->comm, size);
4930 if (off < 0)
4931 return;
4932
Tejun Heo197f6ac2018-05-21 08:04:35 -07004933 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004934 mutex_lock(&wq_pool_attach_mutex);
4935
Tejun Heo197f6ac2018-05-21 08:04:35 -07004936 if (task->flags & PF_WQ_WORKER) {
4937 struct worker *worker = kthread_data(task);
4938 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004939
Tejun Heo197f6ac2018-05-21 08:04:35 -07004940 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004941 raw_spin_lock_irq(&pool->lock);
Tejun Heo197f6ac2018-05-21 08:04:35 -07004942 /*
4943 * ->desc tracks information (wq name or
4944 * set_worker_desc()) for the latest execution. If
4945 * current, prepend '+', otherwise '-'.
4946 */
4947 if (worker->desc[0] != '\0') {
4948 if (worker->current_work)
4949 scnprintf(buf + off, size - off, "+%s",
4950 worker->desc);
4951 else
4952 scnprintf(buf + off, size - off, "-%s",
4953 worker->desc);
4954 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004955 raw_spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004956 }
Tejun Heo6b598082018-05-18 08:47:13 -07004957 }
4958
4959 mutex_unlock(&wq_pool_attach_mutex);
4960}
4961
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004962#ifdef CONFIG_SMP
4963
Tejun Heodb7bccf2010-06-29 10:07:12 +02004964/*
4965 * CPU hotplug.
4966 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004967 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004968 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004969 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004970 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004971 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004972 * blocked draining impractical.
4973 *
Tejun Heo24647572013-01-24 11:01:33 -08004974 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004975 * running as an unbound one and allowing it to be reattached later if the
4976 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004977 */
4978
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004979static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004980{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004981 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004982 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004983
Tejun Heof02ae732013-03-12 11:30:03 -07004984 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004985 mutex_lock(&wq_pool_attach_mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004986 raw_spin_lock_irq(&pool->lock);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004987
4988 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004989 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004990 * unbound and set DISASSOCIATED. Before this, all workers
Lai Jiangshan11b45b02021-12-07 15:35:39 +08004991 * must be on the cpu. After this, they may become diasporas.
Lai Jiangshanb4ac9382021-12-07 15:35:40 +08004992 * And the preemption disabled section in their sched callbacks
4993 * are guaranteed to see WORKER_UNBOUND since the code here
4994 * is on the same cpu.
Tejun Heo94cf58b2013-01-24 11:01:33 -08004995 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004996 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004997 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004998
Tejun Heo24647572013-01-24 11:01:33 -08004999 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07005000
Lai Jiangshaneb283422013-03-08 15:18:28 -08005001 /*
Lai Jiangshan989442d72021-12-07 15:35:41 +08005002 * The handling of nr_running in sched callbacks are disabled
5003 * now. Zap nr_running. After this, nr_running stays zero and
5004 * need_more_worker() and keep_working() are always true as
5005 * long as the worklist is not empty. This pool now behaves as
5006 * an unbound (in terms of concurrency management) pool which
Lai Jiangshaneb283422013-03-08 15:18:28 -08005007 * are served by workers tied to the pool.
5008 */
Tejun Heoe19e3972013-01-24 11:39:44 -08005009 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08005010
5011 /*
5012 * With concurrency management just turned off, a busy
5013 * worker blocking could lead to lengthy stalls. Kick off
5014 * unbound chain execution of currently pending work items.
5015 */
Lai Jiangshaneb283422013-03-08 15:18:28 -08005016 wake_up_worker(pool);
Lai Jiangshan989442d72021-12-07 15:35:41 +08005017
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005018 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan989442d72021-12-07 15:35:41 +08005019
5020 for_each_pool_worker(worker, pool) {
5021 kthread_set_per_cpu(worker->task, -1);
5022 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
5023 }
5024
5025 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshaneb283422013-03-08 15:18:28 -08005026 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02005027}
5028
Tejun Heobd7c0892013-03-19 13:45:21 -07005029/**
5030 * rebind_workers - rebind all workers of a pool to the associated CPU
5031 * @pool: pool of interest
5032 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07005033 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07005034 */
5035static void rebind_workers(struct worker_pool *pool)
5036{
Tejun Heoa9ab7752013-03-19 13:45:21 -07005037 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07005038
Tejun Heo1258fae2018-05-18 08:47:13 -07005039 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07005040
Tejun Heoa9ab7752013-03-19 13:45:21 -07005041 /*
5042 * Restore CPU affinity of all workers. As all idle workers should
5043 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05305044 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07005045 * of all workers first and then clear UNBOUND. As we're called
5046 * from CPU_ONLINE, the following shouldn't fail.
5047 */
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01005048 for_each_pool_worker(worker, pool) {
5049 kthread_set_per_cpu(worker->task, pool->cpu);
Tejun Heoa9ab7752013-03-19 13:45:21 -07005050 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
5051 pool->attrs->cpumask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01005052 }
Tejun Heoa9ab7752013-03-19 13:45:21 -07005053
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005054 raw_spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08005055
Lai Jiangshan3de5e882014-06-03 15:33:27 +08005056 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07005057
Lai Jiangshanda028462014-05-20 17:46:31 +08005058 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07005059 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07005060
5061 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07005062 * We want to clear UNBOUND but can't directly call
5063 * worker_clr_flags() or adjust nr_running. Atomically
5064 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5065 * @worker will clear REBOUND using worker_clr_flags() when
5066 * it initiates the next execution cycle thus restoring
5067 * concurrency management. Note that when or whether
5068 * @worker clears REBOUND doesn't affect correctness.
5069 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07005070 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07005071 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01005072 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07005073 * fail incorrectly leading to premature concurrency
5074 * management operations.
5075 */
5076 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5077 worker_flags |= WORKER_REBOUND;
5078 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07005079 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07005080 }
5081
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005082 raw_spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07005083}
5084
Tejun Heo7dbc7252013-03-19 13:45:21 -07005085/**
5086 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5087 * @pool: unbound pool of interest
5088 * @cpu: the CPU which is coming up
5089 *
5090 * An unbound pool may end up with a cpumask which doesn't have any online
5091 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5092 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5093 * online CPU before, cpus_allowed of all its workers should be restored.
5094 */
5095static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5096{
5097 static cpumask_t cpumask;
5098 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005099
Tejun Heo1258fae2018-05-18 08:47:13 -07005100 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005101
5102 /* is @cpu allowed for @pool? */
5103 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5104 return;
5105
Tejun Heo7dbc7252013-03-19 13:45:21 -07005106 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005107
5108 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005109 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005110 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005111}
5112
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005113int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005114{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005115 struct worker_pool *pool;
5116
5117 for_each_cpu_worker_pool(pool, cpu) {
5118 if (pool->nr_workers)
5119 continue;
5120 if (!create_worker(pool))
5121 return -ENOMEM;
5122 }
5123 return 0;
5124}
5125
5126int workqueue_online_cpu(unsigned int cpu)
5127{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005128 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005129 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005130 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005131
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005132 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005133
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005134 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005135 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005136
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005137 if (pool->cpu == cpu)
5138 rebind_workers(pool);
5139 else if (pool->cpu < 0)
5140 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005141
Tejun Heo1258fae2018-05-18 08:47:13 -07005142 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005143 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005144
5145 /* update NUMA affinity of unbound workqueues */
5146 list_for_each_entry(wq, &workqueues, list)
5147 wq_update_unbound_numa(wq, cpu, true);
5148
5149 mutex_unlock(&wq_pool_mutex);
5150 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005151}
5152
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005153int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005154{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005155 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005156
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005157 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005158 if (WARN_ON(cpu != smp_processor_id()))
5159 return -1;
5160
5161 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005162
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005163 /* update NUMA affinity of unbound workqueues */
5164 mutex_lock(&wq_pool_mutex);
5165 list_for_each_entry(wq, &workqueues, list)
5166 wq_update_unbound_numa(wq, cpu, false);
5167 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005168
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005169 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005170}
5171
Rusty Russell2d3854a2008-11-05 13:39:10 +11005172struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005173 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005174 long (*fn)(void *);
5175 void *arg;
5176 long ret;
5177};
5178
Tejun Heoed48ece2012-09-18 12:48:43 -07005179static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005180{
Tejun Heoed48ece2012-09-18 12:48:43 -07005181 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5182
Rusty Russell2d3854a2008-11-05 13:39:10 +11005183 wfc->ret = wfc->fn(wfc->arg);
5184}
5185
5186/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005187 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005188 * @cpu: the cpu to run on
5189 * @fn: the function to run
5190 * @arg: the function arg
5191 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005192 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005193 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005194 *
5195 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005196 */
Tejun Heod84ff052013-03-12 11:29:59 -07005197long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005198{
Tejun Heoed48ece2012-09-18 12:48:43 -07005199 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005200
Tejun Heoed48ece2012-09-18 12:48:43 -07005201 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5202 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005203 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005204 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005205 return wfc.ret;
5206}
5207EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005208
5209/**
5210 * work_on_cpu_safe - run a function in thread context on a particular cpu
5211 * @cpu: the cpu to run on
5212 * @fn: the function to run
5213 * @arg: the function argument
5214 *
5215 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5216 * any locks which would prevent @fn from completing.
5217 *
5218 * Return: The value @fn returns.
5219 */
5220long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5221{
5222 long ret = -ENODEV;
5223
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005224 cpus_read_lock();
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005225 if (cpu_online(cpu))
5226 ret = work_on_cpu(cpu, fn, arg);
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005227 cpus_read_unlock();
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005228 return ret;
5229}
5230EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005231#endif /* CONFIG_SMP */
5232
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005233#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305234
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005235/**
5236 * freeze_workqueues_begin - begin freezing workqueues
5237 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005238 * Start freezing workqueues. After this function returns, all freezable
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08005239 * workqueues will queue new works to their inactive_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005240 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005241 *
5242 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005243 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005244 */
5245void freeze_workqueues_begin(void)
5246{
Tejun Heo24b8a842013-03-12 11:29:58 -07005247 struct workqueue_struct *wq;
5248 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005249
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005250 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005251
Tejun Heo6183c002013-03-12 11:29:57 -07005252 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005253 workqueue_freezing = true;
5254
Tejun Heo24b8a842013-03-12 11:29:58 -07005255 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 Heo24b8a842013-03-12 11:29:58 -07005260 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005261
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005262 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005263}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005264
5265/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005266 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005267 *
5268 * Check whether freezing is complete. This function must be called
5269 * between freeze_workqueues_begin() and thaw_workqueues().
5270 *
5271 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005272 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005273 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005274 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005275 * %true if some freezable workqueues are still busy. %false if freezing
5276 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005277 */
5278bool freeze_workqueues_busy(void)
5279{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005280 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005281 struct workqueue_struct *wq;
5282 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005283
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005284 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005285
Tejun Heo6183c002013-03-12 11:29:57 -07005286 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005287
Tejun Heo24b8a842013-03-12 11:29:58 -07005288 list_for_each_entry(wq, &workqueues, list) {
5289 if (!(wq->flags & WQ_FREEZABLE))
5290 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005291 /*
5292 * nr_active is monotonically decreasing. It's safe
5293 * to peek without lock.
5294 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005295 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005296 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005297 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005298 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005299 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005300 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005301 goto out_unlock;
5302 }
5303 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005304 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005305 }
5306out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005307 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005308 return busy;
5309}
5310
5311/**
5312 * thaw_workqueues - thaw workqueues
5313 *
5314 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005315 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005316 *
5317 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005318 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005319 */
5320void thaw_workqueues(void)
5321{
Tejun Heo24b8a842013-03-12 11:29:58 -07005322 struct workqueue_struct *wq;
5323 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005324
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005325 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005326
5327 if (!workqueue_freezing)
5328 goto out_unlock;
5329
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005330 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005331
Tejun Heo24b8a842013-03-12 11:29:58 -07005332 /* restore max_active and repopulate worklist */
5333 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005334 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005335 for_each_pwq(pwq, wq)
5336 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005337 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005338 }
5339
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005340out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005341 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005342}
5343#endif /* CONFIG_FREEZER */
5344
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005345static int workqueue_apply_unbound_cpumask(void)
5346{
5347 LIST_HEAD(ctxs);
5348 int ret = 0;
5349 struct workqueue_struct *wq;
5350 struct apply_wqattrs_ctx *ctx, *n;
5351
5352 lockdep_assert_held(&wq_pool_mutex);
5353
5354 list_for_each_entry(wq, &workqueues, list) {
5355 if (!(wq->flags & WQ_UNBOUND))
5356 continue;
5357 /* creating multiple pwqs breaks ordering guarantee */
5358 if (wq->flags & __WQ_ORDERED)
5359 continue;
5360
5361 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5362 if (!ctx) {
5363 ret = -ENOMEM;
5364 break;
5365 }
5366
5367 list_add_tail(&ctx->list, &ctxs);
5368 }
5369
5370 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5371 if (!ret)
5372 apply_wqattrs_commit(ctx);
5373 apply_wqattrs_cleanup(ctx);
5374 }
5375
5376 return ret;
5377}
5378
5379/**
5380 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5381 * @cpumask: the cpumask to set
5382 *
5383 * The low-level workqueues cpumask is a global cpumask that limits
5384 * the affinity of all unbound workqueues. This function check the @cpumask
5385 * and apply it to all unbound workqueues and updates all pwqs of them.
5386 *
Cai Huoqing67dc8322021-07-31 08:01:29 +08005387 * Return: 0 - Success
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005388 * -EINVAL - Invalid @cpumask
5389 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5390 */
5391int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5392{
5393 int ret = -EINVAL;
5394 cpumask_var_t saved_cpumask;
5395
Tal Shorerc98a9802017-11-03 17:27:50 +02005396 /*
5397 * Not excluding isolated cpus on purpose.
5398 * If the user wishes to include them, we allow that.
5399 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005400 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5401 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005402 apply_wqattrs_lock();
Menglong Dongd25302e2021-10-17 20:04:02 +08005403 if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
5404 ret = 0;
5405 goto out_unlock;
5406 }
5407
5408 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) {
5409 ret = -ENOMEM;
5410 goto out_unlock;
5411 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005412
5413 /* save the old wq_unbound_cpumask. */
5414 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5415
5416 /* update wq_unbound_cpumask at first and apply it to wqs. */
5417 cpumask_copy(wq_unbound_cpumask, cpumask);
5418 ret = workqueue_apply_unbound_cpumask();
5419
5420 /* restore the wq_unbound_cpumask when failed. */
5421 if (ret < 0)
5422 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5423
Menglong Dongd25302e2021-10-17 20:04:02 +08005424 free_cpumask_var(saved_cpumask);
5425out_unlock:
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005426 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005427 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005428
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005429 return ret;
5430}
5431
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005432#ifdef CONFIG_SYSFS
5433/*
5434 * Workqueues with WQ_SYSFS flag set is visible to userland via
5435 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5436 * following attributes.
5437 *
5438 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5439 * max_active RW int : maximum number of in-flight work items
5440 *
5441 * Unbound workqueues have the following extra attributes.
5442 *
Wang Long9a19b462017-11-02 23:05:12 -04005443 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005444 * nice RW int : nice value of the workers
5445 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005446 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005447 */
5448struct wq_device {
5449 struct workqueue_struct *wq;
5450 struct device dev;
5451};
5452
5453static struct workqueue_struct *dev_to_wq(struct device *dev)
5454{
5455 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5456
5457 return wq_dev->wq;
5458}
5459
5460static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5461 char *buf)
5462{
5463 struct workqueue_struct *wq = dev_to_wq(dev);
5464
5465 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5466}
5467static DEVICE_ATTR_RO(per_cpu);
5468
5469static ssize_t max_active_show(struct device *dev,
5470 struct device_attribute *attr, char *buf)
5471{
5472 struct workqueue_struct *wq = dev_to_wq(dev);
5473
5474 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5475}
5476
5477static ssize_t max_active_store(struct device *dev,
5478 struct device_attribute *attr, const char *buf,
5479 size_t count)
5480{
5481 struct workqueue_struct *wq = dev_to_wq(dev);
5482 int val;
5483
5484 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5485 return -EINVAL;
5486
5487 workqueue_set_max_active(wq, val);
5488 return count;
5489}
5490static DEVICE_ATTR_RW(max_active);
5491
5492static struct attribute *wq_sysfs_attrs[] = {
5493 &dev_attr_per_cpu.attr,
5494 &dev_attr_max_active.attr,
5495 NULL,
5496};
5497ATTRIBUTE_GROUPS(wq_sysfs);
5498
5499static ssize_t wq_pool_ids_show(struct device *dev,
5500 struct device_attribute *attr, char *buf)
5501{
5502 struct workqueue_struct *wq = dev_to_wq(dev);
5503 const char *delim = "";
5504 int node, written = 0;
5505
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005506 cpus_read_lock();
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005507 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005508 for_each_node(node) {
5509 written += scnprintf(buf + written, PAGE_SIZE - written,
5510 "%s%d:%d", delim, node,
5511 unbound_pwq_by_node(wq, node)->pool->id);
5512 delim = " ";
5513 }
5514 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005515 rcu_read_unlock();
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005516 cpus_read_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005517
5518 return written;
5519}
5520
5521static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5522 char *buf)
5523{
5524 struct workqueue_struct *wq = dev_to_wq(dev);
5525 int written;
5526
5527 mutex_lock(&wq->mutex);
5528 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5529 mutex_unlock(&wq->mutex);
5530
5531 return written;
5532}
5533
5534/* prepare workqueue_attrs for sysfs store operations */
5535static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5536{
5537 struct workqueue_attrs *attrs;
5538
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005539 lockdep_assert_held(&wq_pool_mutex);
5540
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005541 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005542 if (!attrs)
5543 return NULL;
5544
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005545 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005546 return attrs;
5547}
5548
5549static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5550 const char *buf, size_t count)
5551{
5552 struct workqueue_struct *wq = dev_to_wq(dev);
5553 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005554 int ret = -ENOMEM;
5555
5556 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005557
5558 attrs = wq_sysfs_prep_attrs(wq);
5559 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005560 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005561
5562 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5563 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005564 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005565 else
5566 ret = -EINVAL;
5567
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005568out_unlock:
5569 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005570 free_workqueue_attrs(attrs);
5571 return ret ?: count;
5572}
5573
5574static ssize_t wq_cpumask_show(struct device *dev,
5575 struct device_attribute *attr, char *buf)
5576{
5577 struct workqueue_struct *wq = dev_to_wq(dev);
5578 int written;
5579
5580 mutex_lock(&wq->mutex);
5581 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5582 cpumask_pr_args(wq->unbound_attrs->cpumask));
5583 mutex_unlock(&wq->mutex);
5584 return written;
5585}
5586
5587static ssize_t wq_cpumask_store(struct device *dev,
5588 struct device_attribute *attr,
5589 const char *buf, size_t count)
5590{
5591 struct workqueue_struct *wq = dev_to_wq(dev);
5592 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005593 int ret = -ENOMEM;
5594
5595 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005596
5597 attrs = wq_sysfs_prep_attrs(wq);
5598 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005599 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005600
5601 ret = cpumask_parse(buf, attrs->cpumask);
5602 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005603 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005604
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005605out_unlock:
5606 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005607 free_workqueue_attrs(attrs);
5608 return ret ?: count;
5609}
5610
5611static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5612 char *buf)
5613{
5614 struct workqueue_struct *wq = dev_to_wq(dev);
5615 int written;
5616
5617 mutex_lock(&wq->mutex);
5618 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5619 !wq->unbound_attrs->no_numa);
5620 mutex_unlock(&wq->mutex);
5621
5622 return written;
5623}
5624
5625static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5626 const char *buf, size_t count)
5627{
5628 struct workqueue_struct *wq = dev_to_wq(dev);
5629 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005630 int v, ret = -ENOMEM;
5631
5632 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005633
5634 attrs = wq_sysfs_prep_attrs(wq);
5635 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005636 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005637
5638 ret = -EINVAL;
5639 if (sscanf(buf, "%d", &v) == 1) {
5640 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005641 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005642 }
5643
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005644out_unlock:
5645 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005646 free_workqueue_attrs(attrs);
5647 return ret ?: count;
5648}
5649
5650static struct device_attribute wq_sysfs_unbound_attrs[] = {
5651 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5652 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5653 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5654 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5655 __ATTR_NULL,
5656};
5657
5658static struct bus_type wq_subsys = {
5659 .name = "workqueue",
5660 .dev_groups = wq_sysfs_groups,
5661};
5662
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005663static ssize_t wq_unbound_cpumask_show(struct device *dev,
5664 struct device_attribute *attr, char *buf)
5665{
5666 int written;
5667
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005668 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005669 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5670 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005671 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005672
5673 return written;
5674}
5675
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005676static ssize_t wq_unbound_cpumask_store(struct device *dev,
5677 struct device_attribute *attr, const char *buf, size_t count)
5678{
5679 cpumask_var_t cpumask;
5680 int ret;
5681
5682 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5683 return -ENOMEM;
5684
5685 ret = cpumask_parse(buf, cpumask);
5686 if (!ret)
5687 ret = workqueue_set_unbound_cpumask(cpumask);
5688
5689 free_cpumask_var(cpumask);
5690 return ret ? ret : count;
5691}
5692
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005693static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005694 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5695 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005696
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005697static int __init wq_sysfs_init(void)
5698{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005699 int err;
5700
5701 err = subsys_virtual_register(&wq_subsys, NULL);
5702 if (err)
5703 return err;
5704
5705 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005706}
5707core_initcall(wq_sysfs_init);
5708
5709static void wq_device_release(struct device *dev)
5710{
5711 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5712
5713 kfree(wq_dev);
5714}
5715
5716/**
5717 * workqueue_sysfs_register - make a workqueue visible in sysfs
5718 * @wq: the workqueue to register
5719 *
5720 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5721 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5722 * which is the preferred method.
5723 *
5724 * Workqueue user should use this function directly iff it wants to apply
5725 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5726 * apply_workqueue_attrs() may race against userland updating the
5727 * attributes.
5728 *
5729 * Return: 0 on success, -errno on failure.
5730 */
5731int workqueue_sysfs_register(struct workqueue_struct *wq)
5732{
5733 struct wq_device *wq_dev;
5734 int ret;
5735
5736 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305737 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005738 * attributes breaks ordering guarantee. Disallow exposing ordered
5739 * workqueues.
5740 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005741 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005742 return -EINVAL;
5743
5744 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5745 if (!wq_dev)
5746 return -ENOMEM;
5747
5748 wq_dev->wq = wq;
5749 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005750 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005751 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005752
5753 /*
5754 * unbound_attrs are created separately. Suppress uevent until
5755 * everything is ready.
5756 */
5757 dev_set_uevent_suppress(&wq_dev->dev, true);
5758
5759 ret = device_register(&wq_dev->dev);
5760 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305761 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005762 wq->wq_dev = NULL;
5763 return ret;
5764 }
5765
5766 if (wq->flags & WQ_UNBOUND) {
5767 struct device_attribute *attr;
5768
5769 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5770 ret = device_create_file(&wq_dev->dev, attr);
5771 if (ret) {
5772 device_unregister(&wq_dev->dev);
5773 wq->wq_dev = NULL;
5774 return ret;
5775 }
5776 }
5777 }
5778
5779 dev_set_uevent_suppress(&wq_dev->dev, false);
5780 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5781 return 0;
5782}
5783
5784/**
5785 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5786 * @wq: the workqueue to unregister
5787 *
5788 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5789 */
5790static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5791{
5792 struct wq_device *wq_dev = wq->wq_dev;
5793
5794 if (!wq->wq_dev)
5795 return;
5796
5797 wq->wq_dev = NULL;
5798 device_unregister(&wq_dev->dev);
5799}
5800#else /* CONFIG_SYSFS */
5801static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5802#endif /* CONFIG_SYSFS */
5803
Tejun Heo82607adc2015-12-08 11:28:04 -05005804/*
5805 * Workqueue watchdog.
5806 *
5807 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5808 * flush dependency, a concurrency managed work item which stays RUNNING
5809 * indefinitely. Workqueue stalls can be very difficult to debug as the
5810 * usual warning mechanisms don't trigger and internal workqueue state is
5811 * largely opaque.
5812 *
5813 * Workqueue watchdog monitors all worker pools periodically and dumps
5814 * state if some pools failed to make forward progress for a while where
5815 * forward progress is defined as the first item on ->worklist changing.
5816 *
5817 * This mechanism is controlled through the kernel parameter
5818 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5819 * corresponding sysfs parameter file.
5820 */
5821#ifdef CONFIG_WQ_WATCHDOG
5822
Tejun Heo82607adc2015-12-08 11:28:04 -05005823static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005824static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005825
5826static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5827static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5828
5829static void wq_watchdog_reset_touched(void)
5830{
5831 int cpu;
5832
5833 wq_watchdog_touched = jiffies;
5834 for_each_possible_cpu(cpu)
5835 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5836}
5837
Kees Cook5cd79d62017-10-04 16:27:00 -07005838static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005839{
5840 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5841 bool lockup_detected = false;
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005842 unsigned long now = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005843 struct worker_pool *pool;
5844 int pi;
5845
5846 if (!thresh)
5847 return;
5848
5849 rcu_read_lock();
5850
5851 for_each_pool(pool, pi) {
5852 unsigned long pool_ts, touched, ts;
5853
5854 if (list_empty(&pool->worklist))
5855 continue;
5856
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005857 /*
5858 * If a virtual machine is stopped by the host it can look to
5859 * the watchdog like a stall.
5860 */
5861 kvm_check_and_clear_guest_paused();
5862
Tejun Heo82607adc2015-12-08 11:28:04 -05005863 /* get the latest of pool and touched timestamps */
Wang Qing89e28ce2021-03-24 19:40:29 +08005864 if (pool->cpu >= 0)
5865 touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
5866 else
5867 touched = READ_ONCE(wq_watchdog_touched);
Tejun Heo82607adc2015-12-08 11:28:04 -05005868 pool_ts = READ_ONCE(pool->watchdog_ts);
Tejun Heo82607adc2015-12-08 11:28:04 -05005869
5870 if (time_after(pool_ts, touched))
5871 ts = pool_ts;
5872 else
5873 ts = touched;
5874
Tejun Heo82607adc2015-12-08 11:28:04 -05005875 /* did we stall? */
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005876 if (time_after(now, ts + thresh)) {
Tejun Heo82607adc2015-12-08 11:28:04 -05005877 lockup_detected = true;
5878 pr_emerg("BUG: workqueue lockup - pool");
5879 pr_cont_pool_info(pool);
5880 pr_cont(" stuck for %us!\n",
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005881 jiffies_to_msecs(now - pool_ts) / 1000);
Tejun Heo82607adc2015-12-08 11:28:04 -05005882 }
5883 }
5884
5885 rcu_read_unlock();
5886
5887 if (lockup_detected)
Imran Khan55df0932021-10-20 14:09:00 +11005888 show_all_workqueues();
Tejun Heo82607adc2015-12-08 11:28:04 -05005889
5890 wq_watchdog_reset_touched();
5891 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5892}
5893
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005894notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005895{
5896 if (cpu >= 0)
5897 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
Wang Qing89e28ce2021-03-24 19:40:29 +08005898
5899 wq_watchdog_touched = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005900}
5901
5902static void wq_watchdog_set_thresh(unsigned long thresh)
5903{
5904 wq_watchdog_thresh = 0;
5905 del_timer_sync(&wq_watchdog_timer);
5906
5907 if (thresh) {
5908 wq_watchdog_thresh = thresh;
5909 wq_watchdog_reset_touched();
5910 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5911 }
5912}
5913
5914static int wq_watchdog_param_set_thresh(const char *val,
5915 const struct kernel_param *kp)
5916{
5917 unsigned long thresh;
5918 int ret;
5919
5920 ret = kstrtoul(val, 0, &thresh);
5921 if (ret)
5922 return ret;
5923
5924 if (system_wq)
5925 wq_watchdog_set_thresh(thresh);
5926 else
5927 wq_watchdog_thresh = thresh;
5928
5929 return 0;
5930}
5931
5932static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5933 .set = wq_watchdog_param_set_thresh,
5934 .get = param_get_ulong,
5935};
5936
5937module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5938 0644);
5939
5940static void wq_watchdog_init(void)
5941{
Kees Cook5cd79d62017-10-04 16:27:00 -07005942 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005943 wq_watchdog_set_thresh(wq_watchdog_thresh);
5944}
5945
5946#else /* CONFIG_WQ_WATCHDOG */
5947
5948static inline void wq_watchdog_init(void) { }
5949
5950#endif /* CONFIG_WQ_WATCHDOG */
5951
Tejun Heobce90382013-04-01 11:23:32 -07005952static void __init wq_numa_init(void)
5953{
5954 cpumask_var_t *tbl;
5955 int node, cpu;
5956
Tejun Heobce90382013-04-01 11:23:32 -07005957 if (num_possible_nodes() <= 1)
5958 return;
5959
Tejun Heod55262c2013-04-01 11:23:38 -07005960 if (wq_disable_numa) {
5961 pr_info("workqueue: NUMA affinity support disabled\n");
5962 return;
5963 }
5964
Zhen Leif728c4a92021-07-22 11:03:52 +08005965 for_each_possible_cpu(cpu) {
5966 if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) {
5967 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5968 return;
5969 }
5970 }
5971
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005972 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005973 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5974
Tejun Heobce90382013-04-01 11:23:32 -07005975 /*
5976 * We want masks of possible CPUs of each node which isn't readily
5977 * available. Build one from cpu_to_node() which should have been
5978 * fully initialized by now.
5979 */
Kees Cook6396bb22018-06-12 14:03:40 -07005980 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005981 BUG_ON(!tbl);
5982
5983 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005984 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005985 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005986
5987 for_each_possible_cpu(cpu) {
5988 node = cpu_to_node(cpu);
Tejun Heobce90382013-04-01 11:23:32 -07005989 cpumask_set_cpu(cpu, tbl[node]);
5990 }
5991
5992 wq_numa_possible_cpumask = tbl;
5993 wq_numa_enabled = true;
5994}
5995
Tejun Heo3347fa02016-09-16 15:49:32 -04005996/**
5997 * workqueue_init_early - early init for workqueue subsystem
5998 *
5999 * This is the first half of two-staged workqueue subsystem initialization
6000 * and invoked as soon as the bare basics - memory allocation, cpumasks and
6001 * idr are up. It sets up all the data structures and system workqueues
6002 * and allows early boot code to create workqueues and queue/cancel work
6003 * items. Actual work item execution starts only after kthreads can be
6004 * created and scheduled right before early initcalls.
6005 */
Yu Chen2333e822020-02-23 15:28:52 +08006006void __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006007{
Tejun Heo7a4e3442013-03-12 11:30:00 -07006008 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01006009 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07006010 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02006011
Lai Jiangshan10cdb152020-06-01 08:44:40 +00006012 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
Tejun Heoe904e6c2013-03-12 11:29:57 -07006013
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08006014 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01006015 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08006016
Tejun Heoe904e6c2013-03-12 11:29:57 -07006017 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
6018
Tejun Heo706026c2013-01-24 11:01:34 -08006019 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07006020 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07006021 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02006022
Tejun Heo7a4e3442013-03-12 11:30:00 -07006023 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07006024 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07006025 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08006026 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07006027 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07006028 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07006029 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07006030
Tejun Heo9daf9e62013-01-24 11:01:33 -08006031 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07006032 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08006033 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07006034 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07006035 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02006036 }
6037
Tejun Heo8a2b7532013-09-05 12:30:04 -04006038 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07006039 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
6040 struct workqueue_attrs *attrs;
6041
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02006042 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07006043 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07006044 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04006045
6046 /*
6047 * An ordered wq should have only one pwq as ordering is
6048 * guaranteed by max_active which is enforced by pwqs.
6049 * Turn off NUMA so that dfl_pwq is used for all nodes.
6050 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02006051 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04006052 attrs->nice = std_nice[i];
6053 attrs->no_numa = true;
6054 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07006055 }
6056
Tejun Heod320c032010-06-29 10:07:14 +02006057 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006058 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02006059 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02006060 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
6061 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01006062 system_freezable_wq = alloc_workqueue("events_freezable",
6063 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05306064 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
6065 WQ_POWER_EFFICIENT, 0);
6066 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
6067 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
6068 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006069 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05306070 !system_unbound_wq || !system_freezable_wq ||
6071 !system_power_efficient_wq ||
6072 !system_freezable_power_efficient_wq);
Tejun Heo3347fa02016-09-16 15:49:32 -04006073}
6074
6075/**
6076 * workqueue_init - bring workqueue subsystem fully online
6077 *
6078 * This is the latter half of two-staged workqueue subsystem initialization
6079 * and invoked as soon as kthreads can be created and scheduled.
6080 * Workqueues have been created and work items queued on them, but there
6081 * are no kworkers executing the work items yet. Populate the worker pools
6082 * with the initial workers and enable future kworker creations.
6083 */
Yu Chen2333e822020-02-23 15:28:52 +08006084void __init workqueue_init(void)
Tejun Heo3347fa02016-09-16 15:49:32 -04006085{
Tejun Heo2186d9f2016-10-19 12:01:27 -04006086 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04006087 struct worker_pool *pool;
6088 int cpu, bkt;
6089
Tejun Heo2186d9f2016-10-19 12:01:27 -04006090 /*
6091 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6092 * CPU to node mapping may not be available that early on some
6093 * archs such as power and arm64. As per-cpu pools created
6094 * previously could be missing node hint and unbound pools NUMA
6095 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08006096 *
6097 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006098 */
6099 wq_numa_init();
6100
6101 mutex_lock(&wq_pool_mutex);
6102
6103 for_each_possible_cpu(cpu) {
6104 for_each_cpu_worker_pool(pool, cpu) {
6105 pool->node = cpu_to_node(cpu);
6106 }
6107 }
6108
Tejun Heo40c17f72018-01-08 05:38:37 -08006109 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006110 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006111 WARN(init_rescuer(wq),
6112 "workqueue: failed to create early rescuer for %s",
6113 wq->name);
6114 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006115
6116 mutex_unlock(&wq_pool_mutex);
6117
Tejun Heo3347fa02016-09-16 15:49:32 -04006118 /* create the initial workers */
6119 for_each_online_cpu(cpu) {
6120 for_each_cpu_worker_pool(pool, cpu) {
6121 pool->flags &= ~POOL_DISASSOCIATED;
6122 BUG_ON(!create_worker(pool));
6123 }
6124 }
6125
6126 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6127 BUG_ON(!create_worker(pool));
6128
6129 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006130 wq_watchdog_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006131}