blob: 613917bbc4e733c1cd2e8bfd1b86e2f74f8859f5 [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
Tejun Heobd7bdd42012-07-12 14:46:37 -0700157 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700158
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800159 int nr_workers; /* L: total number of workers */
160 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700161
162 struct list_head idle_list; /* X: list of idle workers */
163 struct timer_list idle_timer; /* L: worker idle timeout */
164 struct timer_list mayday_timer; /* L: SOS timer for workers */
165
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700166 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800167 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
168 /* L: hash of busy workers */
169
Tejun Heo2607d7a2015-03-09 09:22:28 -0400170 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800171 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800172 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800174 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800175
Tejun Heo7a4e3442013-03-12 11:30:00 -0700176 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700177 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
178 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700179
Tejun Heoe19e3972013-01-24 11:39:44 -0800180 /*
181 * The current concurrency level. As it's likely to be accessed
182 * from other CPUs during try_to_wake_up(), put it in a separate
183 * cacheline.
184 */
185 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700186
187 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100188 * Destruction of pool is RCU protected to allow dereferences
Tejun Heo29c91e92013-03-12 11:30:03 -0700189 * from get_work_pool().
190 */
191 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200192} ____cacheline_aligned_in_smp;
193
194/*
Tejun Heo112202d2013-02-13 19:29:12 -0800195 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
196 * of work_struct->data are used for flags and the remaining high bits
197 * point to the pwq; thus, pwqs need to be aligned at two's power of the
198 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 */
Tejun Heo112202d2013-02-13 19:29:12 -0800200struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700201 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200202 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200203 int work_color; /* L: current color */
204 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700205 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200206 int nr_in_flight[WORK_NR_COLORS];
207 /* L: nr of in_flight works */
Lai Jiangshan018f3a12021-08-17 09:32:37 +0800208
209 /*
210 * nr_active management and WORK_STRUCT_INACTIVE:
211 *
212 * When pwq->nr_active >= max_active, new work item is queued to
213 * pwq->inactive_works instead of pool->worklist and marked with
214 * WORK_STRUCT_INACTIVE.
215 *
216 * All work items marked with WORK_STRUCT_INACTIVE do not participate
217 * in pwq->nr_active and all work items in pwq->inactive_works are
218 * marked with WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE
219 * work items are in pwq->inactive_works. Some of them are ready to
220 * run in pool->worklist or worker->scheduled. Those work itmes are
221 * only struct wq_barrier which is used for flush_work() and should
222 * not participate in pwq->nr_active. For non-barrier work item, it
223 * is marked with WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
224 */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200225 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200226 int max_active; /* L: max active works */
Lai Jiangshanf97a4a12021-08-17 09:32:34 +0800227 struct list_head inactive_works; /* L: inactive works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700228 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700229 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700230
231 /*
232 * Release of unbound pwq is punted to system_wq. See put_pwq()
233 * and pwq_unbound_release_workfn() for details. pool_workqueue
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100234 * itself is also RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700235 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700236 */
237 struct work_struct unbound_release_work;
238 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700239} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200242 * Structure used to wait for workqueue flush.
243 */
244struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct list_head list; /* WQ: list of flushers */
246 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200247 struct completion done; /* flush completion */
248};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Tejun Heo226223a2013-03-12 11:30:05 -0700250struct wq_device;
251
Tejun Heo73f53c42010-06-29 10:07:11 +0200252/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700253 * The externally visible workqueue. It relays the issued work items to
254 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 */
256struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700257 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400258 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200259
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700260 struct mutex mutex; /* protects this wq */
261 int work_color; /* WQ: current work color */
262 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800263 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700264 struct wq_flusher *first_flusher; /* WQ: first flusher */
265 struct list_head flusher_queue; /* WQ: flush waiters */
266 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200267
Tejun Heo2e109a22013-03-13 19:47:40 -0700268 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heo30ae2fc2019-09-20 14:09:14 -0700269 struct worker *rescuer; /* MD: rescue worker */
Tejun Heoe22bee72010-06-29 10:07:14 +0200270
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700271 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700272 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700273
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800274 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
275 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700276
Tejun Heo226223a2013-03-12 11:30:05 -0700277#ifdef CONFIG_SYSFS
278 struct wq_device *wq_dev; /* I: for sysfs interface */
279#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700280#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800281 char *lock_name;
282 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200283 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700284#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700285 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700286
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400287 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100288 * Destruction of workqueue_struct is RCU protected to allow walking
289 * the workqueues list without grabbing wq_pool_mutex.
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400290 * This is used to dump all workqueues from sysrq.
291 */
292 struct rcu_head rcu;
293
Tejun Heo2728fd22013-04-01 11:23:35 -0700294 /* hot fields used during command issue, aligned to cacheline */
295 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
296 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800297 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298};
299
Tejun Heoe904e6c2013-03-12 11:29:57 -0700300static struct kmem_cache *pwq_cache;
301
Tejun Heobce90382013-04-01 11:23:32 -0700302static cpumask_var_t *wq_numa_possible_cpumask;
303 /* possible CPUs of each node */
304
Tejun Heod55262c2013-04-01 11:23:38 -0700305static bool wq_disable_numa;
306module_param_named(disable_numa, wq_disable_numa, bool, 0444);
307
Viresh Kumarcee22a12013-04-08 16:45:40 +0530308/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930309static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530310module_param_named(power_efficient, wq_power_efficient, bool, 0444);
311
Tejun Heo863b7102016-09-16 15:49:34 -0400312static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400313
Tejun Heobce90382013-04-01 11:23:32 -0700314static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
315
Tejun Heo4c16bd32013-04-01 11:23:36 -0700316/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
317static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
318
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700319static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700320static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200321static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +0200322/* wait for manager to go away */
323static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
Tejun Heo5bcab332013-03-13 19:47:40 -0700324
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400325static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700326static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700327
Mike Galbraithef5571802016-02-09 17:59:38 -0500328/* PL: allowable cpus for unbound wqs and work items */
329static cpumask_var_t wq_unbound_cpumask;
330
331/* CPU where unbound work was last round robin scheduled from this CPU */
332static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800333
Tejun Heof303fccb2016-02-09 17:59:38 -0500334/*
335 * Local execution of unbound work items is no longer guaranteed. The
336 * following always forces round-robin CPU selection on unbound work items
337 * to uncover usages which depend on it.
338 */
339#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
340static bool wq_debug_force_rr_cpu = true;
341#else
342static bool wq_debug_force_rr_cpu = false;
343#endif
344module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
345
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700346/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700347static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700348
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700349static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700350
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700351/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700352static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
353
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700354/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700355static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
356
Tejun Heo8a2b7532013-09-05 12:30:04 -0400357/* I: attributes used when instantiating ordered pools on demand */
358static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
359
Tejun Heod320c032010-06-29 10:07:14 +0200360struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400361EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300362struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900363EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300364struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200365EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300366struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200367EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300368struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100369EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530370struct workqueue_struct *system_power_efficient_wq __read_mostly;
371EXPORT_SYMBOL_GPL(system_power_efficient_wq);
372struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
373EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200374
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700375static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800376static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heoc29eb852019-09-23 11:08:58 -0700377static void show_pwq(struct pool_workqueue *pwq);
Imran Khan55df0932021-10-20 14:09:00 +1100378static void show_one_worker_pool(struct worker_pool *pool);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700379
Tejun Heo97bd2342010-10-05 10:41:14 +0200380#define CREATE_TRACE_POINTS
381#include <trace/events/workqueue.h>
382
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700383#define assert_rcu_or_pool_mutex() \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100384 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700385 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100386 "RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700387
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800388#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100389 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700390 !lockdep_is_held(&wq->mutex) && \
391 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100392 "RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800393
Tejun Heof02ae732013-03-12 11:30:03 -0700394#define for_each_cpu_worker_pool(pool, cpu) \
395 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
396 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700397 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700398
Tejun Heo49e3cf42013-03-12 11:29:58 -0700399/**
Tejun Heo17116962013-03-12 11:29:58 -0700400 * for_each_pool - iterate through all worker_pools in the system
401 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700402 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700403 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100404 * This must be called either with wq_pool_mutex held or RCU read
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700405 * locked. If the pool needs to be used beyond the locking in effect, the
406 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700407 *
408 * The if/else clause exists only for the lockdep assertion and can be
409 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700410 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700411#define for_each_pool(pool, pi) \
412 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700413 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700414 else
Tejun Heo17116962013-03-12 11:29:58 -0700415
416/**
Tejun Heo822d8402013-03-19 13:45:21 -0700417 * for_each_pool_worker - iterate through all workers of a worker_pool
418 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700419 * @pool: worker_pool to iterate workers of
420 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700421 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700422 *
423 * The if/else clause exists only for the lockdep assertion and can be
424 * ignored.
425 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800426#define for_each_pool_worker(worker, pool) \
427 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700428 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700429 else
430
431/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700432 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
433 * @pwq: iteration cursor
434 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700435 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100436 * This must be called either with wq->mutex held or RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700437 * If the pwq needs to be used beyond the locking in effect, the caller is
438 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700439 *
440 * The if/else clause exists only for the lockdep assertion and can be
441 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700442 */
443#define for_each_pwq(pwq, wq) \
Sebastian Andrzej Siewior49e9d1a2019-11-15 19:01:25 +0100444 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
Joel Fernandes (Google)5a644662019-08-15 10:18:42 -0400445 lockdep_is_held(&(wq->mutex)))
Tejun Heof3421792010-07-02 10:03:51 +0200446
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900447#ifdef CONFIG_DEBUG_OBJECTS_WORK
448
Stephen Boydf9e62f32020-08-14 17:40:27 -0700449static const struct debug_obj_descr work_debug_descr;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900450
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100451static void *work_debug_hint(void *addr)
452{
453 return ((struct work_struct *) addr)->func;
454}
455
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700456static bool work_is_static_object(void *addr)
457{
458 struct work_struct *work = addr;
459
460 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
461}
462
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900463/*
464 * fixup_init is called when:
465 * - an active object is initialized
466 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700467static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900468{
469 struct work_struct *work = addr;
470
471 switch (state) {
472 case ODEBUG_STATE_ACTIVE:
473 cancel_work_sync(work);
474 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700475 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900476 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 }
479}
480
481/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900482 * fixup_free is called when:
483 * - an active object is freed
484 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700485static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900486{
487 struct work_struct *work = addr;
488
489 switch (state) {
490 case ODEBUG_STATE_ACTIVE:
491 cancel_work_sync(work);
492 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700493 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900494 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700495 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900496 }
497}
498
Stephen Boydf9e62f32020-08-14 17:40:27 -0700499static const struct debug_obj_descr work_debug_descr = {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900500 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100501 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700502 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900503 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900504 .fixup_free = work_fixup_free,
505};
506
507static inline void debug_work_activate(struct work_struct *work)
508{
509 debug_object_activate(work, &work_debug_descr);
510}
511
512static inline void debug_work_deactivate(struct work_struct *work)
513{
514 debug_object_deactivate(work, &work_debug_descr);
515}
516
517void __init_work(struct work_struct *work, int onstack)
518{
519 if (onstack)
520 debug_object_init_on_stack(work, &work_debug_descr);
521 else
522 debug_object_init(work, &work_debug_descr);
523}
524EXPORT_SYMBOL_GPL(__init_work);
525
526void destroy_work_on_stack(struct work_struct *work)
527{
528 debug_object_free(work, &work_debug_descr);
529}
530EXPORT_SYMBOL_GPL(destroy_work_on_stack);
531
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000532void destroy_delayed_work_on_stack(struct delayed_work *work)
533{
534 destroy_timer_on_stack(&work->timer);
535 debug_object_free(&work->work, &work_debug_descr);
536}
537EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
538
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900539#else
540static inline void debug_work_activate(struct work_struct *work) { }
541static inline void debug_work_deactivate(struct work_struct *work) { }
542#endif
543
Li Bin4e8b22b2013-09-10 09:52:35 +0800544/**
Cai Huoqing67dc8322021-07-31 08:01:29 +0800545 * worker_pool_assign_id - allocate ID and assign it to @pool
Li Bin4e8b22b2013-09-10 09:52:35 +0800546 * @pool: the pool pointer of interest
547 *
548 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
549 * successfully, -errno on failure.
550 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800551static int worker_pool_assign_id(struct worker_pool *pool)
552{
553 int ret;
554
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700555 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700556
Li Bin4e8b22b2013-09-10 09:52:35 +0800557 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
558 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700559 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700560 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700561 return 0;
562 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800563 return ret;
564}
565
Tejun Heo76af4d92013-03-12 11:30:00 -0700566/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700567 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
568 * @wq: the target workqueue
569 * @node: the node ID
570 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100571 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800572 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700573 * If the pwq needs to be used beyond the locking in effect, the caller is
574 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700575 *
576 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700577 */
578static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
579 int node)
580{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800581 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500582
583 /*
584 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
585 * delayed item is pending. The plan is to keep CPU -> NODE
586 * mapping valid and stable across CPU on/offlines. Once that
587 * happens, this workaround can be removed.
588 */
589 if (unlikely(node == NUMA_NO_NODE))
590 return wq->dfl_pwq;
591
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700592 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
593}
594
Tejun Heo73f53c42010-06-29 10:07:11 +0200595static unsigned int work_color_to_flags(int color)
596{
597 return color << WORK_STRUCT_COLOR_SHIFT;
598}
599
Lai Jiangshanc4560c22021-08-17 09:32:35 +0800600static int get_work_color(unsigned long work_data)
Tejun Heo73f53c42010-06-29 10:07:11 +0200601{
Lai Jiangshanc4560c22021-08-17 09:32:35 +0800602 return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
Tejun Heo73f53c42010-06-29 10:07:11 +0200603 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
604}
605
606static int work_next_color(int color)
607{
608 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700609}
610
David Howells4594bf12006-12-07 11:33:26 +0000611/*
Tejun Heo112202d2013-02-13 19:29:12 -0800612 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
613 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800614 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200615 *
Tejun Heo112202d2013-02-13 19:29:12 -0800616 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
617 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700618 * work->data. These functions should only be called while the work is
619 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200620 *
Tejun Heo112202d2013-02-13 19:29:12 -0800621 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800622 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800623 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800624 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700625 *
626 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
627 * canceled. While being canceled, a work item may have its PENDING set
628 * but stay off timer and worklist for arbitrarily long and nobody should
629 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000630 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200631static inline void set_work_data(struct work_struct *work, unsigned long data,
632 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000633{
Tejun Heo6183c002013-03-12 11:29:57 -0700634 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200635 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000636}
David Howells365970a2006-11-22 14:54:49 +0000637
Tejun Heo112202d2013-02-13 19:29:12 -0800638static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200639 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200640{
Tejun Heo112202d2013-02-13 19:29:12 -0800641 set_work_data(work, (unsigned long)pwq,
642 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200643}
644
Lai Jiangshan4468a002013-02-06 18:04:53 -0800645static void set_work_pool_and_keep_pending(struct work_struct *work,
646 int pool_id)
647{
648 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
649 WORK_STRUCT_PENDING);
650}
651
Tejun Heo7c3eed52013-01-24 11:01:33 -0800652static void set_work_pool_and_clear_pending(struct work_struct *work,
653 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000654{
Tejun Heo23657bb2012-08-13 17:08:19 -0700655 /*
656 * The following wmb is paired with the implied mb in
657 * test_and_set_bit(PENDING) and ensures all updates to @work made
658 * here are visible to and precede any updates by the next PENDING
659 * owner.
660 */
661 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800662 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200663 /*
664 * The following mb guarantees that previous clear of a PENDING bit
665 * will not be reordered with any speculative LOADS or STORES from
666 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800667 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200668 * the same @work. E.g. consider this case:
669 *
670 * CPU#0 CPU#1
671 * ---------------------------- --------------------------------
672 *
673 * 1 STORE event_indicated
674 * 2 queue_work_on() {
675 * 3 test_and_set_bit(PENDING)
676 * 4 } set_..._and_clear_pending() {
677 * 5 set_work_data() # clear bit
678 * 6 smp_mb()
679 * 7 work->current_func() {
680 * 8 LOAD event_indicated
681 * }
682 *
683 * Without an explicit full barrier speculative LOAD on line 8 can
684 * be executed before CPU#0 does STORE on line 1. If that happens,
685 * CPU#0 observes the PENDING bit is still set and new execution of
686 * a @work is not queued in a hope, that CPU#1 will eventually
687 * finish the queued @work. Meanwhile CPU#1 does not see
688 * event_indicated is set, because speculative LOAD was executed
689 * before actual STORE.
690 */
691 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200692}
693
694static void clear_work_data(struct work_struct *work)
695{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800696 smp_wmb(); /* see set_work_pool_and_clear_pending() */
697 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200698}
699
Tejun Heo112202d2013-02-13 19:29:12 -0800700static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200701{
Tejun Heoe1201532010-07-22 14:14:25 +0200702 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200703
Tejun Heo112202d2013-02-13 19:29:12 -0800704 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200705 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
706 else
707 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200708}
709
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710/**
711 * get_work_pool - return the worker_pool a given work was associated with
712 * @work: the work item of interest
713 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700714 * Pools are created and destroyed under wq_pool_mutex, and allows read
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100715 * access under RCU read lock. As such, this function should be
716 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700717 *
718 * All fields of the returned pool are accessible as long as the above
719 * mentioned locking is in effect. If the returned pool needs to be used
720 * beyond the critical section, the caller is responsible for ensuring the
721 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700722 *
723 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800724 */
725static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200726{
Tejun Heoe1201532010-07-22 14:14:25 +0200727 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800728 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200729
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700730 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700731
Tejun Heo112202d2013-02-13 19:29:12 -0800732 if (data & WORK_STRUCT_PWQ)
733 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800734 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200735
Tejun Heo7c3eed52013-01-24 11:01:33 -0800736 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
737 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200738 return NULL;
739
Tejun Heofa1b54e2013-03-12 11:30:00 -0700740 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800741}
742
743/**
744 * get_work_pool_id - return the worker pool ID a given work is associated with
745 * @work: the work item of interest
746 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700747 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800748 * %WORK_OFFQ_POOL_NONE if none.
749 */
750static int get_work_pool_id(struct work_struct *work)
751{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800752 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800753
Tejun Heo112202d2013-02-13 19:29:12 -0800754 if (data & WORK_STRUCT_PWQ)
755 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800756 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
757
758 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800759}
760
Tejun Heobbb68df2012-08-03 10:30:46 -0700761static void mark_work_canceling(struct work_struct *work)
762{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800763 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700764
Tejun Heo7c3eed52013-01-24 11:01:33 -0800765 pool_id <<= WORK_OFFQ_POOL_SHIFT;
766 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700767}
768
769static bool work_is_canceling(struct work_struct *work)
770{
771 unsigned long data = atomic_long_read(&work->data);
772
Tejun Heo112202d2013-02-13 19:29:12 -0800773 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700774}
775
David Howells365970a2006-11-22 14:54:49 +0000776/*
Tejun Heo32704762012-07-13 22:16:45 -0700777 * Policy functions. These define the policies on how the global worker
778 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800779 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000780 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200781
Tejun Heo63d95a92012-07-12 14:46:37 -0700782static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000783{
Tejun Heoe19e3972013-01-24 11:39:44 -0800784 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000785}
786
Tejun Heoe22bee72010-06-29 10:07:14 +0200787/*
788 * Need to wake up a worker? Called from anything but currently
789 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700790 *
791 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800792 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700793 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200794 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700795static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000796{
Tejun Heo63d95a92012-07-12 14:46:37 -0700797 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000798}
799
Tejun Heoe22bee72010-06-29 10:07:14 +0200800/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700801static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200802{
Tejun Heo63d95a92012-07-12 14:46:37 -0700803 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200804}
805
806/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700807static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200808{
Tejun Heoe19e3972013-01-24 11:39:44 -0800809 return !list_empty(&pool->worklist) &&
810 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200811}
812
813/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700814static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200815{
Tejun Heo63d95a92012-07-12 14:46:37 -0700816 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200817}
818
Tejun Heoe22bee72010-06-29 10:07:14 +0200819/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700820static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200821{
Tejun Heo692b4822017-10-09 08:04:13 -0700822 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
824 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200825
826 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
827}
828
829/*
830 * Wake up functions.
831 */
832
Lai Jiangshan1037de32014-05-22 16:44:07 +0800833/* Return the first idle worker. Safe with preemption disabled */
834static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200835{
Tejun Heo63d95a92012-07-12 14:46:37 -0700836 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200837 return NULL;
838
Tejun Heo63d95a92012-07-12 14:46:37 -0700839 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200840}
841
842/**
843 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700844 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200845 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700846 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200847 *
848 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200849 * raw_spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200850 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700851static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200852{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800853 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200854
855 if (likely(worker))
856 wake_up_process(worker->task);
857}
858
Tejun Heo4690c4a2010-06-29 10:07:10 +0200859/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100860 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200861 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200862 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100863 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200864 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100865void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200866{
867 struct worker *worker = kthread_data(task);
868
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100869 if (!worker->sleeping)
870 return;
871 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800872 atomic_inc(&worker->pool->nr_running);
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100873 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200874}
875
876/**
877 * wq_worker_sleeping - a worker is going to sleep
878 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200879 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100880 * This function is called from schedule() when a busy worker is
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100881 * going to sleep. Preemption needs to be disabled to protect ->sleeping
882 * assignment.
Tejun Heoe22bee72010-06-29 10:07:14 +0200883 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100884void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200885{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100886 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800887 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200888
Tejun Heo111c2252013-01-17 17:16:24 -0800889 /*
890 * Rescuers, which may not have all the fields set up like normal
891 * workers, also reach here, let's not access anything before
892 * checking NOT_RUNNING.
893 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500894 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100895 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200896
Tejun Heo111c2252013-01-17 17:16:24 -0800897 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800898
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100899 /* Return if preempted before wq_worker_running() was reached */
900 if (worker->sleeping)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100901 return;
902
903 worker->sleeping = 1;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200904 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200905
906 /*
907 * The counterpart of the following dec_and_test, implied mb,
908 * worklist not empty test sequence is in insert_work().
909 * Please read comment there.
910 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700911 * NOT_RUNNING is clear. This means that we're bound to and
912 * running on the local cpu w/ rq lock held and preemption
913 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800914 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700915 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200916 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800917 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100918 !list_empty(&pool->worklist)) {
919 next = first_idle_worker(pool);
920 if (next)
921 wake_up_process(next->task);
922 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200923 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200924}
925
926/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800927 * wq_worker_last_func - retrieve worker's last work function
Bart Van Assche8194fe92019-03-19 10:45:09 -0700928 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800929 *
930 * Determine the last function a worker executed. This is called from
931 * the scheduler to get a worker's last known identity.
932 *
933 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200934 * raw_spin_lock_irq(rq->lock)
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800935 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800936 * This function is called during schedule() when a kworker is going
937 * to sleep. It's used by psi to identify aggregation workers during
938 * dequeuing, to allow periodic aggregation to shut-off when that
939 * worker is the last task in the system or cgroup to go to sleep.
940 *
941 * As this function doesn't involve any workqueue-related locking, it
942 * only returns stable values when called from inside the scheduler's
943 * queuing and dequeuing paths, when @task, which must be a kworker,
944 * is guaranteed to not be processing any works.
945 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800946 * Return:
947 * The last work function %current executed as a worker, NULL if it
948 * hasn't executed any work yet.
949 */
950work_func_t wq_worker_last_func(struct task_struct *task)
951{
952 struct worker *worker = kthread_data(task);
953
954 return worker->last_func;
955}
956
957/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200958 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200959 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200960 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200961 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800962 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200963 *
Tejun Heocb444762010-07-02 10:03:50 +0200964 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200965 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200966 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800967static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200968{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700969 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200970
Tejun Heocb444762010-07-02 10:03:50 +0200971 WARN_ON_ONCE(worker->task != current);
972
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800973 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200974 if ((flags & WORKER_NOT_RUNNING) &&
975 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800976 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200977 }
978
Tejun Heod302f012010-06-29 10:07:13 +0200979 worker->flags |= flags;
980}
981
982/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200983 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200984 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200985 * @flags: flags to clear
986 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200987 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200988 *
Tejun Heocb444762010-07-02 10:03:50 +0200989 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200990 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200991 */
992static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
993{
Tejun Heo63d95a92012-07-12 14:46:37 -0700994 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200995 unsigned int oflags = worker->flags;
996
Tejun Heocb444762010-07-02 10:03:50 +0200997 WARN_ON_ONCE(worker->task != current);
998
Tejun Heod302f012010-06-29 10:07:13 +0200999 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +02001000
Tejun Heo42c025f2011-01-11 15:58:49 +01001001 /*
1002 * If transitioning out of NOT_RUNNING, increment nr_running. Note
1003 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
1004 * of multiple flags, not a single flag.
1005 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001006 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1007 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -08001008 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +02001009}
1010
1011/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001012 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001013 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001014 * @work: work to find worker for
1015 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001016 * Find a worker which is executing @work on @pool by searching
1017 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001018 * to match, its current execution should match the address of @work and
1019 * its work function. This is to avoid unwanted dependency between
1020 * unrelated work executions through a work item being recycled while still
1021 * being executed.
1022 *
1023 * This is a bit tricky. A work item may be freed once its execution
1024 * starts and nothing prevents the freed area from being recycled for
1025 * another work item. If the same work item address ends up being reused
1026 * before the original execution finishes, workqueue will identify the
1027 * recycled work item as currently executing and make it wait until the
1028 * current execution finishes, introducing an unwanted dependency.
1029 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001030 * This function checks the work item address and work function to avoid
1031 * false positives. Note that this isn't complete as one may construct a
1032 * work function which can introduce dependency onto itself through a
1033 * recycled work item. Well, if somebody wants to shoot oneself in the
1034 * foot that badly, there's only so much we can do, and if such deadlock
1035 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001036 *
1037 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001038 * raw_spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001039 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001040 * Return:
1041 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001042 * otherwise.
1043 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001044static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001045 struct work_struct *work)
1046{
Sasha Levin42f85702012-12-17 10:01:23 -05001047 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001048
Sasha Levinb67bfe02013-02-27 17:06:00 -08001049 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001050 (unsigned long)work)
1051 if (worker->current_work == work &&
1052 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001053 return worker;
1054
1055 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001056}
1057
1058/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001059 * move_linked_works - move linked works to a list
1060 * @work: start of series of works to be scheduled
1061 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301062 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001063 *
1064 * Schedule linked works starting from @work to @head. Work series to
1065 * be scheduled starts at @work and includes any consecutive work with
1066 * WORK_STRUCT_LINKED set in its predecessor.
1067 *
1068 * If @nextp is not NULL, it's updated to point to the next work of
1069 * the last scheduled work. This allows move_linked_works() to be
1070 * nested inside outer list_for_each_entry_safe().
1071 *
1072 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001073 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001074 */
1075static void move_linked_works(struct work_struct *work, struct list_head *head,
1076 struct work_struct **nextp)
1077{
1078 struct work_struct *n;
1079
1080 /*
1081 * Linked worklist will always end before the end of the list,
1082 * use NULL for list head.
1083 */
1084 list_for_each_entry_safe_from(work, n, NULL, entry) {
1085 list_move_tail(&work->entry, head);
1086 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1087 break;
1088 }
1089
1090 /*
1091 * If we're already inside safe list traversal and have moved
1092 * multiple works to the scheduled queue, the next position
1093 * needs to be updated.
1094 */
1095 if (nextp)
1096 *nextp = n;
1097}
1098
Tejun Heo8864b4e2013-03-12 11:30:04 -07001099/**
1100 * get_pwq - get an extra reference on the specified pool_workqueue
1101 * @pwq: pool_workqueue to get
1102 *
1103 * Obtain an extra reference on @pwq. The caller should guarantee that
1104 * @pwq has positive refcnt and be holding the matching pool->lock.
1105 */
1106static void get_pwq(struct pool_workqueue *pwq)
1107{
1108 lockdep_assert_held(&pwq->pool->lock);
1109 WARN_ON_ONCE(pwq->refcnt <= 0);
1110 pwq->refcnt++;
1111}
1112
1113/**
1114 * put_pwq - put a pool_workqueue reference
1115 * @pwq: pool_workqueue to put
1116 *
1117 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1118 * destruction. The caller should be holding the matching pool->lock.
1119 */
1120static void put_pwq(struct pool_workqueue *pwq)
1121{
1122 lockdep_assert_held(&pwq->pool->lock);
1123 if (likely(--pwq->refcnt))
1124 return;
1125 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1126 return;
1127 /*
1128 * @pwq can't be released under pool->lock, bounce to
1129 * pwq_unbound_release_workfn(). This never recurses on the same
1130 * pool->lock as this path is taken only for unbound workqueues and
1131 * the release work item is scheduled on a per-cpu workqueue. To
1132 * avoid lockdep warning, unbound pool->locks are given lockdep
1133 * subclass of 1 in get_unbound_pool().
1134 */
1135 schedule_work(&pwq->unbound_release_work);
1136}
1137
Tejun Heodce90d42013-04-01 11:23:35 -07001138/**
1139 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1140 * @pwq: pool_workqueue to put (can be %NULL)
1141 *
1142 * put_pwq() with locking. This function also allows %NULL @pwq.
1143 */
1144static void put_pwq_unlocked(struct pool_workqueue *pwq)
1145{
1146 if (pwq) {
1147 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001148 * As both pwqs and pools are RCU protected, the
Tejun Heodce90d42013-04-01 11:23:35 -07001149 * following lock operations are safe.
1150 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001151 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001152 put_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001153 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001154 }
1155}
1156
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001157static void pwq_activate_inactive_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001158{
Tejun Heo112202d2013-02-13 19:29:12 -08001159 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001160
1161 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001162 if (list_empty(&pwq->pool->worklist))
1163 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001164 move_linked_works(work, &pwq->pool->worklist, NULL);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001165 __clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001166 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001167}
1168
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001169static void pwq_activate_first_inactive(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001170{
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001171 struct work_struct *work = list_first_entry(&pwq->inactive_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001172 struct work_struct, entry);
1173
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001174 pwq_activate_inactive_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001175}
1176
Tejun Heobf4ede02012-08-03 10:30:46 -07001177/**
Tejun Heo112202d2013-02-13 19:29:12 -08001178 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1179 * @pwq: pwq of interest
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001180 * @work_data: work_data of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001181 *
1182 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001183 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001184 *
1185 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001186 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001187 */
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001188static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
Tejun Heobf4ede02012-08-03 10:30:46 -07001189{
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001190 int color = get_work_color(work_data);
1191
Lai Jiangshan018f3a12021-08-17 09:32:37 +08001192 if (!(work_data & WORK_STRUCT_INACTIVE)) {
1193 pwq->nr_active--;
1194 if (!list_empty(&pwq->inactive_works)) {
1195 /* one down, submit an inactive one */
1196 if (pwq->nr_active < pwq->max_active)
1197 pwq_activate_first_inactive(pwq);
1198 }
1199 }
1200
Tejun Heo112202d2013-02-13 19:29:12 -08001201 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001202
Tejun Heobf4ede02012-08-03 10:30:46 -07001203 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001204 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001205 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001206
1207 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001208 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001209 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001210
Tejun Heo112202d2013-02-13 19:29:12 -08001211 /* this pwq is done, clear flush_color */
1212 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001213
1214 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001215 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001216 * will handle the rest.
1217 */
Tejun Heo112202d2013-02-13 19:29:12 -08001218 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1219 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001220out_put:
1221 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001222}
1223
Tejun Heo36e227d2012-08-03 10:30:46 -07001224/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001225 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001226 * @work: work item to steal
1227 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001228 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001229 *
1230 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001231 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001232 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001233 * Return:
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001234 *
1235 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001236 * 1 if @work was pending and we successfully stole PENDING
1237 * 0 if @work was idle and we claimed PENDING
1238 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001239 * -ENOENT if someone else is canceling @work, this state may persist
1240 * for arbitrarily long
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001241 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001242 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001243 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001244 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001245 * interrupted while holding PENDING and @work off queue, irq must be
1246 * disabled on entry. This, combined with delayed_work->timer being
1247 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001248 *
1249 * On successful return, >= 0, irq is disabled and the caller is
1250 * responsible for releasing it using local_irq_restore(*@flags).
1251 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001252 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001253 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001254static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1255 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001256{
Tejun Heod565ed62013-01-24 11:01:33 -08001257 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001258 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001259
Tejun Heobbb68df2012-08-03 10:30:46 -07001260 local_irq_save(*flags);
1261
Tejun Heo36e227d2012-08-03 10:30:46 -07001262 /* try to steal the timer if it exists */
1263 if (is_dwork) {
1264 struct delayed_work *dwork = to_delayed_work(work);
1265
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001266 /*
1267 * dwork->timer is irqsafe. If del_timer() fails, it's
1268 * guaranteed that the timer is not queued anywhere and not
1269 * running on the local CPU.
1270 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001271 if (likely(del_timer(&dwork->timer)))
1272 return 1;
1273 }
1274
1275 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001276 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1277 return 0;
1278
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001279 rcu_read_lock();
Tejun Heobf4ede02012-08-03 10:30:46 -07001280 /*
1281 * The queueing is in progress, or it is already queued. Try to
1282 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1283 */
Tejun Heod565ed62013-01-24 11:01:33 -08001284 pool = get_work_pool(work);
1285 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001286 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001287
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001288 raw_spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001289 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001290 * work->data is guaranteed to point to pwq only while the work
1291 * item is queued on pwq->wq, and both updating work->data to point
1292 * to pwq on queueing and to pool on dequeueing are done under
1293 * pwq->pool->lock. This in turn guarantees that, if work->data
1294 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001295 * item is currently queued on that pool.
1296 */
Tejun Heo112202d2013-02-13 19:29:12 -08001297 pwq = get_work_pwq(work);
1298 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001299 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001300
Tejun Heo16062832013-02-06 18:04:53 -08001301 /*
Lai Jiangshan018f3a12021-08-17 09:32:37 +08001302 * A cancelable inactive work item must be in the
1303 * pwq->inactive_works since a queued barrier can't be
1304 * canceled (see the comments in insert_wq_barrier()).
1305 *
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001306 * An inactive work item cannot be grabbed directly because
Lai Jiangshand8127962021-08-17 09:32:38 +08001307 * it might have linked barrier work items which, if left
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001308 * on the inactive_works list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001309 * management later on and cause stall. Make sure the work
1310 * item is activated before grabbing.
1311 */
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001312 if (*work_data_bits(work) & WORK_STRUCT_INACTIVE)
1313 pwq_activate_inactive_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001314
Tejun Heo16062832013-02-06 18:04:53 -08001315 list_del_init(&work->entry);
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001316 pwq_dec_nr_in_flight(pwq, *work_data_bits(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001317
Tejun Heo112202d2013-02-13 19:29:12 -08001318 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001319 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001320
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001321 raw_spin_unlock(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001322 rcu_read_unlock();
Tejun Heo16062832013-02-06 18:04:53 -08001323 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001324 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001325 raw_spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001326fail:
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001327 rcu_read_unlock();
Tejun Heobbb68df2012-08-03 10:30:46 -07001328 local_irq_restore(*flags);
1329 if (work_is_canceling(work))
1330 return -ENOENT;
1331 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001332 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001333}
1334
1335/**
Tejun Heo706026c2013-01-24 11:01:34 -08001336 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001337 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001338 * @work: work to insert
1339 * @head: insertion point
1340 * @extra_flags: extra WORK_STRUCT_* flags to set
1341 *
Tejun Heo112202d2013-02-13 19:29:12 -08001342 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001343 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001344 *
1345 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001346 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001347 */
Tejun Heo112202d2013-02-13 19:29:12 -08001348static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1349 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001350{
Tejun Heo112202d2013-02-13 19:29:12 -08001351 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001352
Walter Wue89a85d2020-12-14 19:09:09 -08001353 /* record the work call stack in order to print it in KASAN reports */
Marco Elverf70da742021-11-05 13:35:50 -07001354 kasan_record_aux_stack_noalloc(work);
Walter Wue89a85d2020-12-14 19:09:09 -08001355
Tejun Heo4690c4a2010-06-29 10:07:10 +02001356 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001357 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001358 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001359 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001360
1361 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001362 * Ensure either wq_worker_sleeping() sees the above
1363 * list_add_tail() or we see zero nr_running to avoid workers lying
1364 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001365 */
1366 smp_mb();
1367
Tejun Heo63d95a92012-07-12 14:46:37 -07001368 if (__need_more_worker(pool))
1369 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001370}
1371
Tejun Heoc8efcc22010-12-20 19:32:04 +01001372/*
1373 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001374 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001375 */
1376static bool is_chained_work(struct workqueue_struct *wq)
1377{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001378 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001379
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001380 worker = current_wq_worker();
1381 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001382 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001383 * I'm @worker, it's safe to dereference it without locking.
1384 */
Tejun Heo112202d2013-02-13 19:29:12 -08001385 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001386}
1387
Mike Galbraithef5571802016-02-09 17:59:38 -05001388/*
1389 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1390 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1391 * avoid perturbing sensitive tasks.
1392 */
1393static int wq_select_unbound_cpu(int cpu)
1394{
Tejun Heof303fccb2016-02-09 17:59:38 -05001395 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001396 int new_cpu;
1397
Tejun Heof303fccb2016-02-09 17:59:38 -05001398 if (likely(!wq_debug_force_rr_cpu)) {
1399 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1400 return cpu;
1401 } else if (!printed_dbg_warning) {
1402 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1403 printed_dbg_warning = true;
1404 }
1405
Mike Galbraithef5571802016-02-09 17:59:38 -05001406 if (cpumask_empty(wq_unbound_cpumask))
1407 return cpu;
1408
1409 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1410 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1411 if (unlikely(new_cpu >= nr_cpu_ids)) {
1412 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1413 if (unlikely(new_cpu >= nr_cpu_ids))
1414 return cpu;
1415 }
1416 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1417
1418 return new_cpu;
1419}
1420
Tejun Heod84ff052013-03-12 11:29:59 -07001421static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 struct work_struct *work)
1423{
Tejun Heo112202d2013-02-13 19:29:12 -08001424 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001425 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001426 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001427 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001428 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001429
1430 /*
1431 * While a work item is PENDING && off queue, a task trying to
1432 * steal the PENDING will busy-loop waiting for it to either get
1433 * queued or lose PENDING. Grabbing PENDING and queueing should
1434 * happen with IRQ disabled.
1435 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001436 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001438
Li Bin9ef28a72013-09-09 13:13:58 +08001439 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001440 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001441 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001442 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001443 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001444retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001445 /* pwq which will be used unless @work is executing elsewhere */
Hillf Dantonaa202f12020-01-24 20:14:45 -05001446 if (wq->flags & WQ_UNBOUND) {
1447 if (req_cpu == WORK_CPU_UNBOUND)
1448 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001449 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Dantonaa202f12020-01-24 20:14:45 -05001450 } else {
1451 if (req_cpu == WORK_CPU_UNBOUND)
1452 cpu = raw_smp_processor_id();
1453 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1454 }
Tejun Heodbf25762012-08-20 14:51:23 -07001455
Tejun Heoc9178082013-03-12 11:30:04 -07001456 /*
1457 * If @work was previously on a different pool, it might still be
1458 * running there, in which case the work needs to be queued on that
1459 * pool to guarantee non-reentrancy.
1460 */
1461 last_pool = get_work_pool(work);
1462 if (last_pool && last_pool != pwq->pool) {
1463 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001464
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001465 raw_spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001466
Tejun Heoc9178082013-03-12 11:30:04 -07001467 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001468
Tejun Heoc9178082013-03-12 11:30:04 -07001469 if (worker && worker->current_pwq->wq == wq) {
1470 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001471 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001472 /* meh... not running there, queue here */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001473 raw_spin_unlock(&last_pool->lock);
1474 raw_spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001475 }
Tejun Heof3421792010-07-02 10:03:51 +02001476 } else {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001477 raw_spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001478 }
1479
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001480 /*
1481 * pwq is determined and locked. For unbound pools, we could have
1482 * raced with pwq release and it could already be dead. If its
1483 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001484 * without another pwq replacing it in the numa_pwq_tbl or while
1485 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001486 * make forward-progress.
1487 */
1488 if (unlikely(!pwq->refcnt)) {
1489 if (wq->flags & WQ_UNBOUND) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001490 raw_spin_unlock(&pwq->pool->lock);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001491 cpu_relax();
1492 goto retry;
1493 }
1494 /* oops */
1495 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1496 wq->name, cpu);
1497 }
1498
Tejun Heo112202d2013-02-13 19:29:12 -08001499 /* pwq determined, queue */
1500 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001501
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001502 if (WARN_ON(!list_empty(&work->entry)))
1503 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001504
Tejun Heo112202d2013-02-13 19:29:12 -08001505 pwq->nr_in_flight[pwq->work_color]++;
1506 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001507
Tejun Heo112202d2013-02-13 19:29:12 -08001508 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001509 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001510 pwq->nr_active++;
1511 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001512 if (list_empty(worklist))
1513 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001514 } else {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001515 work_flags |= WORK_STRUCT_INACTIVE;
1516 worklist = &pwq->inactive_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001517 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001518
Zqiang0687c662021-02-18 11:16:49 +08001519 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001520 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001521
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001522out:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001523 raw_spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001524 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525}
1526
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001527/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001528 * queue_work_on - queue work on specific cpu
1529 * @cpu: CPU number to execute work on
1530 * @wq: workqueue to use
1531 * @work: work to queue
1532 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001533 * We queue the work to a specific CPU, the caller must ensure it
1534 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001535 *
1536 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001537 */
Tejun Heod4283e92012-08-03 10:30:44 -07001538bool queue_work_on(int cpu, struct workqueue_struct *wq,
1539 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001540{
Tejun Heod4283e92012-08-03 10:30:44 -07001541 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001542 unsigned long flags;
1543
1544 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001545
Tejun Heo22df02b2010-06-29 10:07:10 +02001546 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001547 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001548 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001549 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001550
1551 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001552 return ret;
1553}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001554EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001555
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001556/**
1557 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1558 * @node: NUMA node ID that we want to select a CPU from
1559 *
1560 * This function will attempt to find a "random" cpu available on a given
1561 * node. If there are no CPUs available on the given node it will return
1562 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1563 * available CPU if we need to schedule this work.
1564 */
1565static int workqueue_select_cpu_near(int node)
1566{
1567 int cpu;
1568
1569 /* No point in doing this if NUMA isn't enabled for workqueues */
1570 if (!wq_numa_enabled)
1571 return WORK_CPU_UNBOUND;
1572
1573 /* Delay binding to CPU if node is not valid or online */
1574 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1575 return WORK_CPU_UNBOUND;
1576
1577 /* Use local node/cpu if we are already there */
1578 cpu = raw_smp_processor_id();
1579 if (node == cpu_to_node(cpu))
1580 return cpu;
1581
1582 /* Use "random" otherwise know as "first" online CPU of node */
1583 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1584
1585 /* If CPU is valid return that, otherwise just defer */
1586 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1587}
1588
1589/**
1590 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1591 * @node: NUMA node that we are targeting the work for
1592 * @wq: workqueue to use
1593 * @work: work to queue
1594 *
1595 * We queue the work to a "random" CPU within a given NUMA node. The basic
1596 * idea here is to provide a way to somehow associate work with a given
1597 * NUMA node.
1598 *
1599 * This function will only make a best effort attempt at getting this onto
1600 * the right NUMA node. If no node is requested or the requested node is
1601 * offline then we just fall back to standard queue_work behavior.
1602 *
1603 * Currently the "random" CPU ends up being the first available CPU in the
1604 * intersection of cpu_online_mask and the cpumask of the node, unless we
1605 * are running on the node. In that case we just use the current CPU.
1606 *
1607 * Return: %false if @work was already on a queue, %true otherwise.
1608 */
1609bool queue_work_node(int node, struct workqueue_struct *wq,
1610 struct work_struct *work)
1611{
1612 unsigned long flags;
1613 bool ret = false;
1614
1615 /*
1616 * This current implementation is specific to unbound workqueues.
1617 * Specifically we only return the first available CPU for a given
1618 * node instead of cycling through individual CPUs within the node.
1619 *
1620 * If this is used with a per-cpu workqueue then the logic in
1621 * workqueue_select_cpu_near would need to be updated to allow for
1622 * some round robin type logic.
1623 */
1624 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1625
1626 local_irq_save(flags);
1627
1628 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1629 int cpu = workqueue_select_cpu_near(node);
1630
1631 __queue_work(cpu, wq, work);
1632 ret = true;
1633 }
1634
1635 local_irq_restore(flags);
1636 return ret;
1637}
1638EXPORT_SYMBOL_GPL(queue_work_node);
1639
Kees Cook8c20feb2017-10-04 16:27:07 -07001640void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641{
Kees Cook8c20feb2017-10-04 16:27:07 -07001642 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001644 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001645 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001647EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001649static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1650 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001652 struct timer_list *timer = &dwork->timer;
1653 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Tejun Heo637fdba2017-03-06 15:33:42 -05001655 WARN_ON_ONCE(!wq);
Sami Tolvanen98173112021-04-08 11:28:30 -07001656 WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001657 WARN_ON_ONCE(timer_pending(timer));
1658 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001659
Tejun Heo8852aac2012-12-01 16:23:42 -08001660 /*
1661 * If @delay is 0, queue @dwork->work immediately. This is for
1662 * both optimization and correctness. The earliest @timer can
1663 * expire is on the closest next tick and delayed_work users depend
1664 * on that there's no such delay when @delay is 0.
1665 */
1666 if (!delay) {
1667 __queue_work(cpu, wq, &dwork->work);
1668 return;
1669 }
1670
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001671 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001672 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001673 timer->expires = jiffies + delay;
1674
Tejun Heo041bd122016-02-09 16:11:26 -05001675 if (unlikely(cpu != WORK_CPU_UNBOUND))
1676 add_timer_on(timer, cpu);
1677 else
1678 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
1680
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001681/**
1682 * queue_delayed_work_on - queue work on specific CPU after delay
1683 * @cpu: CPU number to execute work on
1684 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001685 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001686 * @delay: number of jiffies to wait before queueing
1687 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001688 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001689 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1690 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001691 */
Tejun Heod4283e92012-08-03 10:30:44 -07001692bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1693 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001694{
David Howells52bad642006-11-22 14:54:01 +00001695 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001696 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001697 unsigned long flags;
1698
1699 /* read the comment in __queue_work() */
1700 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001701
Tejun Heo22df02b2010-06-29 10:07:10 +02001702 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001703 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001704 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001705 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001706
1707 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001708 return ret;
1709}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001710EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711
Tejun Heoc8e55f32010-06-29 10:07:12 +02001712/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001713 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1714 * @cpu: CPU number to execute work on
1715 * @wq: workqueue to use
1716 * @dwork: work to queue
1717 * @delay: number of jiffies to wait before queueing
1718 *
1719 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1720 * modify @dwork's timer so that it expires after @delay. If @delay is
1721 * zero, @work is guaranteed to be scheduled immediately regardless of its
1722 * current state.
1723 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001724 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001725 * pending and its timer was modified.
1726 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001727 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001728 * See try_to_grab_pending() for details.
1729 */
1730bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1731 struct delayed_work *dwork, unsigned long delay)
1732{
1733 unsigned long flags;
1734 int ret;
1735
1736 do {
1737 ret = try_to_grab_pending(&dwork->work, true, &flags);
1738 } while (unlikely(ret == -EAGAIN));
1739
1740 if (likely(ret >= 0)) {
1741 __queue_delayed_work(cpu, wq, dwork, delay);
1742 local_irq_restore(flags);
1743 }
1744
1745 /* -ENOENT from try_to_grab_pending() becomes %true */
1746 return ret;
1747}
1748EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1749
Tejun Heo05f0fe62018-03-14 12:45:13 -07001750static void rcu_work_rcufn(struct rcu_head *rcu)
1751{
1752 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1753
1754 /* read the comment in __queue_work() */
1755 local_irq_disable();
1756 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1757 local_irq_enable();
1758}
1759
1760/**
1761 * queue_rcu_work - queue work after a RCU grace period
1762 * @wq: workqueue to use
1763 * @rwork: work to queue
1764 *
1765 * Return: %false if @rwork was already pending, %true otherwise. Note
1766 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001767 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001768 * execution may happen before a full RCU grace period has passed.
1769 */
1770bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1771{
1772 struct work_struct *work = &rwork->work;
1773
1774 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1775 rwork->wq = wq;
1776 call_rcu(&rwork->rcu, rcu_work_rcufn);
1777 return true;
1778 }
1779
1780 return false;
1781}
1782EXPORT_SYMBOL(queue_rcu_work);
1783
Tejun Heo8376fe22012-08-03 10:30:47 -07001784/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001785 * worker_enter_idle - enter idle state
1786 * @worker: worker which is entering idle state
1787 *
1788 * @worker is entering idle state. Update stats and idle timer if
1789 * necessary.
1790 *
1791 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001792 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001793 */
1794static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001796 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Tejun Heo6183c002013-03-12 11:29:57 -07001798 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1799 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1800 (worker->hentry.next || worker->hentry.pprev)))
1801 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Lai Jiangshan051e1852014-07-22 13:03:02 +08001803 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001804 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001805 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001806 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001807
Tejun Heoc8e55f32010-06-29 10:07:12 +02001808 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001809 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001810
Tejun Heo628c78e2012-07-17 12:39:27 -07001811 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1812 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001813
Tejun Heo544ecf32012-05-14 15:04:50 -07001814 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001815 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001816 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001817 * nr_running, the warning may trigger spuriously. Check iff
1818 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001819 */
Tejun Heo24647572013-01-24 11:01:33 -08001820 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001821 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001822 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823}
1824
Tejun Heoc8e55f32010-06-29 10:07:12 +02001825/**
1826 * worker_leave_idle - leave idle state
1827 * @worker: worker which is leaving idle state
1828 *
1829 * @worker is leaving idle state. Update stats.
1830 *
1831 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001832 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001833 */
1834static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001836 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837
Tejun Heo6183c002013-03-12 11:29:57 -07001838 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1839 return;
Tejun Heod302f012010-06-29 10:07:13 +02001840 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001841 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001842 list_del_init(&worker->entry);
1843}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001845static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001846{
1847 struct worker *worker;
1848
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001849 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001850 if (worker) {
1851 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001852 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001853 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001854 /* on creation a worker is in !idle && prep state */
1855 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001856 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001857 return worker;
1858}
1859
1860/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001861 * worker_attach_to_pool() - attach a worker to a pool
1862 * @worker: worker to be attached
1863 * @pool: the target pool
1864 *
1865 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1866 * cpu-binding of @worker are kept coordinated with the pool across
1867 * cpu-[un]hotplugs.
1868 */
1869static void worker_attach_to_pool(struct worker *worker,
1870 struct worker_pool *pool)
1871{
Tejun Heo1258fae2018-05-18 08:47:13 -07001872 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001873
1874 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001875 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1876 * stable across this function. See the comments above the flag
1877 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001878 */
1879 if (pool->flags & POOL_DISASSOCIATED)
1880 worker->flags |= WORKER_UNBOUND;
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001881 else
1882 kthread_set_per_cpu(worker->task, pool->cpu);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001883
Peter Zijlstra640f17c2021-01-15 19:08:36 +01001884 if (worker->rescue_wq)
1885 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1886
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001887 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001888 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001889
Tejun Heo1258fae2018-05-18 08:47:13 -07001890 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001891}
1892
1893/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001894 * worker_detach_from_pool() - detach a worker from its pool
1895 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001896 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001897 * Undo the attaching which had been done in worker_attach_to_pool(). The
1898 * caller worker shouldn't access to the pool after detached except it has
1899 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001900 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001901static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001902{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001903 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001904 struct completion *detach_completion = NULL;
1905
Tejun Heo1258fae2018-05-18 08:47:13 -07001906 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001907
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001908 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshanda028462014-05-20 17:46:31 +08001909 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001910 worker->pool = NULL;
1911
Lai Jiangshanda028462014-05-20 17:46:31 +08001912 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001913 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001914 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001915
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001916 /* clear leftover flags without pool->lock after it is detached */
1917 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1918
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001919 if (detach_completion)
1920 complete(detach_completion);
1921}
1922
1923/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001924 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001925 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001926 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001927 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001928 *
1929 * CONTEXT:
1930 * Might sleep. Does GFP_KERNEL allocations.
1931 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001932 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001933 * Pointer to the newly created worker.
1934 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001935static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001936{
Zhen Leie441b562021-08-04 11:50:36 +08001937 struct worker *worker;
1938 int id;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001939 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001940
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001941 /* ID is needed to determine kthread name */
Zhen Leie441b562021-08-04 11:50:36 +08001942 id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001943 if (id < 0)
Zhen Leie441b562021-08-04 11:50:36 +08001944 return NULL;
Tejun Heoc34056a2010-06-29 10:07:11 +02001945
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001946 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001947 if (!worker)
1948 goto fail;
1949
Tejun Heoc34056a2010-06-29 10:07:11 +02001950 worker->id = id;
1951
Tejun Heo29c91e92013-03-12 11:30:03 -07001952 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001953 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1954 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001955 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001956 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1957
Tejun Heof3f90ad2013-04-01 11:23:34 -07001958 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001959 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001960 if (IS_ERR(worker->task))
1961 goto fail;
1962
Oleg Nesterov91151222013-11-14 12:56:18 +01001963 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001964 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001965
Lai Jiangshanda028462014-05-20 17:46:31 +08001966 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001967 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001968
Lai Jiangshan051e1852014-07-22 13:03:02 +08001969 /* start the newly created worker */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001970 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001971 worker->pool->nr_workers++;
1972 worker_enter_idle(worker);
1973 wake_up_process(worker->task);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001974 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001975
Tejun Heoc34056a2010-06-29 10:07:11 +02001976 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001977
Tejun Heoc34056a2010-06-29 10:07:11 +02001978fail:
Zhen Leie441b562021-08-04 11:50:36 +08001979 ida_free(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001980 kfree(worker);
1981 return NULL;
1982}
1983
1984/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001985 * destroy_worker - destroy a workqueue worker
1986 * @worker: worker to be destroyed
1987 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001988 * Destroy @worker and adjust @pool stats accordingly. The worker should
1989 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001990 *
1991 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001992 * raw_spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001993 */
1994static void destroy_worker(struct worker *worker)
1995{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001996 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001997
Tejun Heocd549682013-03-13 19:47:39 -07001998 lockdep_assert_held(&pool->lock);
1999
Tejun Heoc34056a2010-06-29 10:07:11 +02002000 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07002001 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08002002 WARN_ON(!list_empty(&worker->scheduled)) ||
2003 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07002004 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02002005
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08002006 pool->nr_workers--;
2007 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08002008
Tejun Heoc8e55f32010-06-29 10:07:12 +02002009 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02002010 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002011 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02002012}
2013
Kees Cook32a6c722017-10-16 15:58:25 -07002014static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002015{
Kees Cook32a6c722017-10-16 15:58:25 -07002016 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002017
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002018 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002019
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002020 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002021 struct worker *worker;
2022 unsigned long expires;
2023
2024 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07002025 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2027
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002028 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002029 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002030 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002031 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002032
2033 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002034 }
2035
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002036 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002037}
2038
Tejun Heo493a1722013-03-12 11:29:59 -07002039static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002040{
Tejun Heo112202d2013-02-13 19:29:12 -08002041 struct pool_workqueue *pwq = get_work_pwq(work);
2042 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002043
Tejun Heo2e109a22013-03-13 19:47:40 -07002044 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002045
Tejun Heo493008a2013-03-12 11:30:03 -07002046 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002047 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002048
2049 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002050 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002051 /*
2052 * If @pwq is for an unbound wq, its base ref may be put at
2053 * any time due to an attribute change. Pin @pwq until the
2054 * rescuer is done with it.
2055 */
2056 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002057 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002058 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002059 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002060}
2061
Kees Cook32a6c722017-10-16 15:58:25 -07002062static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002063{
Kees Cook32a6c722017-10-16 15:58:25 -07002064 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002065 struct work_struct *work;
2066
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002067 raw_spin_lock_irq(&pool->lock);
2068 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002069
Tejun Heo63d95a92012-07-12 14:46:37 -07002070 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002071 /*
2072 * We've been trying to create a new worker but
2073 * haven't been successful. We might be hitting an
2074 * allocation deadlock. Send distress signals to
2075 * rescuers.
2076 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002077 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002078 send_mayday(work);
2079 }
2080
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002081 raw_spin_unlock(&wq_mayday_lock);
2082 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002083
Tejun Heo63d95a92012-07-12 14:46:37 -07002084 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002085}
2086
2087/**
2088 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002089 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002090 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002091 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002092 * have at least one idle worker on return from this function. If
2093 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002094 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002095 * possible allocation deadlock.
2096 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002097 * On return, need_to_create_worker() is guaranteed to be %false and
2098 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002099 *
2100 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002101 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002102 * multiple times. Does GFP_KERNEL allocations. Called only from
2103 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002104 */
Tejun Heo29187a92015-01-16 14:21:16 -05002105static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002106__releases(&pool->lock)
2107__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002108{
Tejun Heoe22bee72010-06-29 10:07:14 +02002109restart:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002110 raw_spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002111
Tejun Heoe22bee72010-06-29 10:07:14 +02002112 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002113 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002114
2115 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002116 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002117 break;
2118
Lai Jiangshane212f362014-06-03 15:32:17 +08002119 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002120
Tejun Heo63d95a92012-07-12 14:46:37 -07002121 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002122 break;
2123 }
2124
Tejun Heo63d95a92012-07-12 14:46:37 -07002125 del_timer_sync(&pool->mayday_timer);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002126 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002127 /*
2128 * This is necessary even after a new worker was just successfully
2129 * created as @pool->lock was dropped and the new worker might have
2130 * already become busy.
2131 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002132 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002133 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002134}
2135
2136/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002137 * manage_workers - manage worker pool
2138 * @worker: self
2139 *
Tejun Heo706026c2013-01-24 11:01:34 -08002140 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002141 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002142 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002143 *
2144 * The caller can safely start processing works on false return. On
2145 * true return, it's guaranteed that need_to_create_worker() is false
2146 * and may_start_working() is true.
2147 *
2148 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002149 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002150 * multiple times. Does GFP_KERNEL allocations.
2151 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002152 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002153 * %false if the pool doesn't need management and the caller can safely
2154 * start processing works, %true if management function was performed and
2155 * the conditions that the caller verified before calling the function may
2156 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002157 */
2158static bool manage_workers(struct worker *worker)
2159{
Tejun Heo63d95a92012-07-12 14:46:37 -07002160 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002161
Tejun Heo692b4822017-10-09 08:04:13 -07002162 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002163 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002164
2165 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002166 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002167
Tejun Heo29187a92015-01-16 14:21:16 -05002168 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002169
Tejun Heo2607d7a2015-03-09 09:22:28 -04002170 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002171 pool->flags &= ~POOL_MANAGER_ACTIVE;
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02002172 rcuwait_wake_up(&manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002173 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002174}
2175
Tejun Heoa62428c2010-06-29 10:07:10 +02002176/**
2177 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002178 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002179 * @work: work to process
2180 *
2181 * Process @work. This function contains all the logics necessary to
2182 * process a single work including synchronization against and
2183 * interaction with other workers on the same cpu, queueing and
2184 * flushing. As long as context requirement is met, any worker can
2185 * call this function to process a work.
2186 *
2187 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002188 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002189 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002190static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002191__releases(&pool->lock)
2192__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002193{
Tejun Heo112202d2013-02-13 19:29:12 -08002194 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002195 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002196 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002197 unsigned long work_data;
Tejun Heo7e116292010-06-29 10:07:13 +02002198 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002199#ifdef CONFIG_LOCKDEP
2200 /*
2201 * It is permissible to free the struct work_struct from
2202 * inside the function that is called from it, this we need to
2203 * take into account for lockdep too. To avoid bogus "held
2204 * lock freed" warnings as well as problems when looking into
2205 * work->lockdep_map, make a copy and use that here.
2206 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002207 struct lockdep_map lockdep_map;
2208
2209 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002210#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002211 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002212 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002213 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002214
Tejun Heo7e116292010-06-29 10:07:13 +02002215 /*
2216 * A single work shouldn't be executed concurrently by
2217 * multiple workers on a single cpu. Check whether anyone is
2218 * already processing the work. If so, defer the work to the
2219 * currently executing one.
2220 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002221 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002222 if (unlikely(collision)) {
2223 move_linked_works(work, &collision->scheduled, NULL);
2224 return;
2225 }
2226
Tejun Heo8930cab2012-08-03 10:30:45 -07002227 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002228 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002229 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002230 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002231 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002232 worker->current_pwq = pwq;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002233 work_data = *work_data_bits(work);
Lai Jiangshand8127962021-08-17 09:32:38 +08002234 worker->current_color = get_work_color(work_data);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002235
Tejun Heo8bf89592018-05-18 08:47:13 -07002236 /*
2237 * Record wq name for cmdline and debug reporting, may get
2238 * overridden through set_worker_desc().
2239 */
2240 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2241
Tejun Heoa62428c2010-06-29 10:07:10 +02002242 list_del_init(&work->entry);
2243
Tejun Heo649027d2010-06-29 10:07:14 +02002244 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002245 * CPU intensive works don't participate in concurrency management.
2246 * They're the scheduler's responsibility. This takes @worker out
2247 * of concurrency management and the next code block will chain
2248 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002249 */
2250 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002251 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002252
Tejun Heo974271c2012-07-12 14:46:37 -07002253 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002254 * Wake up another worker if necessary. The condition is always
2255 * false for normal per-cpu workers since nr_running would always
2256 * be >= 1 at this point. This is used to chain execution of the
2257 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002258 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002259 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002260 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002261 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002262
Tejun Heo8930cab2012-08-03 10:30:45 -07002263 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002264 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002265 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002266 * PENDING and queued state changes happen together while IRQ is
2267 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002268 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002269 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002270
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002271 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002272
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002273 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002274 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002275 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002276 * Strictly speaking we should mark the invariant state without holding
2277 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002278 *
2279 * However, that would result in:
2280 *
2281 * A(W1)
2282 * WFC(C)
2283 * A(W1)
2284 * C(C)
2285 *
2286 * Which would create W1->C->W1 dependencies, even though there is no
2287 * actual deadlock possible. There are two solutions, using a
2288 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002289 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002290 * these locks.
2291 *
2292 * AFAICT there is no possible deadlock scenario between the
2293 * flush_work() and complete() primitives (except for single-threaded
2294 * workqueues), so hiding them isn't a problem.
2295 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002296 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002297 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002298 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002299 /*
2300 * While we must be careful to not use "work" after this, the trace
2301 * point will only record its address.
2302 */
Daniel Jordan1c5da0e2020-01-13 17:52:39 -05002303 trace_workqueue_execute_end(work, worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002304 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002305 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002306
2307 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002308 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002309 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002310 current->comm, preempt_count(), task_pid_nr(current),
2311 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002312 debug_show_held_locks(current);
2313 dump_stack();
2314 }
2315
Tejun Heob22ce272013-08-28 17:33:37 -04002316 /*
Sebastian Andrzej Siewior025f50f2019-10-15 21:18:21 +02002317 * The following prevents a kworker from hogging CPU on !PREEMPTION
Tejun Heob22ce272013-08-28 17:33:37 -04002318 * kernels, where a requeueing work item waiting for something to
2319 * happen could deadlock with stop_machine as such work item could
2320 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002321 * stop_machine. At the same time, report a quiescent RCU state so
2322 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002323 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002324 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002325
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002326 raw_spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002327
Tejun Heofb0e7be2010-06-29 10:07:15 +02002328 /* clear cpu intensive status */
2329 if (unlikely(cpu_intensive))
2330 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2331
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002332 /* tag the worker for identification in schedule() */
2333 worker->last_func = worker->current_func;
2334
Tejun Heoa62428c2010-06-29 10:07:10 +02002335 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002336 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002337 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002338 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002339 worker->current_pwq = NULL;
Lai Jiangshand8127962021-08-17 09:32:38 +08002340 worker->current_color = INT_MAX;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002341 pwq_dec_nr_in_flight(pwq, work_data);
Tejun Heoa62428c2010-06-29 10:07:10 +02002342}
2343
Tejun Heoaffee4b2010-06-29 10:07:12 +02002344/**
2345 * process_scheduled_works - process scheduled works
2346 * @worker: self
2347 *
2348 * Process all scheduled works. Please note that the scheduled list
2349 * may change while processing a work, so this function repeatedly
2350 * fetches a work from the top and executes it.
2351 *
2352 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002353 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002354 * multiple times.
2355 */
2356static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002358 while (!list_empty(&worker->scheduled)) {
2359 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002361 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363}
2364
Tejun Heo197f6ac2018-05-21 08:04:35 -07002365static void set_pf_worker(bool val)
2366{
2367 mutex_lock(&wq_pool_attach_mutex);
2368 if (val)
2369 current->flags |= PF_WQ_WORKER;
2370 else
2371 current->flags &= ~PF_WQ_WORKER;
2372 mutex_unlock(&wq_pool_attach_mutex);
2373}
2374
Tejun Heo4690c4a2010-06-29 10:07:10 +02002375/**
2376 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002377 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002378 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002379 * The worker thread function. All workers belong to a worker_pool -
2380 * either a per-cpu one or dynamic unbound one. These workers process all
2381 * work items regardless of their specific target workqueue. The only
2382 * exception is work items which belong to workqueues with a rescuer which
2383 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002384 *
2385 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002386 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002387static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388{
Tejun Heoc34056a2010-06-29 10:07:11 +02002389 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002390 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391
Tejun Heoe22bee72010-06-29 10:07:14 +02002392 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002393 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002394woke_up:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002395 raw_spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002396
Tejun Heoa9ab7752013-03-19 13:45:21 -07002397 /* am I supposed to die? */
2398 if (unlikely(worker->flags & WORKER_DIE)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002399 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002400 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002401 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002402
2403 set_task_comm(worker->task, "kworker/dying");
Zhen Leie441b562021-08-04 11:50:36 +08002404 ida_free(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002405 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002406 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002407 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002409
Tejun Heoc8e55f32010-06-29 10:07:12 +02002410 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002411recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002412 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002413 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002414 goto sleep;
2415
2416 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002417 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002418 goto recheck;
2419
Tejun Heoc8e55f32010-06-29 10:07:12 +02002420 /*
2421 * ->scheduled list can only be filled while a worker is
2422 * preparing to process a work or actually processing it.
2423 * Make sure nobody diddled with it while I was sleeping.
2424 */
Tejun Heo6183c002013-03-12 11:29:57 -07002425 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002426
Tejun Heoe22bee72010-06-29 10:07:14 +02002427 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002428 * Finish PREP stage. We're guaranteed to have at least one idle
2429 * worker or that someone else has already assumed the manager
2430 * role. This is where @worker starts participating in concurrency
2431 * management if applicable and concurrency management is restored
2432 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002433 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002434 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002435
2436 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002437 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002438 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002439 struct work_struct, entry);
2440
Tejun Heo82607adc2015-12-08 11:28:04 -05002441 pool->watchdog_ts = jiffies;
2442
Tejun Heoc8e55f32010-06-29 10:07:12 +02002443 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2444 /* optimization path, not strictly necessary */
2445 process_one_work(worker, work);
2446 if (unlikely(!list_empty(&worker->scheduled)))
2447 process_scheduled_works(worker);
2448 } else {
2449 move_linked_works(work, &worker->scheduled, NULL);
2450 process_scheduled_works(worker);
2451 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002452 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002453
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002454 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002455sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002456 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002457 * pool->lock is held and there's no work to process and no need to
2458 * manage, sleep. Workers are woken up only while holding
2459 * pool->lock or from local cpu, so setting the current state
2460 * before releasing pool->lock is enough to prevent losing any
2461 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002462 */
2463 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002464 __set_current_state(TASK_IDLE);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002465 raw_spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002466 schedule();
2467 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468}
2469
Tejun Heoe22bee72010-06-29 10:07:14 +02002470/**
2471 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002472 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002473 *
2474 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002475 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002476 *
Tejun Heo706026c2013-01-24 11:01:34 -08002477 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002478 * worker which uses GFP_KERNEL allocation which has slight chance of
2479 * developing into deadlock if some works currently on the same queue
2480 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2481 * the problem rescuer solves.
2482 *
Tejun Heo706026c2013-01-24 11:01:34 -08002483 * When such condition is possible, the pool summons rescuers of all
2484 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002485 * those works so that forward progress can be guaranteed.
2486 *
2487 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002488 *
2489 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002490 */
Tejun Heo111c2252013-01-17 17:16:24 -08002491static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002492{
Tejun Heo111c2252013-01-17 17:16:24 -08002493 struct worker *rescuer = __rescuer;
2494 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002495 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002496 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002497
2498 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002499
2500 /*
2501 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2502 * doesn't participate in concurrency management.
2503 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002504 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002505repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002506 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002507
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002508 /*
2509 * By the time the rescuer is requested to stop, the workqueue
2510 * shouldn't have any work pending, but @wq->maydays may still have
2511 * pwq(s) queued. This can happen by non-rescuer workers consuming
2512 * all the work items before the rescuer got to them. Go through
2513 * @wq->maydays processing before acting on should_stop so that the
2514 * list is always empty on exit.
2515 */
2516 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002517
Tejun Heo493a1722013-03-12 11:29:59 -07002518 /* see whether any pwq is asking for help */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002519 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002520
2521 while (!list_empty(&wq->maydays)) {
2522 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2523 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002524 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002525 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002526 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002527
2528 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002529 list_del_init(&pwq->mayday_node);
2530
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002531 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002532
Lai Jiangshan51697d392014-05-20 17:46:36 +08002533 worker_attach_to_pool(rescuer, pool);
2534
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002535 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002536
2537 /*
2538 * Slurp in all works issued via this workqueue and
2539 * process'em.
2540 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002541 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002542 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2543 if (get_work_pwq(work) == pwq) {
2544 if (first)
2545 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002546 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002547 }
2548 first = false;
2549 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002550
NeilBrown008847f2014-12-08 12:39:16 -05002551 if (!list_empty(scheduled)) {
2552 process_scheduled_works(rescuer);
2553
2554 /*
2555 * The above execution of rescued work items could
2556 * have created more to rescue through
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08002557 * pwq_activate_first_inactive() or chained
NeilBrown008847f2014-12-08 12:39:16 -05002558 * queueing. Let's put @pwq back on mayday list so
2559 * that such back-to-back work items, which may be
2560 * being used to relieve memory pressure, don't
2561 * incur MAYDAY_INTERVAL delay inbetween.
2562 */
Lai Jiangshan4f3f4cf2020-05-29 06:58:59 +00002563 if (pwq->nr_active && need_to_create_worker(pool)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002564 raw_spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002565 /*
2566 * Queue iff we aren't racing destruction
2567 * and somebody else hasn't queued it already.
2568 */
2569 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2570 get_pwq(pwq);
2571 list_add_tail(&pwq->mayday_node, &wq->maydays);
2572 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002573 raw_spin_unlock(&wq_mayday_lock);
NeilBrown008847f2014-12-08 12:39:16 -05002574 }
2575 }
Tejun Heo75769582011-02-14 14:04:46 +01002576
2577 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002578 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002579 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002580 */
2581 put_pwq(pwq);
2582
2583 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002584 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002585 * regular worker; otherwise, we end up with 0 concurrency
2586 * and stalling the execution.
2587 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002588 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002589 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002590
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002591 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002592
Tejun Heoa2d812a2018-05-18 08:47:13 -07002593 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002594
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002595 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002596 }
2597
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002598 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002599
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002600 if (should_stop) {
2601 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002602 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002603 return 0;
2604 }
2605
Tejun Heo111c2252013-01-17 17:16:24 -08002606 /* rescuers should never participate in concurrency management */
2607 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002608 schedule();
2609 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610}
2611
Tejun Heofca839c2015-12-07 10:58:57 -05002612/**
2613 * check_flush_dependency - check for flush dependency sanity
2614 * @target_wq: workqueue being flushed
2615 * @target_work: work item being flushed (NULL for workqueue flushes)
2616 *
2617 * %current is trying to flush the whole @target_wq or @target_work on it.
2618 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2619 * reclaiming memory or running on a workqueue which doesn't have
2620 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2621 * a deadlock.
2622 */
2623static void check_flush_dependency(struct workqueue_struct *target_wq,
2624 struct work_struct *target_work)
2625{
2626 work_func_t target_func = target_work ? target_work->func : NULL;
2627 struct worker *worker;
2628
2629 if (target_wq->flags & WQ_MEM_RECLAIM)
2630 return;
2631
2632 worker = current_wq_worker();
2633
2634 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002635 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002636 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002637 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2638 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002639 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002640 worker->current_pwq->wq->name, worker->current_func,
2641 target_wq->name, target_func);
2642}
2643
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002644struct wq_barrier {
2645 struct work_struct work;
2646 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002647 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002648};
2649
2650static void wq_barrier_func(struct work_struct *work)
2651{
2652 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2653 complete(&barr->done);
2654}
2655
Tejun Heo4690c4a2010-06-29 10:07:10 +02002656/**
2657 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002658 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002659 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002660 * @target: target work to attach @barr to
2661 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002662 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002663 * @barr is linked to @target such that @barr is completed only after
2664 * @target finishes execution. Please note that the ordering
2665 * guarantee is observed only with respect to @target and on the local
2666 * cpu.
2667 *
2668 * Currently, a queued barrier can't be canceled. This is because
2669 * try_to_grab_pending() can't determine whether the work to be
2670 * grabbed is at the head of the queue and thus can't clear LINKED
2671 * flag of the previous work while there must be a valid next work
2672 * after a work with LINKED flag set.
2673 *
2674 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002675 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002676 *
2677 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002678 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002679 */
Tejun Heo112202d2013-02-13 19:29:12 -08002680static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002681 struct wq_barrier *barr,
2682 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002683{
Lai Jiangshand8127962021-08-17 09:32:38 +08002684 unsigned int work_flags = 0;
2685 unsigned int work_color;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002686 struct list_head *head;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002687
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002688 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002689 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002690 * as we know for sure that this will not trigger any of the
2691 * checks and call back into the fixup functions where we
2692 * might deadlock.
2693 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002694 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002695 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002696
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002697 init_completion_map(&barr->done, &target->lockdep_map);
2698
Tejun Heo2607d7a2015-03-09 09:22:28 -04002699 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002700
Lai Jiangshan018f3a12021-08-17 09:32:37 +08002701 /* The barrier work item does not participate in pwq->nr_active. */
2702 work_flags |= WORK_STRUCT_INACTIVE;
2703
Tejun Heoaffee4b2010-06-29 10:07:12 +02002704 /*
2705 * If @target is currently being executed, schedule the
2706 * barrier to the worker; otherwise, put it after @target.
2707 */
Lai Jiangshand8127962021-08-17 09:32:38 +08002708 if (worker) {
Tejun Heoaffee4b2010-06-29 10:07:12 +02002709 head = worker->scheduled.next;
Lai Jiangshand8127962021-08-17 09:32:38 +08002710 work_color = worker->current_color;
2711 } else {
Tejun Heoaffee4b2010-06-29 10:07:12 +02002712 unsigned long *bits = work_data_bits(target);
2713
2714 head = target->entry.next;
2715 /* there can already be other linked works, inherit and set */
Lai Jiangshand21cece2021-08-17 09:32:36 +08002716 work_flags |= *bits & WORK_STRUCT_LINKED;
Lai Jiangshand8127962021-08-17 09:32:38 +08002717 work_color = get_work_color(*bits);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002718 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2719 }
2720
Lai Jiangshand8127962021-08-17 09:32:38 +08002721 pwq->nr_in_flight[work_color]++;
2722 work_flags |= work_color_to_flags(work_color);
2723
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002724 debug_work_activate(&barr->work);
Lai Jiangshand21cece2021-08-17 09:32:36 +08002725 insert_work(pwq, &barr->work, head, work_flags);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002726}
2727
Tejun Heo73f53c42010-06-29 10:07:11 +02002728/**
Tejun Heo112202d2013-02-13 19:29:12 -08002729 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002730 * @wq: workqueue being flushed
2731 * @flush_color: new flush color, < 0 for no-op
2732 * @work_color: new work color, < 0 for no-op
2733 *
Tejun Heo112202d2013-02-13 19:29:12 -08002734 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002735 *
Tejun Heo112202d2013-02-13 19:29:12 -08002736 * If @flush_color is non-negative, flush_color on all pwqs should be
2737 * -1. If no pwq has in-flight commands at the specified color, all
2738 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2739 * has in flight commands, its pwq->flush_color is set to
2740 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002741 * wakeup logic is armed and %true is returned.
2742 *
2743 * The caller should have initialized @wq->first_flusher prior to
2744 * calling this function with non-negative @flush_color. If
2745 * @flush_color is negative, no flush color update is done and %false
2746 * is returned.
2747 *
Tejun Heo112202d2013-02-13 19:29:12 -08002748 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002749 * work_color which is previous to @work_color and all will be
2750 * advanced to @work_color.
2751 *
2752 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002753 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002754 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002755 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002756 * %true if @flush_color >= 0 and there's something to flush. %false
2757 * otherwise.
2758 */
Tejun Heo112202d2013-02-13 19:29:12 -08002759static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002760 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761{
Tejun Heo73f53c42010-06-29 10:07:11 +02002762 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002763 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002764
Tejun Heo73f53c42010-06-29 10:07:11 +02002765 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002766 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002767 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002768 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002769
Tejun Heo49e3cf42013-03-12 11:29:58 -07002770 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002771 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002772
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002773 raw_spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002774
2775 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002776 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002777
Tejun Heo112202d2013-02-13 19:29:12 -08002778 if (pwq->nr_in_flight[flush_color]) {
2779 pwq->flush_color = flush_color;
2780 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002781 wait = true;
2782 }
2783 }
2784
2785 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002786 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002787 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002788 }
2789
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002790 raw_spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002791 }
2792
Tejun Heo112202d2013-02-13 19:29:12 -08002793 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002794 complete(&wq->first_flusher->done);
2795
2796 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797}
2798
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002799/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002801 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002803 * This function sleeps until all work items which were queued on entry
2804 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002806void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807{
Tejun Heo73f53c42010-06-29 10:07:11 +02002808 struct wq_flusher this_flusher = {
2809 .list = LIST_HEAD_INIT(this_flusher.list),
2810 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002811 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002812 };
2813 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002814
Tejun Heo3347fa02016-09-16 15:49:32 -04002815 if (WARN_ON(!wq_online))
2816 return;
2817
Johannes Berg87915ad2018-08-22 11:49:04 +02002818 lock_map_acquire(&wq->lockdep_map);
2819 lock_map_release(&wq->lockdep_map);
2820
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002821 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002822
2823 /*
2824 * Start-to-wait phase
2825 */
2826 next_color = work_next_color(wq->work_color);
2827
2828 if (next_color != wq->flush_color) {
2829 /*
2830 * Color space is not full. The current work_color
2831 * becomes our flush_color and work_color is advanced
2832 * by one.
2833 */
Tejun Heo6183c002013-03-12 11:29:57 -07002834 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002835 this_flusher.flush_color = wq->work_color;
2836 wq->work_color = next_color;
2837
2838 if (!wq->first_flusher) {
2839 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002840 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002841
2842 wq->first_flusher = &this_flusher;
2843
Tejun Heo112202d2013-02-13 19:29:12 -08002844 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002845 wq->work_color)) {
2846 /* nothing to flush, done */
2847 wq->flush_color = next_color;
2848 wq->first_flusher = NULL;
2849 goto out_unlock;
2850 }
2851 } else {
2852 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002853 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002854 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002855 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002856 }
2857 } else {
2858 /*
2859 * Oops, color space is full, wait on overflow queue.
2860 * The next flush completion will assign us
2861 * flush_color and transfer to flusher_queue.
2862 */
2863 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2864 }
2865
Tejun Heofca839c2015-12-07 10:58:57 -05002866 check_flush_dependency(wq, NULL);
2867
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002868 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002869
2870 wait_for_completion(&this_flusher.done);
2871
2872 /*
2873 * Wake-up-and-cascade phase
2874 *
2875 * First flushers are responsible for cascading flushes and
2876 * handling overflow. Non-first flushers can simply return.
2877 */
Chris Wilson00d5d152020-03-10 16:23:19 +00002878 if (READ_ONCE(wq->first_flusher) != &this_flusher)
Tejun Heo73f53c42010-06-29 10:07:11 +02002879 return;
2880
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002881 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002882
Tejun Heo4ce48b32010-07-02 10:03:51 +02002883 /* we might have raced, check again with mutex held */
2884 if (wq->first_flusher != &this_flusher)
2885 goto out_unlock;
2886
Chris Wilson00d5d152020-03-10 16:23:19 +00002887 WRITE_ONCE(wq->first_flusher, NULL);
Tejun Heo73f53c42010-06-29 10:07:11 +02002888
Tejun Heo6183c002013-03-12 11:29:57 -07002889 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2890 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002891
2892 while (true) {
2893 struct wq_flusher *next, *tmp;
2894
2895 /* complete all the flushers sharing the current flush color */
2896 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2897 if (next->flush_color != wq->flush_color)
2898 break;
2899 list_del_init(&next->list);
2900 complete(&next->done);
2901 }
2902
Tejun Heo6183c002013-03-12 11:29:57 -07002903 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2904 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002905
2906 /* this flush_color is finished, advance by one */
2907 wq->flush_color = work_next_color(wq->flush_color);
2908
2909 /* one color has been freed, handle overflow queue */
2910 if (!list_empty(&wq->flusher_overflow)) {
2911 /*
2912 * Assign the same color to all overflowed
2913 * flushers, advance work_color and append to
2914 * flusher_queue. This is the start-to-wait
2915 * phase for these overflowed flushers.
2916 */
2917 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2918 tmp->flush_color = wq->work_color;
2919
2920 wq->work_color = work_next_color(wq->work_color);
2921
2922 list_splice_tail_init(&wq->flusher_overflow,
2923 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002924 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002925 }
2926
2927 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002928 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002929 break;
2930 }
2931
2932 /*
2933 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002934 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002935 */
Tejun Heo6183c002013-03-12 11:29:57 -07002936 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2937 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002938
2939 list_del_init(&next->list);
2940 wq->first_flusher = next;
2941
Tejun Heo112202d2013-02-13 19:29:12 -08002942 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002943 break;
2944
2945 /*
2946 * Meh... this color is already done, clear first
2947 * flusher and repeat cascading.
2948 */
2949 wq->first_flusher = NULL;
2950 }
2951
2952out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002953 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002955EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002956
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002957/**
2958 * drain_workqueue - drain a workqueue
2959 * @wq: workqueue to drain
2960 *
2961 * Wait until the workqueue becomes empty. While draining is in progress,
2962 * only chain queueing is allowed. IOW, only currently pending or running
2963 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002964 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002965 * by the depth of chaining and should be relatively short. Whine if it
2966 * takes too long.
2967 */
2968void drain_workqueue(struct workqueue_struct *wq)
2969{
2970 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002971 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002972
2973 /*
2974 * __queue_work() needs to test whether there are drainers, is much
2975 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002976 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002977 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002978 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002979 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002980 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002981 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002982reflush:
2983 flush_workqueue(wq);
2984
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002985 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002986
Tejun Heo49e3cf42013-03-12 11:29:58 -07002987 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002988 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002989
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002990 raw_spin_lock_irq(&pwq->pool->lock);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08002991 drained = !pwq->nr_active && list_empty(&pwq->inactive_works);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002992 raw_spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002993
2994 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002995 continue;
2996
2997 if (++flush_cnt == 10 ||
2998 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Stephen Zhange9ad2eb2021-01-23 16:04:00 +08002999 pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3000 wq->name, __func__, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07003001
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003002 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003003 goto reflush;
3004 }
3005
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003006 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07003007 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07003008 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003009}
3010EXPORT_SYMBOL_GPL(drain_workqueue);
3011
Johannes Bergd6e89782018-08-22 11:49:03 +02003012static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3013 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02003014{
3015 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003016 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08003017 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02003018
3019 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02003020
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003021 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07003022 pool = get_work_pool(work);
3023 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003024 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07003025 return false;
3026 }
3027
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003028 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08003029 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08003030 pwq = get_work_pwq(work);
3031 if (pwq) {
3032 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02003033 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07003034 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003035 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003036 if (!worker)
3037 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003038 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003039 }
Tejun Heobaf59022010-09-16 10:42:16 +02003040
Tejun Heofca839c2015-12-07 10:58:57 -05003041 check_flush_dependency(pwq->wq, work);
3042
Tejun Heo112202d2013-02-13 19:29:12 -08003043 insert_wq_barrier(pwq, barr, work, worker);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003044 raw_spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003045
Tejun Heoe159489b2011-01-09 23:32:15 +01003046 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003047 * Force a lock recursion deadlock when using flush_work() inside a
3048 * single-threaded or rescuer equipped workqueue.
3049 *
3050 * For single threaded workqueues the deadlock happens when the work
3051 * is after the work issuing the flush_work(). For rescuer equipped
3052 * workqueues the deadlock happens when the rescuer stalls, blocking
3053 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003054 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003055 if (!from_cancel &&
3056 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003057 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003058 lock_map_release(&pwq->wq->lockdep_map);
3059 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003060 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003061 return true;
3062already_gone:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003063 raw_spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003064 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003065 return false;
3066}
3067
Johannes Bergd6e89782018-08-22 11:49:03 +02003068static bool __flush_work(struct work_struct *work, bool from_cancel)
3069{
3070 struct wq_barrier barr;
3071
3072 if (WARN_ON(!wq_online))
3073 return false;
3074
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003075 if (WARN_ON(!work->func))
3076 return false;
3077
Johannes Berg87915ad2018-08-22 11:49:04 +02003078 if (!from_cancel) {
3079 lock_map_acquire(&work->lockdep_map);
3080 lock_map_release(&work->lockdep_map);
3081 }
3082
Johannes Bergd6e89782018-08-22 11:49:03 +02003083 if (start_flush_work(work, &barr, from_cancel)) {
3084 wait_for_completion(&barr.done);
3085 destroy_work_on_stack(&barr.work);
3086 return true;
3087 } else {
3088 return false;
3089 }
3090}
3091
Oleg Nesterovdb700892008-07-25 01:47:49 -07003092/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003093 * flush_work - wait for a work to finish executing the last queueing instance
3094 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003095 *
Tejun Heo606a5022012-08-20 14:51:23 -07003096 * Wait until @work has finished execution. @work is guaranteed to be idle
3097 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003098 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003099 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003100 * %true if flush_work() waited for the work to finish execution,
3101 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003102 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003103bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003104{
Johannes Bergd6e89782018-08-22 11:49:03 +02003105 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003106}
3107EXPORT_SYMBOL_GPL(flush_work);
3108
Tejun Heo8603e1b32015-03-05 08:04:13 -05003109struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003110 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003111 struct work_struct *work;
3112};
3113
Ingo Molnarac6424b2017-06-20 12:06:13 +02003114static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003115{
3116 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3117
3118 if (cwait->work != key)
3119 return 0;
3120 return autoremove_wake_function(wait, mode, sync, key);
3121}
3122
Tejun Heo36e227d2012-08-03 10:30:46 -07003123static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003124{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003125 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003126 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003127 int ret;
3128
3129 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003130 ret = try_to_grab_pending(work, is_dwork, &flags);
3131 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003132 * If someone else is already canceling, wait for it to
3133 * finish. flush_work() doesn't work for PREEMPT_NONE
3134 * because we may get scheduled between @work's completion
3135 * and the other canceling task resuming and clearing
3136 * CANCELING - flush_work() will return false immediately
3137 * as @work is no longer busy, try_to_grab_pending() will
3138 * return -ENOENT as @work is still being canceled and the
3139 * other canceling task won't be able to clear CANCELING as
3140 * we're hogging the CPU.
3141 *
3142 * Let's wait for completion using a waitqueue. As this
3143 * may lead to the thundering herd problem, use a custom
3144 * wake function which matches @work along with exclusive
3145 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003146 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003147 if (unlikely(ret == -ENOENT)) {
3148 struct cwt_wait cwait;
3149
3150 init_wait(&cwait.wait);
3151 cwait.wait.func = cwt_wakefn;
3152 cwait.work = work;
3153
3154 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3155 TASK_UNINTERRUPTIBLE);
3156 if (work_is_canceling(work))
3157 schedule();
3158 finish_wait(&cancel_waitq, &cwait.wait);
3159 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003160 } while (unlikely(ret < 0));
3161
Tejun Heobbb68df2012-08-03 10:30:46 -07003162 /* tell other tasks trying to grab @work to back off */
3163 mark_work_canceling(work);
3164 local_irq_restore(flags);
3165
Tejun Heo3347fa02016-09-16 15:49:32 -04003166 /*
3167 * This allows canceling during early boot. We know that @work
3168 * isn't executing.
3169 */
3170 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003171 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003172
Tejun Heo7a22ad72010-06-29 10:07:13 +02003173 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003174
3175 /*
3176 * Paired with prepare_to_wait() above so that either
3177 * waitqueue_active() is visible here or !work_is_canceling() is
3178 * visible there.
3179 */
3180 smp_mb();
3181 if (waitqueue_active(&cancel_waitq))
3182 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3183
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003184 return ret;
3185}
3186
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003187/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003188 * cancel_work_sync - cancel a work and wait for it to finish
3189 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003190 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003191 * Cancel @work and wait for its execution to finish. This function
3192 * can be used even if the work re-queues itself or migrates to
3193 * another workqueue. On return from this function, @work is
3194 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003195 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003196 * cancel_work_sync(&delayed_work->work) must not be used for
3197 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003198 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003199 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003200 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003201 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003202 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003203 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003204 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003205bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003206{
Tejun Heo36e227d2012-08-03 10:30:46 -07003207 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003208}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003209EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003210
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003211/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003212 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3213 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003214 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003215 * Delayed timer is cancelled and the pending work is queued for
3216 * immediate execution. Like flush_work(), this function only
3217 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003218 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003219 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003220 * %true if flush_work() waited for the work to finish execution,
3221 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003222 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003223bool flush_delayed_work(struct delayed_work *dwork)
3224{
Tejun Heo8930cab2012-08-03 10:30:45 -07003225 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003226 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003227 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003228 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003229 return flush_work(&dwork->work);
3230}
3231EXPORT_SYMBOL(flush_delayed_work);
3232
Tejun Heo05f0fe62018-03-14 12:45:13 -07003233/**
3234 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3235 * @rwork: the rcu work to flush
3236 *
3237 * Return:
3238 * %true if flush_rcu_work() waited for the work to finish execution,
3239 * %false if it was already idle.
3240 */
3241bool flush_rcu_work(struct rcu_work *rwork)
3242{
3243 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3244 rcu_barrier();
3245 flush_work(&rwork->work);
3246 return true;
3247 } else {
3248 return flush_work(&rwork->work);
3249 }
3250}
3251EXPORT_SYMBOL(flush_rcu_work);
3252
Jens Axboef72b8792016-08-24 15:51:50 -06003253static bool __cancel_work(struct work_struct *work, bool is_dwork)
3254{
3255 unsigned long flags;
3256 int ret;
3257
3258 do {
3259 ret = try_to_grab_pending(work, is_dwork, &flags);
3260 } while (unlikely(ret == -EAGAIN));
3261
3262 if (unlikely(ret < 0))
3263 return false;
3264
3265 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3266 local_irq_restore(flags);
3267 return ret;
3268}
3269
Tejun Heo401a8d02010-09-16 10:36:00 +02003270/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003271 * cancel_delayed_work - cancel a delayed work
3272 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003273 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003274 * Kill off a pending delayed_work.
3275 *
3276 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3277 * pending.
3278 *
3279 * Note:
3280 * The work callback function may still be running on return, unless
3281 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3282 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003283 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003284 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003285 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003286bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003287{
Jens Axboef72b8792016-08-24 15:51:50 -06003288 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003289}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003290EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003291
3292/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003293 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3294 * @dwork: the delayed work cancel
3295 *
3296 * This is cancel_work_sync() for delayed works.
3297 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003298 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003299 * %true if @dwork was pending, %false otherwise.
3300 */
3301bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003302{
Tejun Heo36e227d2012-08-03 10:30:46 -07003303 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003304}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003305EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003307/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003308 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003309 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003310 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003311 * schedule_on_each_cpu() executes @func on each online CPU using the
3312 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003313 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003314 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003315 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003316 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003317 */
David Howells65f27f32006-11-22 14:55:48 +00003318int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003319{
3320 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003321 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003322
Andrew Mortonb6136772006-06-25 05:47:49 -07003323 works = alloc_percpu(struct work_struct);
3324 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003325 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003326
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02003327 cpus_read_lock();
Tejun Heo93981802009-11-17 14:06:20 -08003328
Christoph Lameter15316ba2006-01-08 01:00:43 -08003329 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003330 struct work_struct *work = per_cpu_ptr(works, cpu);
3331
3332 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003333 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003334 }
Tejun Heo93981802009-11-17 14:06:20 -08003335
3336 for_each_online_cpu(cpu)
3337 flush_work(per_cpu_ptr(works, cpu));
3338
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02003339 cpus_read_unlock();
Andrew Mortonb6136772006-06-25 05:47:49 -07003340 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003341 return 0;
3342}
3343
Alan Sterneef6a7d2010-02-12 17:39:21 +09003344/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003345 * execute_in_process_context - reliably execute the routine with user context
3346 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003347 * @ew: guaranteed storage for the execute work structure (must
3348 * be available when the work executes)
3349 *
3350 * Executes the function immediately if process context is available,
3351 * otherwise schedules the function for delayed execution.
3352 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003353 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003354 * 1 - function was scheduled for execution
3355 */
David Howells65f27f32006-11-22 14:55:48 +00003356int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003357{
3358 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003359 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003360 return 0;
3361 }
3362
David Howells65f27f32006-11-22 14:55:48 +00003363 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003364 schedule_work(&ew->work);
3365
3366 return 1;
3367}
3368EXPORT_SYMBOL_GPL(execute_in_process_context);
3369
Tejun Heo7a4e3442013-03-12 11:30:00 -07003370/**
3371 * free_workqueue_attrs - free a workqueue_attrs
3372 * @attrs: workqueue_attrs to free
3373 *
3374 * Undo alloc_workqueue_attrs().
3375 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003376void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003377{
3378 if (attrs) {
3379 free_cpumask_var(attrs->cpumask);
3380 kfree(attrs);
3381 }
3382}
3383
3384/**
3385 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003386 *
3387 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003388 * return it.
3389 *
3390 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003391 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003392struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003393{
3394 struct workqueue_attrs *attrs;
3395
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003396 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003397 if (!attrs)
3398 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003399 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003400 goto fail;
3401
Tejun Heo13e2e552013-04-01 11:23:31 -07003402 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003403 return attrs;
3404fail:
3405 free_workqueue_attrs(attrs);
3406 return NULL;
3407}
3408
Tejun Heo29c91e92013-03-12 11:30:03 -07003409static void copy_workqueue_attrs(struct workqueue_attrs *to,
3410 const struct workqueue_attrs *from)
3411{
3412 to->nice = from->nice;
3413 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003414 /*
3415 * Unlike hash and equality test, this function doesn't ignore
3416 * ->no_numa as it is used for both pool and wq attrs. Instead,
3417 * get_unbound_pool() explicitly clears ->no_numa after copying.
3418 */
3419 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003420}
3421
Tejun Heo29c91e92013-03-12 11:30:03 -07003422/* hash value of the content of @attr */
3423static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3424{
3425 u32 hash = 0;
3426
3427 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003428 hash = jhash(cpumask_bits(attrs->cpumask),
3429 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003430 return hash;
3431}
3432
3433/* content equality test */
3434static bool wqattrs_equal(const struct workqueue_attrs *a,
3435 const struct workqueue_attrs *b)
3436{
3437 if (a->nice != b->nice)
3438 return false;
3439 if (!cpumask_equal(a->cpumask, b->cpumask))
3440 return false;
3441 return true;
3442}
3443
Tejun Heo7a4e3442013-03-12 11:30:00 -07003444/**
3445 * init_worker_pool - initialize a newly zalloc'd worker_pool
3446 * @pool: worker_pool to initialize
3447 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303448 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003449 *
3450 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003451 * inside @pool proper are initialized and put_unbound_pool() can be called
3452 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003453 */
3454static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003455{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003456 raw_spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003457 pool->id = -1;
3458 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003459 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003460 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003461 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003462 INIT_LIST_HEAD(&pool->worklist);
3463 INIT_LIST_HEAD(&pool->idle_list);
3464 hash_init(pool->busy_hash);
3465
Kees Cook32a6c722017-10-16 15:58:25 -07003466 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003467
Kees Cook32a6c722017-10-16 15:58:25 -07003468 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003469
Lai Jiangshanda028462014-05-20 17:46:31 +08003470 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003471
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003472 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003473 INIT_HLIST_NODE(&pool->hash_node);
3474 pool->refcnt = 1;
3475
3476 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003477 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003478 if (!pool->attrs)
3479 return -ENOMEM;
3480 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003481}
3482
Bart Van Assche669de8b2019-02-14 15:00:54 -08003483#ifdef CONFIG_LOCKDEP
3484static void wq_init_lockdep(struct workqueue_struct *wq)
3485{
3486 char *lock_name;
3487
3488 lockdep_register_key(&wq->key);
3489 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3490 if (!lock_name)
3491 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003492
3493 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003494 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3495}
3496
3497static void wq_unregister_lockdep(struct workqueue_struct *wq)
3498{
3499 lockdep_unregister_key(&wq->key);
3500}
3501
3502static void wq_free_lockdep(struct workqueue_struct *wq)
3503{
3504 if (wq->lock_name != wq->name)
3505 kfree(wq->lock_name);
3506}
3507#else
3508static void wq_init_lockdep(struct workqueue_struct *wq)
3509{
3510}
3511
3512static void wq_unregister_lockdep(struct workqueue_struct *wq)
3513{
3514}
3515
3516static void wq_free_lockdep(struct workqueue_struct *wq)
3517{
3518}
3519#endif
3520
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003521static void rcu_free_wq(struct rcu_head *rcu)
3522{
3523 struct workqueue_struct *wq =
3524 container_of(rcu, struct workqueue_struct, rcu);
3525
Bart Van Assche669de8b2019-02-14 15:00:54 -08003526 wq_free_lockdep(wq);
3527
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003528 if (!(wq->flags & WQ_UNBOUND))
3529 free_percpu(wq->cpu_pwqs);
3530 else
3531 free_workqueue_attrs(wq->unbound_attrs);
3532
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003533 kfree(wq);
3534}
3535
Tejun Heo29c91e92013-03-12 11:30:03 -07003536static void rcu_free_pool(struct rcu_head *rcu)
3537{
3538 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3539
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003540 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003541 free_workqueue_attrs(pool->attrs);
3542 kfree(pool);
3543}
3544
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003545/* This returns with the lock held on success (pool manager is inactive). */
3546static bool wq_manager_inactive(struct worker_pool *pool)
3547{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003548 raw_spin_lock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003549
3550 if (pool->flags & POOL_MANAGER_ACTIVE) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003551 raw_spin_unlock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003552 return false;
3553 }
3554 return true;
3555}
3556
Tejun Heo29c91e92013-03-12 11:30:03 -07003557/**
3558 * put_unbound_pool - put a worker_pool
3559 * @pool: worker_pool to put
3560 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003561 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003562 * safe manner. get_unbound_pool() calls this function on its failure path
3563 * and this function should be able to release pools which went through,
3564 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003565 *
3566 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003567 */
3568static void put_unbound_pool(struct worker_pool *pool)
3569{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003570 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003571 struct worker *worker;
3572
Tejun Heoa892cac2013-04-01 11:23:32 -07003573 lockdep_assert_held(&wq_pool_mutex);
3574
3575 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003576 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003577
3578 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003579 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003580 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003581 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003582
3583 /* release id and unhash */
3584 if (pool->id >= 0)
3585 idr_remove(&worker_pool_idr, pool->id);
3586 hash_del(&pool->hash_node);
3587
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003588 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003589 * Become the manager and destroy all workers. This prevents
3590 * @pool's workers from blocking on attach_mutex. We're the last
3591 * manager and @pool gets freed with the flag set.
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003592 * Because of how wq_manager_inactive() works, we will hold the
3593 * spinlock after a successful wait.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003594 */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003595 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3596 TASK_UNINTERRUPTIBLE);
Tejun Heo692b4822017-10-09 08:04:13 -07003597 pool->flags |= POOL_MANAGER_ACTIVE;
3598
Lai Jiangshan1037de32014-05-22 16:44:07 +08003599 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003600 destroy_worker(worker);
3601 WARN_ON(pool->nr_workers || pool->nr_idle);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003602 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003603
Tejun Heo1258fae2018-05-18 08:47:13 -07003604 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003605 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003606 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003607 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003608
3609 if (pool->detach_completion)
3610 wait_for_completion(pool->detach_completion);
3611
Tejun Heo29c91e92013-03-12 11:30:03 -07003612 /* shut down the timers */
3613 del_timer_sync(&pool->idle_timer);
3614 del_timer_sync(&pool->mayday_timer);
3615
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003616 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003617 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003618}
3619
3620/**
3621 * get_unbound_pool - get a worker_pool with the specified attributes
3622 * @attrs: the attributes of the worker_pool to get
3623 *
3624 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3625 * reference count and return it. If there already is a matching
3626 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003627 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003628 *
3629 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003630 *
3631 * Return: On success, a worker_pool with the same attributes as @attrs.
3632 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003633 */
3634static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3635{
Tejun Heo29c91e92013-03-12 11:30:03 -07003636 u32 hash = wqattrs_hash(attrs);
3637 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003638 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003639 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003640
Tejun Heoa892cac2013-04-01 11:23:32 -07003641 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003642
3643 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003644 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3645 if (wqattrs_equal(pool->attrs, attrs)) {
3646 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003647 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003648 }
3649 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003650
Xunlei Pange22735842015-10-09 11:53:12 +08003651 /* if cpumask is contained inside a NUMA node, we belong to that node */
3652 if (wq_numa_enabled) {
3653 for_each_node(node) {
3654 if (cpumask_subset(attrs->cpumask,
3655 wq_numa_possible_cpumask[node])) {
3656 target_node = node;
3657 break;
3658 }
3659 }
3660 }
3661
Tejun Heo29c91e92013-03-12 11:30:03 -07003662 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003663 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003664 if (!pool || init_worker_pool(pool) < 0)
3665 goto fail;
3666
Tejun Heo8864b4e2013-03-12 11:30:04 -07003667 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003668 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003669 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003670
Shaohua Li2865a8f2013-08-01 09:56:36 +08003671 /*
3672 * no_numa isn't a worker_pool attribute, always clear it. See
3673 * 'struct workqueue_attrs' comments for detail.
3674 */
3675 pool->attrs->no_numa = false;
3676
Tejun Heo29c91e92013-03-12 11:30:03 -07003677 if (worker_pool_assign_id(pool) < 0)
3678 goto fail;
3679
3680 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003681 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003682 goto fail;
3683
Tejun Heo29c91e92013-03-12 11:30:03 -07003684 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003685 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003686
Tejun Heo29c91e92013-03-12 11:30:03 -07003687 return pool;
3688fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003689 if (pool)
3690 put_unbound_pool(pool);
3691 return NULL;
3692}
3693
Tejun Heo8864b4e2013-03-12 11:30:04 -07003694static void rcu_free_pwq(struct rcu_head *rcu)
3695{
3696 kmem_cache_free(pwq_cache,
3697 container_of(rcu, struct pool_workqueue, rcu));
3698}
3699
3700/*
3701 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3702 * and needs to be destroyed.
3703 */
3704static void pwq_unbound_release_workfn(struct work_struct *work)
3705{
3706 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3707 unbound_release_work);
3708 struct workqueue_struct *wq = pwq->wq;
3709 struct worker_pool *pool = pwq->pool;
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003710 bool is_last = false;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003711
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003712 /*
3713 * when @pwq is not linked, it doesn't hold any reference to the
3714 * @wq, and @wq is invalid to access.
3715 */
3716 if (!list_empty(&pwq->pwqs_node)) {
3717 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3718 return;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003719
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003720 mutex_lock(&wq->mutex);
3721 list_del_rcu(&pwq->pwqs_node);
3722 is_last = list_empty(&wq->pwqs);
3723 mutex_unlock(&wq->mutex);
3724 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003725
Tejun Heoa892cac2013-04-01 11:23:32 -07003726 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003727 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003728 mutex_unlock(&wq_pool_mutex);
3729
Paul E. McKenney25b00772018-11-06 19:18:45 -08003730 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003731
3732 /*
3733 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003734 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003735 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003736 if (is_last) {
3737 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003738 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003739 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003740}
3741
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003742/**
Tejun Heo699ce092013-03-13 16:51:35 -07003743 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003744 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003745 *
Tejun Heo699ce092013-03-13 16:51:35 -07003746 * If @pwq isn't freezing, set @pwq->max_active to the associated
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003747 * workqueue's saved_max_active and activate inactive work items
Tejun Heo699ce092013-03-13 16:51:35 -07003748 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003749 */
Tejun Heo699ce092013-03-13 16:51:35 -07003750static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003751{
Tejun Heo699ce092013-03-13 16:51:35 -07003752 struct workqueue_struct *wq = pwq->wq;
3753 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003754 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003755
Tejun Heo699ce092013-03-13 16:51:35 -07003756 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003757 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003758
3759 /* fast exit for non-freezable wqs */
3760 if (!freezable && pwq->max_active == wq->saved_max_active)
3761 return;
3762
Tejun Heo3347fa02016-09-16 15:49:32 -04003763 /* this function can be called during early boot w/ irq disabled */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003764 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003765
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003766 /*
3767 * During [un]freezing, the caller is responsible for ensuring that
3768 * this function is called at least once after @workqueue_freezing
3769 * is updated and visible.
3770 */
3771 if (!freezable || !workqueue_freezing) {
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003772 bool kick = false;
3773
Tejun Heo699ce092013-03-13 16:51:35 -07003774 pwq->max_active = wq->saved_max_active;
3775
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003776 while (!list_empty(&pwq->inactive_works) &&
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003777 pwq->nr_active < pwq->max_active) {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003778 pwq_activate_first_inactive(pwq);
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003779 kick = true;
3780 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003781
3782 /*
3783 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003784 * max_active is bumped. In realtime scenarios, always kicking a
3785 * worker will cause interference on the isolated cpu cores, so
3786 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003787 */
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003788 if (kick)
3789 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003790 } else {
3791 pwq->max_active = 0;
3792 }
3793
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003794 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003795}
3796
Cai Huoqing67dc8322021-07-31 08:01:29 +08003797/* initialize newly allocated @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003798static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3799 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003800{
3801 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3802
Tejun Heoe50aba92013-04-01 11:23:35 -07003803 memset(pwq, 0, sizeof(*pwq));
3804
Tejun Heod2c1d402013-03-12 11:30:04 -07003805 pwq->pool = pool;
3806 pwq->wq = wq;
3807 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003808 pwq->refcnt = 1;
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003809 INIT_LIST_HEAD(&pwq->inactive_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003810 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003811 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003812 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003813}
Tejun Heod2c1d402013-03-12 11:30:04 -07003814
Tejun Heof147f292013-04-01 11:23:35 -07003815/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003816static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003817{
3818 struct workqueue_struct *wq = pwq->wq;
3819
3820 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003821
Tejun Heo1befcf32013-04-01 11:23:35 -07003822 /* may be called multiple times, ignore if already linked */
3823 if (!list_empty(&pwq->pwqs_node))
3824 return;
3825
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003826 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003827 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003828
3829 /* sync max_active to the current setting */
3830 pwq_adjust_max_active(pwq);
3831
3832 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003833 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003834}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003835
Tejun Heof147f292013-04-01 11:23:35 -07003836/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3837static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3838 const struct workqueue_attrs *attrs)
3839{
3840 struct worker_pool *pool;
3841 struct pool_workqueue *pwq;
3842
3843 lockdep_assert_held(&wq_pool_mutex);
3844
3845 pool = get_unbound_pool(attrs);
3846 if (!pool)
3847 return NULL;
3848
Tejun Heoe50aba92013-04-01 11:23:35 -07003849 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003850 if (!pwq) {
3851 put_unbound_pool(pool);
3852 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003853 }
Tejun Heo6029a912013-04-01 11:23:34 -07003854
Tejun Heof147f292013-04-01 11:23:35 -07003855 init_pwq(pwq, wq, pool);
3856 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003857}
3858
Tejun Heo4c16bd32013-04-01 11:23:36 -07003859/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003860 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003861 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003862 * @node: the target NUMA node
3863 * @cpu_going_down: if >= 0, the CPU to consider as offline
3864 * @cpumask: outarg, the resulting cpumask
3865 *
3866 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3867 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003868 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003869 *
3870 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3871 * enabled and @node has online CPUs requested by @attrs, the returned
3872 * cpumask is the intersection of the possible CPUs of @node and
3873 * @attrs->cpumask.
3874 *
3875 * The caller is responsible for ensuring that the cpumask of @node stays
3876 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003877 *
3878 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3879 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003880 */
3881static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3882 int cpu_going_down, cpumask_t *cpumask)
3883{
Tejun Heod55262c2013-04-01 11:23:38 -07003884 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003885 goto use_dfl;
3886
3887 /* does @node have any online CPUs @attrs wants? */
3888 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3889 if (cpu_going_down >= 0)
3890 cpumask_clear_cpu(cpu_going_down, cpumask);
3891
3892 if (cpumask_empty(cpumask))
3893 goto use_dfl;
3894
3895 /* yeap, return possible CPUs in @node that @attrs wants */
3896 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003897
3898 if (cpumask_empty(cpumask)) {
3899 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3900 "possible intersect\n");
3901 return false;
3902 }
3903
Tejun Heo4c16bd32013-04-01 11:23:36 -07003904 return !cpumask_equal(cpumask, attrs->cpumask);
3905
3906use_dfl:
3907 cpumask_copy(cpumask, attrs->cpumask);
3908 return false;
3909}
3910
Tejun Heo1befcf32013-04-01 11:23:35 -07003911/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3912static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3913 int node,
3914 struct pool_workqueue *pwq)
3915{
3916 struct pool_workqueue *old_pwq;
3917
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003918 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003919 lockdep_assert_held(&wq->mutex);
3920
3921 /* link_pwq() can handle duplicate calls */
3922 link_pwq(pwq);
3923
3924 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3925 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3926 return old_pwq;
3927}
3928
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003929/* context to store the prepared attrs & pwqs before applying */
3930struct apply_wqattrs_ctx {
3931 struct workqueue_struct *wq; /* target workqueue */
3932 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003933 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003934 struct pool_workqueue *dfl_pwq;
3935 struct pool_workqueue *pwq_tbl[];
3936};
3937
3938/* free the resources after success or abort */
3939static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3940{
3941 if (ctx) {
3942 int node;
3943
3944 for_each_node(node)
3945 put_pwq_unlocked(ctx->pwq_tbl[node]);
3946 put_pwq_unlocked(ctx->dfl_pwq);
3947
3948 free_workqueue_attrs(ctx->attrs);
3949
3950 kfree(ctx);
3951 }
3952}
3953
3954/* allocate the attrs and pwqs for later installation */
3955static struct apply_wqattrs_ctx *
3956apply_wqattrs_prepare(struct workqueue_struct *wq,
3957 const struct workqueue_attrs *attrs)
3958{
3959 struct apply_wqattrs_ctx *ctx;
3960 struct workqueue_attrs *new_attrs, *tmp_attrs;
3961 int node;
3962
3963 lockdep_assert_held(&wq_pool_mutex);
3964
Kees Cookacafe7e2018-05-08 13:45:50 -07003965 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003966
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003967 new_attrs = alloc_workqueue_attrs();
3968 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003969 if (!ctx || !new_attrs || !tmp_attrs)
3970 goto out_free;
3971
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003972 /*
3973 * Calculate the attrs of the default pwq.
3974 * If the user configured cpumask doesn't overlap with the
3975 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3976 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003977 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003978 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003979 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3980 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003981
3982 /*
3983 * We may create multiple pwqs with differing cpumasks. Make a
3984 * copy of @new_attrs which will be modified and used to obtain
3985 * pools.
3986 */
3987 copy_workqueue_attrs(tmp_attrs, new_attrs);
3988
3989 /*
3990 * If something goes wrong during CPU up/down, we'll fall back to
3991 * the default pwq covering whole @attrs->cpumask. Always create
3992 * it even if we don't use it immediately.
3993 */
3994 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3995 if (!ctx->dfl_pwq)
3996 goto out_free;
3997
3998 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003999 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004000 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
4001 if (!ctx->pwq_tbl[node])
4002 goto out_free;
4003 } else {
4004 ctx->dfl_pwq->refcnt++;
4005 ctx->pwq_tbl[node] = ctx->dfl_pwq;
4006 }
4007 }
4008
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004009 /* save the user configured attrs and sanitize it. */
4010 copy_workqueue_attrs(new_attrs, attrs);
4011 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004012 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004013
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004014 ctx->wq = wq;
4015 free_workqueue_attrs(tmp_attrs);
4016 return ctx;
4017
4018out_free:
4019 free_workqueue_attrs(tmp_attrs);
4020 free_workqueue_attrs(new_attrs);
4021 apply_wqattrs_cleanup(ctx);
4022 return NULL;
4023}
4024
4025/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
4026static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
4027{
4028 int node;
4029
4030 /* all pwqs have been created successfully, let's install'em */
4031 mutex_lock(&ctx->wq->mutex);
4032
4033 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
4034
4035 /* save the previous pwq and install the new one */
4036 for_each_node(node)
4037 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4038 ctx->pwq_tbl[node]);
4039
4040 /* @dfl_pwq might not have been used, ensure it's linked */
4041 link_pwq(ctx->dfl_pwq);
4042 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
4043
4044 mutex_unlock(&ctx->wq->mutex);
4045}
4046
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004047static void apply_wqattrs_lock(void)
4048{
4049 /* CPUs should stay stable across pwq creations and installations */
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004050 cpus_read_lock();
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004051 mutex_lock(&wq_pool_mutex);
4052}
4053
4054static void apply_wqattrs_unlock(void)
4055{
4056 mutex_unlock(&wq_pool_mutex);
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004057 cpus_read_unlock();
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004058}
4059
4060static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4061 const struct workqueue_attrs *attrs)
4062{
4063 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004064
4065 /* only unbound workqueues can change attributes */
4066 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4067 return -EINVAL;
4068
4069 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004070 if (!list_empty(&wq->pwqs)) {
4071 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4072 return -EINVAL;
4073
4074 wq->flags &= ~__WQ_ORDERED;
4075 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004076
4077 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004078 if (!ctx)
4079 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004080
4081 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004082 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004083 apply_wqattrs_cleanup(ctx);
4084
wanghaibin62011712016-01-07 20:38:59 +08004085 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004086}
4087
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004088/**
4089 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4090 * @wq: the target workqueue
4091 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4092 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004093 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4094 * machines, this function maps a separate pwq to each NUMA node with
4095 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4096 * NUMA node it was issued on. Older pwqs are released as in-flight work
4097 * items finish. Note that a work item which repeatedly requeues itself
4098 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004099 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004100 * Performs GFP_KERNEL allocations.
4101 *
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004102 * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
Daniel Jordan509b3202019-09-05 21:40:23 -04004103 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004104 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004105 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004106int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004107 const struct workqueue_attrs *attrs)
4108{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004109 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004110
Daniel Jordan509b3202019-09-05 21:40:23 -04004111 lockdep_assert_cpus_held();
4112
4113 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004114 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004115 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004116
Tejun Heo48621252013-04-01 11:23:31 -07004117 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004118}
4119
Tejun Heo4c16bd32013-04-01 11:23:36 -07004120/**
4121 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4122 * @wq: the target workqueue
4123 * @cpu: the CPU coming up or going down
4124 * @online: whether @cpu is coming up or going down
4125 *
4126 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4127 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4128 * @wq accordingly.
4129 *
4130 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4131 * falls back to @wq->dfl_pwq which may not be optimal but is always
4132 * correct.
4133 *
4134 * Note that when the last allowed CPU of a NUMA node goes offline for a
4135 * workqueue with a cpumask spanning multiple nodes, the workers which were
4136 * already executing the work items for the workqueue will lose their CPU
4137 * affinity and may execute on any CPU. This is similar to how per-cpu
4138 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4139 * affinity, it's the user's responsibility to flush the work item from
4140 * CPU_DOWN_PREPARE.
4141 */
4142static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4143 bool online)
4144{
4145 int node = cpu_to_node(cpu);
4146 int cpu_off = online ? -1 : cpu;
4147 struct pool_workqueue *old_pwq = NULL, *pwq;
4148 struct workqueue_attrs *target_attrs;
4149 cpumask_t *cpumask;
4150
4151 lockdep_assert_held(&wq_pool_mutex);
4152
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004153 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4154 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004155 return;
4156
4157 /*
4158 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4159 * Let's use a preallocated one. The following buf is protected by
4160 * CPU hotplug exclusion.
4161 */
4162 target_attrs = wq_update_unbound_numa_attrs_buf;
4163 cpumask = target_attrs->cpumask;
4164
Tejun Heo4c16bd32013-04-01 11:23:36 -07004165 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4166 pwq = unbound_pwq_by_node(wq, node);
4167
4168 /*
4169 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004170 * different from the default pwq's, we need to compare it to @pwq's
4171 * and create a new one if they don't match. If the target cpumask
4172 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004173 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004174 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004175 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004176 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004177 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004178 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004179 }
4180
Tejun Heo4c16bd32013-04-01 11:23:36 -07004181 /* create a new pwq */
4182 pwq = alloc_unbound_pwq(wq, target_attrs);
4183 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004184 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4185 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004186 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004187 }
4188
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004189 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004190 mutex_lock(&wq->mutex);
4191 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4192 goto out_unlock;
4193
4194use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004195 mutex_lock(&wq->mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004196 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004197 get_pwq(wq->dfl_pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004198 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004199 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4200out_unlock:
4201 mutex_unlock(&wq->mutex);
4202 put_pwq_unlocked(old_pwq);
4203}
4204
Tejun Heo30cdf2492013-03-12 11:29:57 -07004205static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004206{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004207 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004208 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004209
Tejun Heo30cdf2492013-03-12 11:29:57 -07004210 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004211 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4212 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004213 return -ENOMEM;
4214
4215 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004216 struct pool_workqueue *pwq =
4217 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004218 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004219 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004220
Tejun Heof147f292013-04-01 11:23:35 -07004221 init_pwq(pwq, wq, &cpu_pools[highpri]);
4222
4223 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004224 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004225 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004226 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004227 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004228 }
4229
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004230 cpus_read_lock();
Daniel Jordan509b3202019-09-05 21:40:23 -04004231 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004232 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4233 /* there should only be single pwq for ordering guarantee */
4234 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4235 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4236 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004237 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004238 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004239 }
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004240 cpus_read_unlock();
Daniel Jordan509b3202019-09-05 21:40:23 -04004241
4242 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004243}
4244
Tejun Heof3421792010-07-02 10:03:51 +02004245static int wq_clamp_max_active(int max_active, unsigned int flags,
4246 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004247{
Tejun Heof3421792010-07-02 10:03:51 +02004248 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4249
4250 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004251 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4252 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004253
Tejun Heof3421792010-07-02 10:03:51 +02004254 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004255}
4256
Tejun Heo983c7512018-01-08 05:38:32 -08004257/*
4258 * Workqueues which may be used during memory reclaim should have a rescuer
4259 * to guarantee forward progress.
4260 */
4261static int init_rescuer(struct workqueue_struct *wq)
4262{
4263 struct worker *rescuer;
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004264 int ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004265
4266 if (!(wq->flags & WQ_MEM_RECLAIM))
4267 return 0;
4268
4269 rescuer = alloc_worker(NUMA_NO_NODE);
4270 if (!rescuer)
4271 return -ENOMEM;
4272
4273 rescuer->rescue_wq = wq;
4274 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
Sean Fuf187b692020-04-29 12:04:13 +08004275 if (IS_ERR(rescuer->task)) {
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004276 ret = PTR_ERR(rescuer->task);
Tejun Heo983c7512018-01-08 05:38:32 -08004277 kfree(rescuer);
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004278 return ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004279 }
4280
4281 wq->rescuer = rescuer;
4282 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4283 wake_up_process(rescuer->task);
4284
4285 return 0;
4286}
4287
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004288__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004289struct workqueue_struct *alloc_workqueue(const char *fmt,
4290 unsigned int flags,
4291 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004292{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004293 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004294 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004295 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004296 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004297
Tejun Heo5c0338c2017-07-18 18:41:52 -04004298 /*
4299 * Unbound && max_active == 1 used to imply ordered, which is no
4300 * longer the case on NUMA machines due to per-node pools. While
4301 * alloc_ordered_workqueue() is the right way to create an ordered
4302 * workqueue, keep the previous behavior to avoid subtle breakages
4303 * on NUMA.
4304 */
4305 if ((flags & WQ_UNBOUND) && max_active == 1)
4306 flags |= __WQ_ORDERED;
4307
Viresh Kumarcee22a12013-04-08 16:45:40 +05304308 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4309 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4310 flags |= WQ_UNBOUND;
4311
Tejun Heoecf68812013-04-01 11:23:34 -07004312 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004313 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004314 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004315
4316 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004317 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004318 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004319
Tejun Heo6029a912013-04-01 11:23:34 -07004320 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004321 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004322 if (!wq->unbound_attrs)
4323 goto err_free_wq;
4324 }
4325
Bart Van Assche669de8b2019-02-14 15:00:54 -08004326 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004327 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004328 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004329
Tejun Heod320c032010-06-29 10:07:14 +02004330 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004331 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004332
Tejun Heob196be82012-01-10 15:11:35 -08004333 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004334 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004335 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004336 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004337 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004338 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004339 INIT_LIST_HEAD(&wq->flusher_queue);
4340 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004341 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004342
Bart Van Assche669de8b2019-02-14 15:00:54 -08004343 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004344 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004345
Tejun Heo30cdf2492013-03-12 11:29:57 -07004346 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004347 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004348
Tejun Heo40c17f72018-01-08 05:38:37 -08004349 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004350 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004351
Tejun Heo226223a2013-03-12 11:30:05 -07004352 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4353 goto err_destroy;
4354
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004355 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004356 * wq_pool_mutex protects global freeze state and workqueues list.
4357 * Grab it, adjust max_active and add the new @wq to workqueues
4358 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004359 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004360 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004361
Lai Jiangshana357fc02013-03-25 16:57:19 -07004362 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004363 for_each_pwq(pwq, wq)
4364 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004365 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004366
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004367 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004368
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004369 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004370
Oleg Nesterov3af244332007-05-09 02:34:09 -07004371 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004372
Bart Van Assche82efcab2019-03-11 16:02:55 -07004373err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004374 wq_unregister_lockdep(wq);
4375 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004376err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004377 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004378 kfree(wq);
4379 return NULL;
4380err_destroy:
4381 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004382 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004383}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004384EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004385
Tejun Heoc29eb852019-09-23 11:08:58 -07004386static bool pwq_busy(struct pool_workqueue *pwq)
4387{
4388 int i;
4389
4390 for (i = 0; i < WORK_NR_COLORS; i++)
4391 if (pwq->nr_in_flight[i])
4392 return true;
4393
4394 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4395 return true;
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004396 if (pwq->nr_active || !list_empty(&pwq->inactive_works))
Tejun Heoc29eb852019-09-23 11:08:58 -07004397 return true;
4398
4399 return false;
4400}
4401
Oleg Nesterov3af244332007-05-09 02:34:09 -07004402/**
4403 * destroy_workqueue - safely terminate a workqueue
4404 * @wq: target workqueue
4405 *
4406 * Safely destroy a workqueue. All work currently pending will be done first.
4407 */
4408void destroy_workqueue(struct workqueue_struct *wq)
4409{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004410 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004411 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004412
Tejun Heodef98c82019-09-18 18:43:40 -07004413 /*
4414 * Remove it from sysfs first so that sanity check failure doesn't
4415 * lead to sysfs name conflicts.
4416 */
4417 workqueue_sysfs_unregister(wq);
4418
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004419 /* drain it before proceeding with destruction */
4420 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004421
Tejun Heodef98c82019-09-18 18:43:40 -07004422 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4423 if (wq->rescuer) {
4424 struct worker *rescuer = wq->rescuer;
4425
4426 /* this prevents new queueing */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004427 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004428 wq->rescuer = NULL;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004429 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004430
4431 /* rescuer will empty maydays list before exiting */
4432 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004433 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004434 }
4435
Tejun Heoc29eb852019-09-23 11:08:58 -07004436 /*
4437 * Sanity checks - grab all the locks so that we wait for all
4438 * in-flight operations which may do put_pwq().
4439 */
4440 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004441 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004442 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004443 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heoc29eb852019-09-23 11:08:58 -07004444 if (WARN_ON(pwq_busy(pwq))) {
Kefeng Wang1d9a6152019-11-28 08:47:49 +08004445 pr_warn("%s: %s has the following busy pwq\n",
4446 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004447 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004448 raw_spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004449 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004450 mutex_unlock(&wq_pool_mutex);
Imran Khan55df0932021-10-20 14:09:00 +11004451 show_one_workqueue(wq);
Tejun Heo6183c002013-03-12 11:29:57 -07004452 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004453 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004454 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004455 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004456 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004457
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004458 /*
4459 * wq list is used to freeze wq, remove from list after
4460 * flushing is complete in case freeze races us.
4461 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004462 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004463 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004464
Tejun Heo8864b4e2013-03-12 11:30:04 -07004465 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004466 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004467 /*
4468 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004469 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004470 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004471 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004472 } else {
4473 /*
4474 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004475 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4476 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004477 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004478 for_each_node(node) {
4479 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4480 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4481 put_pwq_unlocked(pwq);
4482 }
4483
4484 /*
4485 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4486 * put. Don't access it afterwards.
4487 */
4488 pwq = wq->dfl_pwq;
4489 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004490 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004491 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004492}
4493EXPORT_SYMBOL_GPL(destroy_workqueue);
4494
Tejun Heodcd989c2010-06-29 10:07:14 +02004495/**
4496 * workqueue_set_max_active - adjust max_active of a workqueue
4497 * @wq: target workqueue
4498 * @max_active: new max_active value.
4499 *
4500 * Set max_active of @wq to @max_active.
4501 *
4502 * CONTEXT:
4503 * Don't call from IRQ context.
4504 */
4505void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4506{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004507 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004508
Tejun Heo8719dce2013-03-12 11:30:04 -07004509 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004510 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004511 return;
4512
Tejun Heof3421792010-07-02 10:03:51 +02004513 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004514
Lai Jiangshana357fc02013-03-25 16:57:19 -07004515 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004516
Tejun Heo0a94efb2017-07-23 08:36:15 -04004517 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004518 wq->saved_max_active = max_active;
4519
Tejun Heo699ce092013-03-13 16:51:35 -07004520 for_each_pwq(pwq, wq)
4521 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004522
Lai Jiangshana357fc02013-03-25 16:57:19 -07004523 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004524}
4525EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4526
4527/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004528 * current_work - retrieve %current task's work struct
4529 *
4530 * Determine if %current task is a workqueue worker and what it's working on.
4531 * Useful to find out the context that the %current task is running in.
4532 *
4533 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4534 */
4535struct work_struct *current_work(void)
4536{
4537 struct worker *worker = current_wq_worker();
4538
4539 return worker ? worker->current_work : NULL;
4540}
4541EXPORT_SYMBOL(current_work);
4542
4543/**
Tejun Heoe62676162013-03-12 17:41:37 -07004544 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4545 *
4546 * Determine whether %current is a workqueue rescuer. Can be used from
4547 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004548 *
4549 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004550 */
4551bool current_is_workqueue_rescuer(void)
4552{
4553 struct worker *worker = current_wq_worker();
4554
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004555 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004556}
4557
4558/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004559 * workqueue_congested - test whether a workqueue is congested
4560 * @cpu: CPU in question
4561 * @wq: target workqueue
4562 *
4563 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4564 * no synchronization around this function and the test result is
4565 * unreliable and only useful as advisory hints or for debugging.
4566 *
Tejun Heod3251852013-05-10 11:10:17 -07004567 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4568 * Note that both per-cpu and unbound workqueues may be associated with
4569 * multiple pool_workqueues which have separate congested states. A
4570 * workqueue being congested on one CPU doesn't mean the workqueue is also
4571 * contested on other CPUs / NUMA nodes.
4572 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004573 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004574 * %true if congested, %false otherwise.
4575 */
Tejun Heod84ff052013-03-12 11:29:59 -07004576bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004577{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004578 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004579 bool ret;
4580
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004581 rcu_read_lock();
4582 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004583
Tejun Heod3251852013-05-10 11:10:17 -07004584 if (cpu == WORK_CPU_UNBOUND)
4585 cpu = smp_processor_id();
4586
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004587 if (!(wq->flags & WQ_UNBOUND))
4588 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4589 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004590 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004591
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004592 ret = !list_empty(&pwq->inactive_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004593 preempt_enable();
4594 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004595
4596 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004597}
4598EXPORT_SYMBOL_GPL(workqueue_congested);
4599
4600/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004601 * work_busy - test whether a work is currently pending or running
4602 * @work: the work to be tested
4603 *
4604 * Test whether @work is currently pending or running. There is no
4605 * synchronization around this function and the test result is
4606 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004607 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004608 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004609 * OR'd bitmask of WORK_BUSY_* bits.
4610 */
4611unsigned int work_busy(struct work_struct *work)
4612{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004613 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004614 unsigned long flags;
4615 unsigned int ret = 0;
4616
Tejun Heodcd989c2010-06-29 10:07:14 +02004617 if (work_pending(work))
4618 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004619
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004620 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004621 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004622 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004623 raw_spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004624 if (find_worker_executing_work(pool, work))
4625 ret |= WORK_BUSY_RUNNING;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004626 raw_spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004627 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004628 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004629
4630 return ret;
4631}
4632EXPORT_SYMBOL_GPL(work_busy);
4633
Tejun Heo3d1cb202013-04-30 15:27:22 -07004634/**
4635 * set_worker_desc - set description for the current work item
4636 * @fmt: printf-style format string
4637 * @...: arguments for the format string
4638 *
4639 * This function can be called by a running work function to describe what
4640 * the work item is about. If the worker task gets dumped, this
4641 * information will be printed out together to help debugging. The
4642 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4643 */
4644void set_worker_desc(const char *fmt, ...)
4645{
4646 struct worker *worker = current_wq_worker();
4647 va_list args;
4648
4649 if (worker) {
4650 va_start(args, fmt);
4651 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4652 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004653 }
4654}
Steffen Maier5c750d52018-05-17 19:14:57 +02004655EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004656
4657/**
4658 * print_worker_info - print out worker information and description
4659 * @log_lvl: the log level to use when printing
4660 * @task: target task
4661 *
4662 * If @task is a worker and currently executing a work item, print out the
4663 * name of the workqueue being serviced and worker description set with
4664 * set_worker_desc() by the currently executing work item.
4665 *
4666 * This function can be safely called on any task as long as the
4667 * task_struct itself is accessible. While safe, this function isn't
4668 * synchronized and may print out mixups or garbages of limited length.
4669 */
4670void print_worker_info(const char *log_lvl, struct task_struct *task)
4671{
4672 work_func_t *fn = NULL;
4673 char name[WQ_NAME_LEN] = { };
4674 char desc[WORKER_DESC_LEN] = { };
4675 struct pool_workqueue *pwq = NULL;
4676 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004677 struct worker *worker;
4678
4679 if (!(task->flags & PF_WQ_WORKER))
4680 return;
4681
4682 /*
4683 * This function is called without any synchronization and @task
4684 * could be in any state. Be careful with dereferences.
4685 */
Petr Mladeke7005912016-10-11 13:55:17 -07004686 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004687
4688 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004689 * Carefully copy the associated workqueue's workfn, name and desc.
4690 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004691 */
Christoph Hellwigfe557312020-06-17 09:37:53 +02004692 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4693 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4694 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4695 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4696 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004697
4698 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004699 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004700 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004701 pr_cont(" (%s)", desc);
4702 pr_cont("\n");
4703 }
4704}
4705
Tejun Heo3494fc32015-03-09 09:22:28 -04004706static void pr_cont_pool_info(struct worker_pool *pool)
4707{
4708 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4709 if (pool->node != NUMA_NO_NODE)
4710 pr_cont(" node=%d", pool->node);
4711 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4712}
4713
4714static void pr_cont_work(bool comma, struct work_struct *work)
4715{
4716 if (work->func == wq_barrier_func) {
4717 struct wq_barrier *barr;
4718
4719 barr = container_of(work, struct wq_barrier, work);
4720
4721 pr_cont("%s BAR(%d)", comma ? "," : "",
4722 task_pid_nr(barr->task));
4723 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004724 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004725 }
4726}
4727
4728static void show_pwq(struct pool_workqueue *pwq)
4729{
4730 struct worker_pool *pool = pwq->pool;
4731 struct work_struct *work;
4732 struct worker *worker;
4733 bool has_in_flight = false, has_pending = false;
4734 int bkt;
4735
4736 pr_info(" pwq %d:", pool->id);
4737 pr_cont_pool_info(pool);
4738
Tejun Heoe66b39a2019-09-25 06:59:15 -07004739 pr_cont(" active=%d/%d refcnt=%d%s\n",
4740 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004741 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4742
4743 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4744 if (worker->current_pwq == pwq) {
4745 has_in_flight = true;
4746 break;
4747 }
4748 }
4749 if (has_in_flight) {
4750 bool comma = false;
4751
4752 pr_info(" in-flight:");
4753 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4754 if (worker->current_pwq != pwq)
4755 continue;
4756
Sakari Ailusd75f7732019-03-25 21:32:28 +02004757 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004758 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004759 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004760 worker->current_func);
4761 list_for_each_entry(work, &worker->scheduled, entry)
4762 pr_cont_work(false, work);
4763 comma = true;
4764 }
4765 pr_cont("\n");
4766 }
4767
4768 list_for_each_entry(work, &pool->worklist, entry) {
4769 if (get_work_pwq(work) == pwq) {
4770 has_pending = true;
4771 break;
4772 }
4773 }
4774 if (has_pending) {
4775 bool comma = false;
4776
4777 pr_info(" pending:");
4778 list_for_each_entry(work, &pool->worklist, entry) {
4779 if (get_work_pwq(work) != pwq)
4780 continue;
4781
4782 pr_cont_work(comma, work);
4783 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4784 }
4785 pr_cont("\n");
4786 }
4787
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004788 if (!list_empty(&pwq->inactive_works)) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004789 bool comma = false;
4790
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004791 pr_info(" inactive:");
4792 list_for_each_entry(work, &pwq->inactive_works, entry) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004793 pr_cont_work(comma, work);
4794 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4795 }
4796 pr_cont("\n");
4797 }
4798}
4799
4800/**
Imran Khan55df0932021-10-20 14:09:00 +11004801 * show_one_workqueue - dump state of specified workqueue
4802 * @wq: workqueue whose state will be printed
4803 */
4804void show_one_workqueue(struct workqueue_struct *wq)
4805{
4806 struct pool_workqueue *pwq;
4807 bool idle = true;
4808 unsigned long flags;
4809
4810 for_each_pwq(pwq, wq) {
4811 if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
4812 idle = false;
4813 break;
4814 }
4815 }
4816 if (idle) /* Nothing to print for idle workqueue */
4817 return;
4818
4819 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4820
4821 for_each_pwq(pwq, wq) {
4822 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
4823 if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
4824 /*
4825 * Defer printing to avoid deadlocks in console
4826 * drivers that queue work while holding locks
4827 * also taken in their write paths.
4828 */
4829 printk_deferred_enter();
4830 show_pwq(pwq);
4831 printk_deferred_exit();
4832 }
4833 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
4834 /*
4835 * We could be printing a lot from atomic context, e.g.
4836 * sysrq-t -> show_all_workqueues(). Avoid triggering
4837 * hard lockup.
4838 */
4839 touch_nmi_watchdog();
4840 }
4841
4842}
4843
4844/**
4845 * show_one_worker_pool - dump state of specified worker pool
4846 * @pool: worker pool whose state will be printed
4847 */
4848static void show_one_worker_pool(struct worker_pool *pool)
4849{
4850 struct worker *worker;
4851 bool first = true;
4852 unsigned long flags;
4853
4854 raw_spin_lock_irqsave(&pool->lock, flags);
4855 if (pool->nr_workers == pool->nr_idle)
4856 goto next_pool;
4857 /*
4858 * Defer printing to avoid deadlocks in console drivers that
4859 * queue work while holding locks also taken in their write
4860 * paths.
4861 */
4862 printk_deferred_enter();
4863 pr_info("pool %d:", pool->id);
4864 pr_cont_pool_info(pool);
4865 pr_cont(" hung=%us workers=%d",
4866 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4867 pool->nr_workers);
4868 if (pool->manager)
4869 pr_cont(" manager: %d",
4870 task_pid_nr(pool->manager->task));
4871 list_for_each_entry(worker, &pool->idle_list, entry) {
4872 pr_cont(" %s%d", first ? "idle: " : "",
4873 task_pid_nr(worker->task));
4874 first = false;
4875 }
4876 pr_cont("\n");
4877 printk_deferred_exit();
4878next_pool:
4879 raw_spin_unlock_irqrestore(&pool->lock, flags);
4880 /*
4881 * We could be printing a lot from atomic context, e.g.
4882 * sysrq-t -> show_all_workqueues(). Avoid triggering
4883 * hard lockup.
4884 */
4885 touch_nmi_watchdog();
4886
4887}
4888
4889/**
4890 * show_all_workqueues - dump workqueue state
Tejun Heo3494fc32015-03-09 09:22:28 -04004891 *
Roger Lu7b776af2016-07-01 11:05:02 +08004892 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4893 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004894 */
Imran Khan55df0932021-10-20 14:09:00 +11004895void show_all_workqueues(void)
Tejun Heo3494fc32015-03-09 09:22:28 -04004896{
4897 struct workqueue_struct *wq;
4898 struct worker_pool *pool;
Tejun Heo3494fc32015-03-09 09:22:28 -04004899 int pi;
4900
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004901 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004902
4903 pr_info("Showing busy workqueues and worker pools:\n");
4904
Imran Khan55df0932021-10-20 14:09:00 +11004905 list_for_each_entry_rcu(wq, &workqueues, list)
4906 show_one_workqueue(wq);
Tejun Heo3494fc32015-03-09 09:22:28 -04004907
Imran Khan55df0932021-10-20 14:09:00 +11004908 for_each_pool(pool, pi)
4909 show_one_worker_pool(pool);
Tejun Heo3494fc32015-03-09 09:22:28 -04004910
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004911 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004912}
4913
Tejun Heo6b598082018-05-18 08:47:13 -07004914/* used to show worker information through /proc/PID/{comm,stat,status} */
4915void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4916{
Tejun Heo6b598082018-05-18 08:47:13 -07004917 int off;
4918
4919 /* always show the actual comm */
4920 off = strscpy(buf, task->comm, size);
4921 if (off < 0)
4922 return;
4923
Tejun Heo197f6ac2018-05-21 08:04:35 -07004924 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004925 mutex_lock(&wq_pool_attach_mutex);
4926
Tejun Heo197f6ac2018-05-21 08:04:35 -07004927 if (task->flags & PF_WQ_WORKER) {
4928 struct worker *worker = kthread_data(task);
4929 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004930
Tejun Heo197f6ac2018-05-21 08:04:35 -07004931 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004932 raw_spin_lock_irq(&pool->lock);
Tejun Heo197f6ac2018-05-21 08:04:35 -07004933 /*
4934 * ->desc tracks information (wq name or
4935 * set_worker_desc()) for the latest execution. If
4936 * current, prepend '+', otherwise '-'.
4937 */
4938 if (worker->desc[0] != '\0') {
4939 if (worker->current_work)
4940 scnprintf(buf + off, size - off, "+%s",
4941 worker->desc);
4942 else
4943 scnprintf(buf + off, size - off, "-%s",
4944 worker->desc);
4945 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004946 raw_spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004947 }
Tejun Heo6b598082018-05-18 08:47:13 -07004948 }
4949
4950 mutex_unlock(&wq_pool_attach_mutex);
4951}
4952
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004953#ifdef CONFIG_SMP
4954
Tejun Heodb7bccf2010-06-29 10:07:12 +02004955/*
4956 * CPU hotplug.
4957 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004958 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004959 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004960 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004961 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004962 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004963 * blocked draining impractical.
4964 *
Tejun Heo24647572013-01-24 11:01:33 -08004965 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004966 * running as an unbound one and allowing it to be reattached later if the
4967 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004968 */
4969
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004970static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004971{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004972 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004973 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004974
Tejun Heof02ae732013-03-12 11:30:03 -07004975 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004976 mutex_lock(&wq_pool_attach_mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004977 raw_spin_lock_irq(&pool->lock);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004978
4979 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004980 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004981 * unbound and set DISASSOCIATED. Before this, all workers
4982 * except for the ones which are still executing works from
4983 * before the last CPU down must be on the cpu. After
4984 * this, they may become diasporas.
4985 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004986 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004987 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004988
Tejun Heo24647572013-01-24 11:01:33 -08004989 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004990
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004991 raw_spin_unlock_irq(&pool->lock);
Peter Zijlstra06249732020-09-25 15:45:11 +02004992
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004993 for_each_pool_worker(worker, pool) {
4994 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshan547a77d2021-01-11 23:26:33 +08004995 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004996 }
Peter Zijlstra06249732020-09-25 15:45:11 +02004997
Tejun Heo1258fae2018-05-18 08:47:13 -07004998 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004999
Lai Jiangshaneb283422013-03-08 15:18:28 -08005000 /*
5001 * Call schedule() so that we cross rq->lock and thus can
5002 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
5003 * This is necessary as scheduler callbacks may be invoked
5004 * from other cpus.
5005 */
5006 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07005007
Lai Jiangshaneb283422013-03-08 15:18:28 -08005008 /*
5009 * Sched callbacks are disabled now. Zap nr_running.
5010 * After this, nr_running stays zero and need_more_worker()
5011 * and keep_working() are always true as long as the
5012 * worklist is not empty. This pool now behaves as an
5013 * unbound (in terms of concurrency management) pool which
5014 * are served by workers tied to the pool.
5015 */
Tejun Heoe19e3972013-01-24 11:39:44 -08005016 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08005017
5018 /*
5019 * With concurrency management just turned off, a busy
5020 * worker blocking could lead to lengthy stalls. Kick off
5021 * unbound chain execution of currently pending work items.
5022 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005023 raw_spin_lock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08005024 wake_up_worker(pool);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005025 raw_spin_unlock_irq(&pool->lock);
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 * A bound idle worker should actually be on the runqueue
5063 * of the associated CPU for local wake-ups targeting it to
5064 * work. Kick all idle workers so that they migrate to the
5065 * associated CPU. Doing this in the same loop as
5066 * replacing UNBOUND with REBOUND is safe as no worker will
5067 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07005068 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07005069 if (worker_flags & WORKER_IDLE)
5070 wake_up_process(worker->task);
5071
5072 /*
5073 * We want to clear UNBOUND but can't directly call
5074 * worker_clr_flags() or adjust nr_running. Atomically
5075 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5076 * @worker will clear REBOUND using worker_clr_flags() when
5077 * it initiates the next execution cycle thus restoring
5078 * concurrency management. Note that when or whether
5079 * @worker clears REBOUND doesn't affect correctness.
5080 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07005081 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07005082 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01005083 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07005084 * fail incorrectly leading to premature concurrency
5085 * management operations.
5086 */
5087 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5088 worker_flags |= WORKER_REBOUND;
5089 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07005090 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07005091 }
5092
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005093 raw_spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07005094}
5095
Tejun Heo7dbc7252013-03-19 13:45:21 -07005096/**
5097 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5098 * @pool: unbound pool of interest
5099 * @cpu: the CPU which is coming up
5100 *
5101 * An unbound pool may end up with a cpumask which doesn't have any online
5102 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5103 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5104 * online CPU before, cpus_allowed of all its workers should be restored.
5105 */
5106static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5107{
5108 static cpumask_t cpumask;
5109 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005110
Tejun Heo1258fae2018-05-18 08:47:13 -07005111 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005112
5113 /* is @cpu allowed for @pool? */
5114 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5115 return;
5116
Tejun Heo7dbc7252013-03-19 13:45:21 -07005117 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005118
5119 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005120 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005121 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005122}
5123
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005124int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005125{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005126 struct worker_pool *pool;
5127
5128 for_each_cpu_worker_pool(pool, cpu) {
5129 if (pool->nr_workers)
5130 continue;
5131 if (!create_worker(pool))
5132 return -ENOMEM;
5133 }
5134 return 0;
5135}
5136
5137int workqueue_online_cpu(unsigned int cpu)
5138{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005139 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005140 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005141 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005142
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005143 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005144
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005145 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005146 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005147
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005148 if (pool->cpu == cpu)
5149 rebind_workers(pool);
5150 else if (pool->cpu < 0)
5151 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005152
Tejun Heo1258fae2018-05-18 08:47:13 -07005153 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005154 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005155
5156 /* update NUMA affinity of unbound workqueues */
5157 list_for_each_entry(wq, &workqueues, list)
5158 wq_update_unbound_numa(wq, cpu, true);
5159
5160 mutex_unlock(&wq_pool_mutex);
5161 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005162}
5163
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005164int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005165{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005166 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005167
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005168 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005169 if (WARN_ON(cpu != smp_processor_id()))
5170 return -1;
5171
5172 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005173
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005174 /* update NUMA affinity of unbound workqueues */
5175 mutex_lock(&wq_pool_mutex);
5176 list_for_each_entry(wq, &workqueues, list)
5177 wq_update_unbound_numa(wq, cpu, false);
5178 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005179
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005180 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005181}
5182
Rusty Russell2d3854a2008-11-05 13:39:10 +11005183struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005184 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005185 long (*fn)(void *);
5186 void *arg;
5187 long ret;
5188};
5189
Tejun Heoed48ece2012-09-18 12:48:43 -07005190static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005191{
Tejun Heoed48ece2012-09-18 12:48:43 -07005192 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5193
Rusty Russell2d3854a2008-11-05 13:39:10 +11005194 wfc->ret = wfc->fn(wfc->arg);
5195}
5196
5197/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005198 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005199 * @cpu: the cpu to run on
5200 * @fn: the function to run
5201 * @arg: the function arg
5202 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005203 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005204 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005205 *
5206 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005207 */
Tejun Heod84ff052013-03-12 11:29:59 -07005208long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005209{
Tejun Heoed48ece2012-09-18 12:48:43 -07005210 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005211
Tejun Heoed48ece2012-09-18 12:48:43 -07005212 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5213 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005214 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005215 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005216 return wfc.ret;
5217}
5218EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005219
5220/**
5221 * work_on_cpu_safe - run a function in thread context on a particular cpu
5222 * @cpu: the cpu to run on
5223 * @fn: the function to run
5224 * @arg: the function argument
5225 *
5226 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5227 * any locks which would prevent @fn from completing.
5228 *
5229 * Return: The value @fn returns.
5230 */
5231long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5232{
5233 long ret = -ENODEV;
5234
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005235 cpus_read_lock();
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005236 if (cpu_online(cpu))
5237 ret = work_on_cpu(cpu, fn, arg);
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005238 cpus_read_unlock();
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005239 return ret;
5240}
5241EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005242#endif /* CONFIG_SMP */
5243
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005244#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305245
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005246/**
5247 * freeze_workqueues_begin - begin freezing workqueues
5248 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005249 * Start freezing workqueues. After this function returns, all freezable
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08005250 * workqueues will queue new works to their inactive_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005251 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005252 *
5253 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005254 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005255 */
5256void freeze_workqueues_begin(void)
5257{
Tejun Heo24b8a842013-03-12 11:29:58 -07005258 struct workqueue_struct *wq;
5259 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005260
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005261 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005262
Tejun Heo6183c002013-03-12 11:29:57 -07005263 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005264 workqueue_freezing = true;
5265
Tejun Heo24b8a842013-03-12 11:29:58 -07005266 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005267 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005268 for_each_pwq(pwq, wq)
5269 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005270 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005271 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005272
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005273 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005274}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005275
5276/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005277 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005278 *
5279 * Check whether freezing is complete. This function must be called
5280 * between freeze_workqueues_begin() and thaw_workqueues().
5281 *
5282 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005283 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005284 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005285 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005286 * %true if some freezable workqueues are still busy. %false if freezing
5287 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005288 */
5289bool freeze_workqueues_busy(void)
5290{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005291 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005292 struct workqueue_struct *wq;
5293 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005294
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005295 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005296
Tejun Heo6183c002013-03-12 11:29:57 -07005297 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005298
Tejun Heo24b8a842013-03-12 11:29:58 -07005299 list_for_each_entry(wq, &workqueues, list) {
5300 if (!(wq->flags & WQ_FREEZABLE))
5301 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005302 /*
5303 * nr_active is monotonically decreasing. It's safe
5304 * to peek without lock.
5305 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005306 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005307 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005308 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005309 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005310 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005311 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005312 goto out_unlock;
5313 }
5314 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005315 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005316 }
5317out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005318 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005319 return busy;
5320}
5321
5322/**
5323 * thaw_workqueues - thaw workqueues
5324 *
5325 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005326 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005327 *
5328 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005329 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005330 */
5331void thaw_workqueues(void)
5332{
Tejun Heo24b8a842013-03-12 11:29:58 -07005333 struct workqueue_struct *wq;
5334 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005335
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005336 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005337
5338 if (!workqueue_freezing)
5339 goto out_unlock;
5340
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005341 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005342
Tejun Heo24b8a842013-03-12 11:29:58 -07005343 /* restore max_active and repopulate worklist */
5344 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005345 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005346 for_each_pwq(pwq, wq)
5347 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005348 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005349 }
5350
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005351out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005352 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005353}
5354#endif /* CONFIG_FREEZER */
5355
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005356static int workqueue_apply_unbound_cpumask(void)
5357{
5358 LIST_HEAD(ctxs);
5359 int ret = 0;
5360 struct workqueue_struct *wq;
5361 struct apply_wqattrs_ctx *ctx, *n;
5362
5363 lockdep_assert_held(&wq_pool_mutex);
5364
5365 list_for_each_entry(wq, &workqueues, list) {
5366 if (!(wq->flags & WQ_UNBOUND))
5367 continue;
5368 /* creating multiple pwqs breaks ordering guarantee */
5369 if (wq->flags & __WQ_ORDERED)
5370 continue;
5371
5372 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5373 if (!ctx) {
5374 ret = -ENOMEM;
5375 break;
5376 }
5377
5378 list_add_tail(&ctx->list, &ctxs);
5379 }
5380
5381 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5382 if (!ret)
5383 apply_wqattrs_commit(ctx);
5384 apply_wqattrs_cleanup(ctx);
5385 }
5386
5387 return ret;
5388}
5389
5390/**
5391 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5392 * @cpumask: the cpumask to set
5393 *
5394 * The low-level workqueues cpumask is a global cpumask that limits
5395 * the affinity of all unbound workqueues. This function check the @cpumask
5396 * and apply it to all unbound workqueues and updates all pwqs of them.
5397 *
Cai Huoqing67dc8322021-07-31 08:01:29 +08005398 * Return: 0 - Success
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005399 * -EINVAL - Invalid @cpumask
5400 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5401 */
5402int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5403{
5404 int ret = -EINVAL;
5405 cpumask_var_t saved_cpumask;
5406
Tal Shorerc98a9802017-11-03 17:27:50 +02005407 /*
5408 * Not excluding isolated cpus on purpose.
5409 * If the user wishes to include them, we allow that.
5410 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005411 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5412 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005413 apply_wqattrs_lock();
Menglong Dongd25302e2021-10-17 20:04:02 +08005414 if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
5415 ret = 0;
5416 goto out_unlock;
5417 }
5418
5419 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) {
5420 ret = -ENOMEM;
5421 goto out_unlock;
5422 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005423
5424 /* save the old wq_unbound_cpumask. */
5425 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5426
5427 /* update wq_unbound_cpumask at first and apply it to wqs. */
5428 cpumask_copy(wq_unbound_cpumask, cpumask);
5429 ret = workqueue_apply_unbound_cpumask();
5430
5431 /* restore the wq_unbound_cpumask when failed. */
5432 if (ret < 0)
5433 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5434
Menglong Dongd25302e2021-10-17 20:04:02 +08005435 free_cpumask_var(saved_cpumask);
5436out_unlock:
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005437 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005438 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005439
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005440 return ret;
5441}
5442
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005443#ifdef CONFIG_SYSFS
5444/*
5445 * Workqueues with WQ_SYSFS flag set is visible to userland via
5446 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5447 * following attributes.
5448 *
5449 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5450 * max_active RW int : maximum number of in-flight work items
5451 *
5452 * Unbound workqueues have the following extra attributes.
5453 *
Wang Long9a19b462017-11-02 23:05:12 -04005454 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005455 * nice RW int : nice value of the workers
5456 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005457 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005458 */
5459struct wq_device {
5460 struct workqueue_struct *wq;
5461 struct device dev;
5462};
5463
5464static struct workqueue_struct *dev_to_wq(struct device *dev)
5465{
5466 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5467
5468 return wq_dev->wq;
5469}
5470
5471static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5472 char *buf)
5473{
5474 struct workqueue_struct *wq = dev_to_wq(dev);
5475
5476 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5477}
5478static DEVICE_ATTR_RO(per_cpu);
5479
5480static ssize_t max_active_show(struct device *dev,
5481 struct device_attribute *attr, char *buf)
5482{
5483 struct workqueue_struct *wq = dev_to_wq(dev);
5484
5485 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5486}
5487
5488static ssize_t max_active_store(struct device *dev,
5489 struct device_attribute *attr, const char *buf,
5490 size_t count)
5491{
5492 struct workqueue_struct *wq = dev_to_wq(dev);
5493 int val;
5494
5495 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5496 return -EINVAL;
5497
5498 workqueue_set_max_active(wq, val);
5499 return count;
5500}
5501static DEVICE_ATTR_RW(max_active);
5502
5503static struct attribute *wq_sysfs_attrs[] = {
5504 &dev_attr_per_cpu.attr,
5505 &dev_attr_max_active.attr,
5506 NULL,
5507};
5508ATTRIBUTE_GROUPS(wq_sysfs);
5509
5510static ssize_t wq_pool_ids_show(struct device *dev,
5511 struct device_attribute *attr, char *buf)
5512{
5513 struct workqueue_struct *wq = dev_to_wq(dev);
5514 const char *delim = "";
5515 int node, written = 0;
5516
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005517 cpus_read_lock();
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005518 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005519 for_each_node(node) {
5520 written += scnprintf(buf + written, PAGE_SIZE - written,
5521 "%s%d:%d", delim, node,
5522 unbound_pwq_by_node(wq, node)->pool->id);
5523 delim = " ";
5524 }
5525 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005526 rcu_read_unlock();
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005527 cpus_read_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005528
5529 return written;
5530}
5531
5532static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5533 char *buf)
5534{
5535 struct workqueue_struct *wq = dev_to_wq(dev);
5536 int written;
5537
5538 mutex_lock(&wq->mutex);
5539 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5540 mutex_unlock(&wq->mutex);
5541
5542 return written;
5543}
5544
5545/* prepare workqueue_attrs for sysfs store operations */
5546static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5547{
5548 struct workqueue_attrs *attrs;
5549
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005550 lockdep_assert_held(&wq_pool_mutex);
5551
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005552 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005553 if (!attrs)
5554 return NULL;
5555
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005556 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005557 return attrs;
5558}
5559
5560static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5561 const char *buf, size_t count)
5562{
5563 struct workqueue_struct *wq = dev_to_wq(dev);
5564 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005565 int ret = -ENOMEM;
5566
5567 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005568
5569 attrs = wq_sysfs_prep_attrs(wq);
5570 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005571 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005572
5573 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5574 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005575 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005576 else
5577 ret = -EINVAL;
5578
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005579out_unlock:
5580 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005581 free_workqueue_attrs(attrs);
5582 return ret ?: count;
5583}
5584
5585static ssize_t wq_cpumask_show(struct device *dev,
5586 struct device_attribute *attr, char *buf)
5587{
5588 struct workqueue_struct *wq = dev_to_wq(dev);
5589 int written;
5590
5591 mutex_lock(&wq->mutex);
5592 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5593 cpumask_pr_args(wq->unbound_attrs->cpumask));
5594 mutex_unlock(&wq->mutex);
5595 return written;
5596}
5597
5598static ssize_t wq_cpumask_store(struct device *dev,
5599 struct device_attribute *attr,
5600 const char *buf, size_t count)
5601{
5602 struct workqueue_struct *wq = dev_to_wq(dev);
5603 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005604 int ret = -ENOMEM;
5605
5606 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005607
5608 attrs = wq_sysfs_prep_attrs(wq);
5609 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005610 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005611
5612 ret = cpumask_parse(buf, attrs->cpumask);
5613 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005614 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005615
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005616out_unlock:
5617 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005618 free_workqueue_attrs(attrs);
5619 return ret ?: count;
5620}
5621
5622static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5623 char *buf)
5624{
5625 struct workqueue_struct *wq = dev_to_wq(dev);
5626 int written;
5627
5628 mutex_lock(&wq->mutex);
5629 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5630 !wq->unbound_attrs->no_numa);
5631 mutex_unlock(&wq->mutex);
5632
5633 return written;
5634}
5635
5636static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5637 const char *buf, size_t count)
5638{
5639 struct workqueue_struct *wq = dev_to_wq(dev);
5640 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005641 int v, ret = -ENOMEM;
5642
5643 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005644
5645 attrs = wq_sysfs_prep_attrs(wq);
5646 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005647 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005648
5649 ret = -EINVAL;
5650 if (sscanf(buf, "%d", &v) == 1) {
5651 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005652 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005653 }
5654
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005655out_unlock:
5656 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005657 free_workqueue_attrs(attrs);
5658 return ret ?: count;
5659}
5660
5661static struct device_attribute wq_sysfs_unbound_attrs[] = {
5662 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5663 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5664 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5665 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5666 __ATTR_NULL,
5667};
5668
5669static struct bus_type wq_subsys = {
5670 .name = "workqueue",
5671 .dev_groups = wq_sysfs_groups,
5672};
5673
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005674static ssize_t wq_unbound_cpumask_show(struct device *dev,
5675 struct device_attribute *attr, char *buf)
5676{
5677 int written;
5678
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005679 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005680 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5681 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005682 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005683
5684 return written;
5685}
5686
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005687static ssize_t wq_unbound_cpumask_store(struct device *dev,
5688 struct device_attribute *attr, const char *buf, size_t count)
5689{
5690 cpumask_var_t cpumask;
5691 int ret;
5692
5693 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5694 return -ENOMEM;
5695
5696 ret = cpumask_parse(buf, cpumask);
5697 if (!ret)
5698 ret = workqueue_set_unbound_cpumask(cpumask);
5699
5700 free_cpumask_var(cpumask);
5701 return ret ? ret : count;
5702}
5703
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005704static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005705 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5706 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005707
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005708static int __init wq_sysfs_init(void)
5709{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005710 int err;
5711
5712 err = subsys_virtual_register(&wq_subsys, NULL);
5713 if (err)
5714 return err;
5715
5716 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005717}
5718core_initcall(wq_sysfs_init);
5719
5720static void wq_device_release(struct device *dev)
5721{
5722 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5723
5724 kfree(wq_dev);
5725}
5726
5727/**
5728 * workqueue_sysfs_register - make a workqueue visible in sysfs
5729 * @wq: the workqueue to register
5730 *
5731 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5732 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5733 * which is the preferred method.
5734 *
5735 * Workqueue user should use this function directly iff it wants to apply
5736 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5737 * apply_workqueue_attrs() may race against userland updating the
5738 * attributes.
5739 *
5740 * Return: 0 on success, -errno on failure.
5741 */
5742int workqueue_sysfs_register(struct workqueue_struct *wq)
5743{
5744 struct wq_device *wq_dev;
5745 int ret;
5746
5747 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305748 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005749 * attributes breaks ordering guarantee. Disallow exposing ordered
5750 * workqueues.
5751 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005752 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005753 return -EINVAL;
5754
5755 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5756 if (!wq_dev)
5757 return -ENOMEM;
5758
5759 wq_dev->wq = wq;
5760 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005761 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005762 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005763
5764 /*
5765 * unbound_attrs are created separately. Suppress uevent until
5766 * everything is ready.
5767 */
5768 dev_set_uevent_suppress(&wq_dev->dev, true);
5769
5770 ret = device_register(&wq_dev->dev);
5771 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305772 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005773 wq->wq_dev = NULL;
5774 return ret;
5775 }
5776
5777 if (wq->flags & WQ_UNBOUND) {
5778 struct device_attribute *attr;
5779
5780 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5781 ret = device_create_file(&wq_dev->dev, attr);
5782 if (ret) {
5783 device_unregister(&wq_dev->dev);
5784 wq->wq_dev = NULL;
5785 return ret;
5786 }
5787 }
5788 }
5789
5790 dev_set_uevent_suppress(&wq_dev->dev, false);
5791 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5792 return 0;
5793}
5794
5795/**
5796 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5797 * @wq: the workqueue to unregister
5798 *
5799 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5800 */
5801static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5802{
5803 struct wq_device *wq_dev = wq->wq_dev;
5804
5805 if (!wq->wq_dev)
5806 return;
5807
5808 wq->wq_dev = NULL;
5809 device_unregister(&wq_dev->dev);
5810}
5811#else /* CONFIG_SYSFS */
5812static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5813#endif /* CONFIG_SYSFS */
5814
Tejun Heo82607adc2015-12-08 11:28:04 -05005815/*
5816 * Workqueue watchdog.
5817 *
5818 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5819 * flush dependency, a concurrency managed work item which stays RUNNING
5820 * indefinitely. Workqueue stalls can be very difficult to debug as the
5821 * usual warning mechanisms don't trigger and internal workqueue state is
5822 * largely opaque.
5823 *
5824 * Workqueue watchdog monitors all worker pools periodically and dumps
5825 * state if some pools failed to make forward progress for a while where
5826 * forward progress is defined as the first item on ->worklist changing.
5827 *
5828 * This mechanism is controlled through the kernel parameter
5829 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5830 * corresponding sysfs parameter file.
5831 */
5832#ifdef CONFIG_WQ_WATCHDOG
5833
Tejun Heo82607adc2015-12-08 11:28:04 -05005834static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005835static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005836
5837static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5838static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5839
5840static void wq_watchdog_reset_touched(void)
5841{
5842 int cpu;
5843
5844 wq_watchdog_touched = jiffies;
5845 for_each_possible_cpu(cpu)
5846 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5847}
5848
Kees Cook5cd79d62017-10-04 16:27:00 -07005849static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005850{
5851 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5852 bool lockup_detected = false;
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005853 unsigned long now = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005854 struct worker_pool *pool;
5855 int pi;
5856
5857 if (!thresh)
5858 return;
5859
5860 rcu_read_lock();
5861
5862 for_each_pool(pool, pi) {
5863 unsigned long pool_ts, touched, ts;
5864
5865 if (list_empty(&pool->worklist))
5866 continue;
5867
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005868 /*
5869 * If a virtual machine is stopped by the host it can look to
5870 * the watchdog like a stall.
5871 */
5872 kvm_check_and_clear_guest_paused();
5873
Tejun Heo82607adc2015-12-08 11:28:04 -05005874 /* get the latest of pool and touched timestamps */
Wang Qing89e28ce2021-03-24 19:40:29 +08005875 if (pool->cpu >= 0)
5876 touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
5877 else
5878 touched = READ_ONCE(wq_watchdog_touched);
Tejun Heo82607adc2015-12-08 11:28:04 -05005879 pool_ts = READ_ONCE(pool->watchdog_ts);
Tejun Heo82607adc2015-12-08 11:28:04 -05005880
5881 if (time_after(pool_ts, touched))
5882 ts = pool_ts;
5883 else
5884 ts = touched;
5885
Tejun Heo82607adc2015-12-08 11:28:04 -05005886 /* did we stall? */
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005887 if (time_after(now, ts + thresh)) {
Tejun Heo82607adc2015-12-08 11:28:04 -05005888 lockup_detected = true;
5889 pr_emerg("BUG: workqueue lockup - pool");
5890 pr_cont_pool_info(pool);
5891 pr_cont(" stuck for %us!\n",
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005892 jiffies_to_msecs(now - pool_ts) / 1000);
Tejun Heo82607adc2015-12-08 11:28:04 -05005893 }
5894 }
5895
5896 rcu_read_unlock();
5897
5898 if (lockup_detected)
Imran Khan55df0932021-10-20 14:09:00 +11005899 show_all_workqueues();
Tejun Heo82607adc2015-12-08 11:28:04 -05005900
5901 wq_watchdog_reset_touched();
5902 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5903}
5904
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005905notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005906{
5907 if (cpu >= 0)
5908 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
Wang Qing89e28ce2021-03-24 19:40:29 +08005909
5910 wq_watchdog_touched = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005911}
5912
5913static void wq_watchdog_set_thresh(unsigned long thresh)
5914{
5915 wq_watchdog_thresh = 0;
5916 del_timer_sync(&wq_watchdog_timer);
5917
5918 if (thresh) {
5919 wq_watchdog_thresh = thresh;
5920 wq_watchdog_reset_touched();
5921 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5922 }
5923}
5924
5925static int wq_watchdog_param_set_thresh(const char *val,
5926 const struct kernel_param *kp)
5927{
5928 unsigned long thresh;
5929 int ret;
5930
5931 ret = kstrtoul(val, 0, &thresh);
5932 if (ret)
5933 return ret;
5934
5935 if (system_wq)
5936 wq_watchdog_set_thresh(thresh);
5937 else
5938 wq_watchdog_thresh = thresh;
5939
5940 return 0;
5941}
5942
5943static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5944 .set = wq_watchdog_param_set_thresh,
5945 .get = param_get_ulong,
5946};
5947
5948module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5949 0644);
5950
5951static void wq_watchdog_init(void)
5952{
Kees Cook5cd79d62017-10-04 16:27:00 -07005953 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005954 wq_watchdog_set_thresh(wq_watchdog_thresh);
5955}
5956
5957#else /* CONFIG_WQ_WATCHDOG */
5958
5959static inline void wq_watchdog_init(void) { }
5960
5961#endif /* CONFIG_WQ_WATCHDOG */
5962
Tejun Heobce90382013-04-01 11:23:32 -07005963static void __init wq_numa_init(void)
5964{
5965 cpumask_var_t *tbl;
5966 int node, cpu;
5967
Tejun Heobce90382013-04-01 11:23:32 -07005968 if (num_possible_nodes() <= 1)
5969 return;
5970
Tejun Heod55262c2013-04-01 11:23:38 -07005971 if (wq_disable_numa) {
5972 pr_info("workqueue: NUMA affinity support disabled\n");
5973 return;
5974 }
5975
Zhen Leif728c4a92021-07-22 11:03:52 +08005976 for_each_possible_cpu(cpu) {
5977 if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) {
5978 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5979 return;
5980 }
5981 }
5982
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005983 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005984 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5985
Tejun Heobce90382013-04-01 11:23:32 -07005986 /*
5987 * We want masks of possible CPUs of each node which isn't readily
5988 * available. Build one from cpu_to_node() which should have been
5989 * fully initialized by now.
5990 */
Kees Cook6396bb22018-06-12 14:03:40 -07005991 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005992 BUG_ON(!tbl);
5993
5994 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005995 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005996 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005997
5998 for_each_possible_cpu(cpu) {
5999 node = cpu_to_node(cpu);
Tejun Heobce90382013-04-01 11:23:32 -07006000 cpumask_set_cpu(cpu, tbl[node]);
6001 }
6002
6003 wq_numa_possible_cpumask = tbl;
6004 wq_numa_enabled = true;
6005}
6006
Tejun Heo3347fa02016-09-16 15:49:32 -04006007/**
6008 * workqueue_init_early - early init for workqueue subsystem
6009 *
6010 * This is the first half of two-staged workqueue subsystem initialization
6011 * and invoked as soon as the bare basics - memory allocation, cpumasks and
6012 * idr are up. It sets up all the data structures and system workqueues
6013 * and allows early boot code to create workqueues and queue/cancel work
6014 * items. Actual work item execution starts only after kthreads can be
6015 * created and scheduled right before early initcalls.
6016 */
Yu Chen2333e822020-02-23 15:28:52 +08006017void __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006018{
Tejun Heo7a4e3442013-03-12 11:30:00 -07006019 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01006020 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07006021 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02006022
Lai Jiangshan10cdb152020-06-01 08:44:40 +00006023 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
Tejun Heoe904e6c2013-03-12 11:29:57 -07006024
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08006025 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01006026 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08006027
Tejun Heoe904e6c2013-03-12 11:29:57 -07006028 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
6029
Tejun Heo706026c2013-01-24 11:01:34 -08006030 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07006031 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07006032 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02006033
Tejun Heo7a4e3442013-03-12 11:30:00 -07006034 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07006035 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07006036 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08006037 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07006038 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07006039 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07006040 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07006041
Tejun Heo9daf9e62013-01-24 11:01:33 -08006042 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07006043 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08006044 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07006045 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07006046 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02006047 }
6048
Tejun Heo8a2b7532013-09-05 12:30:04 -04006049 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07006050 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
6051 struct workqueue_attrs *attrs;
6052
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02006053 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07006054 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07006055 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04006056
6057 /*
6058 * An ordered wq should have only one pwq as ordering is
6059 * guaranteed by max_active which is enforced by pwqs.
6060 * Turn off NUMA so that dfl_pwq is used for all nodes.
6061 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02006062 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04006063 attrs->nice = std_nice[i];
6064 attrs->no_numa = true;
6065 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07006066 }
6067
Tejun Heod320c032010-06-29 10:07:14 +02006068 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006069 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02006070 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02006071 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
6072 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01006073 system_freezable_wq = alloc_workqueue("events_freezable",
6074 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05306075 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
6076 WQ_POWER_EFFICIENT, 0);
6077 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
6078 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
6079 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006080 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05306081 !system_unbound_wq || !system_freezable_wq ||
6082 !system_power_efficient_wq ||
6083 !system_freezable_power_efficient_wq);
Tejun Heo3347fa02016-09-16 15:49:32 -04006084}
6085
6086/**
6087 * workqueue_init - bring workqueue subsystem fully online
6088 *
6089 * This is the latter half of two-staged workqueue subsystem initialization
6090 * and invoked as soon as kthreads can be created and scheduled.
6091 * Workqueues have been created and work items queued on them, but there
6092 * are no kworkers executing the work items yet. Populate the worker pools
6093 * with the initial workers and enable future kworker creations.
6094 */
Yu Chen2333e822020-02-23 15:28:52 +08006095void __init workqueue_init(void)
Tejun Heo3347fa02016-09-16 15:49:32 -04006096{
Tejun Heo2186d9f2016-10-19 12:01:27 -04006097 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04006098 struct worker_pool *pool;
6099 int cpu, bkt;
6100
Tejun Heo2186d9f2016-10-19 12:01:27 -04006101 /*
6102 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6103 * CPU to node mapping may not be available that early on some
6104 * archs such as power and arm64. As per-cpu pools created
6105 * previously could be missing node hint and unbound pools NUMA
6106 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08006107 *
6108 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006109 */
6110 wq_numa_init();
6111
6112 mutex_lock(&wq_pool_mutex);
6113
6114 for_each_possible_cpu(cpu) {
6115 for_each_cpu_worker_pool(pool, cpu) {
6116 pool->node = cpu_to_node(cpu);
6117 }
6118 }
6119
Tejun Heo40c17f72018-01-08 05:38:37 -08006120 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006121 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006122 WARN(init_rescuer(wq),
6123 "workqueue: failed to create early rescuer for %s",
6124 wq->name);
6125 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006126
6127 mutex_unlock(&wq_pool_mutex);
6128
Tejun Heo3347fa02016-09-16 15:49:32 -04006129 /* create the initial workers */
6130 for_each_online_cpu(cpu) {
6131 for_each_cpu_worker_pool(pool, cpu) {
6132 pool->flags &= ~POOL_DISASSOCIATED;
6133 BUG_ON(!create_worker(pool));
6134 }
6135 }
6136
6137 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6138 BUG_ON(!create_worker(pool));
6139
6140 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006141 wq_watchdog_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006142}