blob: 33a6b4a2443d274de3dfb1f31c11a460da118747 [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);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700378
Tejun Heo97bd2342010-10-05 10:41:14 +0200379#define CREATE_TRACE_POINTS
380#include <trace/events/workqueue.h>
381
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700382#define assert_rcu_or_pool_mutex() \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100383 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700384 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100385 "RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700386
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800387#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100388 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700389 !lockdep_is_held(&wq->mutex) && \
390 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100391 "RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800392
Tejun Heof02ae732013-03-12 11:30:03 -0700393#define for_each_cpu_worker_pool(pool, cpu) \
394 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
395 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700396 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700397
Tejun Heo49e3cf42013-03-12 11:29:58 -0700398/**
Tejun Heo17116962013-03-12 11:29:58 -0700399 * for_each_pool - iterate through all worker_pools in the system
400 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700401 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700402 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100403 * This must be called either with wq_pool_mutex held or RCU read
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700404 * locked. If the pool needs to be used beyond the locking in effect, the
405 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700406 *
407 * The if/else clause exists only for the lockdep assertion and can be
408 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700409 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700410#define for_each_pool(pool, pi) \
411 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700412 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700413 else
Tejun Heo17116962013-03-12 11:29:58 -0700414
415/**
Tejun Heo822d8402013-03-19 13:45:21 -0700416 * for_each_pool_worker - iterate through all workers of a worker_pool
417 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700418 * @pool: worker_pool to iterate workers of
419 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700420 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700421 *
422 * The if/else clause exists only for the lockdep assertion and can be
423 * ignored.
424 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800425#define for_each_pool_worker(worker, pool) \
426 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700427 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700428 else
429
430/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700431 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
432 * @pwq: iteration cursor
433 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700434 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100435 * This must be called either with wq->mutex held or RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700436 * If the pwq needs to be used beyond the locking in effect, the caller is
437 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700438 *
439 * The if/else clause exists only for the lockdep assertion and can be
440 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700441 */
442#define for_each_pwq(pwq, wq) \
Sebastian Andrzej Siewior49e9d1a2019-11-15 19:01:25 +0100443 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
Joel Fernandes (Google)5a644662019-08-15 10:18:42 -0400444 lockdep_is_held(&(wq->mutex)))
Tejun Heof3421792010-07-02 10:03:51 +0200445
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900446#ifdef CONFIG_DEBUG_OBJECTS_WORK
447
Stephen Boydf9e62f32020-08-14 17:40:27 -0700448static const struct debug_obj_descr work_debug_descr;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900449
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100450static void *work_debug_hint(void *addr)
451{
452 return ((struct work_struct *) addr)->func;
453}
454
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700455static bool work_is_static_object(void *addr)
456{
457 struct work_struct *work = addr;
458
459 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
460}
461
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462/*
463 * fixup_init is called when:
464 * - an active object is initialized
465 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700466static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900467{
468 struct work_struct *work = addr;
469
470 switch (state) {
471 case ODEBUG_STATE_ACTIVE:
472 cancel_work_sync(work);
473 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700474 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900475 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700476 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900477 }
478}
479
480/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900481 * fixup_free is called when:
482 * - an active object is freed
483 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700484static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900485{
486 struct work_struct *work = addr;
487
488 switch (state) {
489 case ODEBUG_STATE_ACTIVE:
490 cancel_work_sync(work);
491 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700492 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900493 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700494 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900495 }
496}
497
Stephen Boydf9e62f32020-08-14 17:40:27 -0700498static const struct debug_obj_descr work_debug_descr = {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900499 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100500 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700501 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900502 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900503 .fixup_free = work_fixup_free,
504};
505
506static inline void debug_work_activate(struct work_struct *work)
507{
508 debug_object_activate(work, &work_debug_descr);
509}
510
511static inline void debug_work_deactivate(struct work_struct *work)
512{
513 debug_object_deactivate(work, &work_debug_descr);
514}
515
516void __init_work(struct work_struct *work, int onstack)
517{
518 if (onstack)
519 debug_object_init_on_stack(work, &work_debug_descr);
520 else
521 debug_object_init(work, &work_debug_descr);
522}
523EXPORT_SYMBOL_GPL(__init_work);
524
525void destroy_work_on_stack(struct work_struct *work)
526{
527 debug_object_free(work, &work_debug_descr);
528}
529EXPORT_SYMBOL_GPL(destroy_work_on_stack);
530
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000531void destroy_delayed_work_on_stack(struct delayed_work *work)
532{
533 destroy_timer_on_stack(&work->timer);
534 debug_object_free(&work->work, &work_debug_descr);
535}
536EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
537
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900538#else
539static inline void debug_work_activate(struct work_struct *work) { }
540static inline void debug_work_deactivate(struct work_struct *work) { }
541#endif
542
Li Bin4e8b22b2013-09-10 09:52:35 +0800543/**
Cai Huoqing67dc8322021-07-31 08:01:29 +0800544 * worker_pool_assign_id - allocate ID and assign it to @pool
Li Bin4e8b22b2013-09-10 09:52:35 +0800545 * @pool: the pool pointer of interest
546 *
547 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
548 * successfully, -errno on failure.
549 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800550static int worker_pool_assign_id(struct worker_pool *pool)
551{
552 int ret;
553
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700554 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700555
Li Bin4e8b22b2013-09-10 09:52:35 +0800556 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
557 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700558 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700559 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700560 return 0;
561 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800562 return ret;
563}
564
Tejun Heo76af4d92013-03-12 11:30:00 -0700565/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700566 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
567 * @wq: the target workqueue
568 * @node: the node ID
569 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100570 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800571 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700572 * If the pwq needs to be used beyond the locking in effect, the caller is
573 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700574 *
575 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700576 */
577static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
578 int node)
579{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800580 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500581
582 /*
583 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
584 * delayed item is pending. The plan is to keep CPU -> NODE
585 * mapping valid and stable across CPU on/offlines. Once that
586 * happens, this workaround can be removed.
587 */
588 if (unlikely(node == NUMA_NO_NODE))
589 return wq->dfl_pwq;
590
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700591 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
592}
593
Tejun Heo73f53c42010-06-29 10:07:11 +0200594static unsigned int work_color_to_flags(int color)
595{
596 return color << WORK_STRUCT_COLOR_SHIFT;
597}
598
Lai Jiangshanc4560c22021-08-17 09:32:35 +0800599static int get_work_color(unsigned long work_data)
Tejun Heo73f53c42010-06-29 10:07:11 +0200600{
Lai Jiangshanc4560c22021-08-17 09:32:35 +0800601 return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
Tejun Heo73f53c42010-06-29 10:07:11 +0200602 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
603}
604
605static int work_next_color(int color)
606{
607 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700608}
609
David Howells4594bf12006-12-07 11:33:26 +0000610/*
Tejun Heo112202d2013-02-13 19:29:12 -0800611 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
612 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800613 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200614 *
Tejun Heo112202d2013-02-13 19:29:12 -0800615 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
616 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700617 * work->data. These functions should only be called while the work is
618 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200619 *
Tejun Heo112202d2013-02-13 19:29:12 -0800620 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800621 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800622 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800623 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700624 *
625 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
626 * canceled. While being canceled, a work item may have its PENDING set
627 * but stay off timer and worklist for arbitrarily long and nobody should
628 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000629 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200630static inline void set_work_data(struct work_struct *work, unsigned long data,
631 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000632{
Tejun Heo6183c002013-03-12 11:29:57 -0700633 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200634 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000635}
David Howells365970a2006-11-22 14:54:49 +0000636
Tejun Heo112202d2013-02-13 19:29:12 -0800637static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200638 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200639{
Tejun Heo112202d2013-02-13 19:29:12 -0800640 set_work_data(work, (unsigned long)pwq,
641 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200642}
643
Lai Jiangshan4468a002013-02-06 18:04:53 -0800644static void set_work_pool_and_keep_pending(struct work_struct *work,
645 int pool_id)
646{
647 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
648 WORK_STRUCT_PENDING);
649}
650
Tejun Heo7c3eed52013-01-24 11:01:33 -0800651static void set_work_pool_and_clear_pending(struct work_struct *work,
652 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000653{
Tejun Heo23657bb2012-08-13 17:08:19 -0700654 /*
655 * The following wmb is paired with the implied mb in
656 * test_and_set_bit(PENDING) and ensures all updates to @work made
657 * here are visible to and precede any updates by the next PENDING
658 * owner.
659 */
660 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800661 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200662 /*
663 * The following mb guarantees that previous clear of a PENDING bit
664 * will not be reordered with any speculative LOADS or STORES from
665 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800666 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200667 * the same @work. E.g. consider this case:
668 *
669 * CPU#0 CPU#1
670 * ---------------------------- --------------------------------
671 *
672 * 1 STORE event_indicated
673 * 2 queue_work_on() {
674 * 3 test_and_set_bit(PENDING)
675 * 4 } set_..._and_clear_pending() {
676 * 5 set_work_data() # clear bit
677 * 6 smp_mb()
678 * 7 work->current_func() {
679 * 8 LOAD event_indicated
680 * }
681 *
682 * Without an explicit full barrier speculative LOAD on line 8 can
683 * be executed before CPU#0 does STORE on line 1. If that happens,
684 * CPU#0 observes the PENDING bit is still set and new execution of
685 * a @work is not queued in a hope, that CPU#1 will eventually
686 * finish the queued @work. Meanwhile CPU#1 does not see
687 * event_indicated is set, because speculative LOAD was executed
688 * before actual STORE.
689 */
690 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200691}
692
693static void clear_work_data(struct work_struct *work)
694{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800695 smp_wmb(); /* see set_work_pool_and_clear_pending() */
696 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200697}
698
Tejun Heo112202d2013-02-13 19:29:12 -0800699static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200700{
Tejun Heoe1201532010-07-22 14:14:25 +0200701 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200702
Tejun Heo112202d2013-02-13 19:29:12 -0800703 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200704 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
705 else
706 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200707}
708
Tejun Heo7c3eed52013-01-24 11:01:33 -0800709/**
710 * get_work_pool - return the worker_pool a given work was associated with
711 * @work: the work item of interest
712 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700713 * Pools are created and destroyed under wq_pool_mutex, and allows read
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100714 * access under RCU read lock. As such, this function should be
715 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700716 *
717 * All fields of the returned pool are accessible as long as the above
718 * mentioned locking is in effect. If the returned pool needs to be used
719 * beyond the critical section, the caller is responsible for ensuring the
720 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700721 *
722 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723 */
724static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200725{
Tejun Heoe1201532010-07-22 14:14:25 +0200726 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800727 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200728
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700729 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700730
Tejun Heo112202d2013-02-13 19:29:12 -0800731 if (data & WORK_STRUCT_PWQ)
732 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800733 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200734
Tejun Heo7c3eed52013-01-24 11:01:33 -0800735 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
736 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200737 return NULL;
738
Tejun Heofa1b54e2013-03-12 11:30:00 -0700739 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800740}
741
742/**
743 * get_work_pool_id - return the worker pool ID a given work is associated with
744 * @work: the work item of interest
745 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700746 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 * %WORK_OFFQ_POOL_NONE if none.
748 */
749static int get_work_pool_id(struct work_struct *work)
750{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800751 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800752
Tejun Heo112202d2013-02-13 19:29:12 -0800753 if (data & WORK_STRUCT_PWQ)
754 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800755 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
756
757 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800758}
759
Tejun Heobbb68df2012-08-03 10:30:46 -0700760static void mark_work_canceling(struct work_struct *work)
761{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800762 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700763
Tejun Heo7c3eed52013-01-24 11:01:33 -0800764 pool_id <<= WORK_OFFQ_POOL_SHIFT;
765 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700766}
767
768static bool work_is_canceling(struct work_struct *work)
769{
770 unsigned long data = atomic_long_read(&work->data);
771
Tejun Heo112202d2013-02-13 19:29:12 -0800772 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700773}
774
David Howells365970a2006-11-22 14:54:49 +0000775/*
Tejun Heo32704762012-07-13 22:16:45 -0700776 * Policy functions. These define the policies on how the global worker
777 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800778 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000779 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200780
Tejun Heo63d95a92012-07-12 14:46:37 -0700781static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000782{
Tejun Heoe19e3972013-01-24 11:39:44 -0800783 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000784}
785
Tejun Heoe22bee72010-06-29 10:07:14 +0200786/*
787 * Need to wake up a worker? Called from anything but currently
788 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700789 *
790 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800791 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700792 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200793 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700794static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000795{
Tejun Heo63d95a92012-07-12 14:46:37 -0700796 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000797}
798
Tejun Heoe22bee72010-06-29 10:07:14 +0200799/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700800static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200801{
Tejun Heo63d95a92012-07-12 14:46:37 -0700802 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200803}
804
805/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700806static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200807{
Tejun Heoe19e3972013-01-24 11:39:44 -0800808 return !list_empty(&pool->worklist) &&
809 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200810}
811
812/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700813static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200814{
Tejun Heo63d95a92012-07-12 14:46:37 -0700815 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200816}
817
Tejun Heoe22bee72010-06-29 10:07:14 +0200818/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700819static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200820{
Tejun Heo692b4822017-10-09 08:04:13 -0700821 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
823 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200824
825 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
826}
827
828/*
829 * Wake up functions.
830 */
831
Lai Jiangshan1037de32014-05-22 16:44:07 +0800832/* Return the first idle worker. Safe with preemption disabled */
833static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200834{
Tejun Heo63d95a92012-07-12 14:46:37 -0700835 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200836 return NULL;
837
Tejun Heo63d95a92012-07-12 14:46:37 -0700838 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200839}
840
841/**
842 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700843 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200844 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700845 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200846 *
847 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200848 * raw_spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200849 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700850static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200851{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800852 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200853
854 if (likely(worker))
855 wake_up_process(worker->task);
856}
857
Tejun Heo4690c4a2010-06-29 10:07:10 +0200858/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100859 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200860 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200861 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100862 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200863 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100864void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200865{
866 struct worker *worker = kthread_data(task);
867
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100868 if (!worker->sleeping)
869 return;
870 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800871 atomic_inc(&worker->pool->nr_running);
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100872 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200873}
874
875/**
876 * wq_worker_sleeping - a worker is going to sleep
877 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200878 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100879 * This function is called from schedule() when a busy worker is
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100880 * going to sleep. Preemption needs to be disabled to protect ->sleeping
881 * assignment.
Tejun Heoe22bee72010-06-29 10:07:14 +0200882 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100883void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200884{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100885 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800886 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200887
Tejun Heo111c2252013-01-17 17:16:24 -0800888 /*
889 * Rescuers, which may not have all the fields set up like normal
890 * workers, also reach here, let's not access anything before
891 * checking NOT_RUNNING.
892 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500893 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100894 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200895
Tejun Heo111c2252013-01-17 17:16:24 -0800896 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800897
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100898 /* Return if preempted before wq_worker_running() was reached */
899 if (worker->sleeping)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100900 return;
901
902 worker->sleeping = 1;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200903 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200904
905 /*
906 * The counterpart of the following dec_and_test, implied mb,
907 * worklist not empty test sequence is in insert_work().
908 * Please read comment there.
909 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700910 * NOT_RUNNING is clear. This means that we're bound to and
911 * running on the local cpu w/ rq lock held and preemption
912 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800913 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700914 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200915 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800916 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100917 !list_empty(&pool->worklist)) {
918 next = first_idle_worker(pool);
919 if (next)
920 wake_up_process(next->task);
921 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200922 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200923}
924
925/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800926 * wq_worker_last_func - retrieve worker's last work function
Bart Van Assche8194fe92019-03-19 10:45:09 -0700927 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800928 *
929 * Determine the last function a worker executed. This is called from
930 * the scheduler to get a worker's last known identity.
931 *
932 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200933 * raw_spin_lock_irq(rq->lock)
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800934 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800935 * This function is called during schedule() when a kworker is going
936 * to sleep. It's used by psi to identify aggregation workers during
937 * dequeuing, to allow periodic aggregation to shut-off when that
938 * worker is the last task in the system or cgroup to go to sleep.
939 *
940 * As this function doesn't involve any workqueue-related locking, it
941 * only returns stable values when called from inside the scheduler's
942 * queuing and dequeuing paths, when @task, which must be a kworker,
943 * is guaranteed to not be processing any works.
944 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800945 * Return:
946 * The last work function %current executed as a worker, NULL if it
947 * hasn't executed any work yet.
948 */
949work_func_t wq_worker_last_func(struct task_struct *task)
950{
951 struct worker *worker = kthread_data(task);
952
953 return worker->last_func;
954}
955
956/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200957 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200958 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200959 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200960 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800961 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200962 *
Tejun Heocb444762010-07-02 10:03:50 +0200963 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200964 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200965 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800966static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200967{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700968 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200969
Tejun Heocb444762010-07-02 10:03:50 +0200970 WARN_ON_ONCE(worker->task != current);
971
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800972 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200973 if ((flags & WORKER_NOT_RUNNING) &&
974 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800975 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200976 }
977
Tejun Heod302f012010-06-29 10:07:13 +0200978 worker->flags |= flags;
979}
980
981/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200982 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200983 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200984 * @flags: flags to clear
985 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200986 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200987 *
Tejun Heocb444762010-07-02 10:03:50 +0200988 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200989 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200990 */
991static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
992{
Tejun Heo63d95a92012-07-12 14:46:37 -0700993 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200994 unsigned int oflags = worker->flags;
995
Tejun Heocb444762010-07-02 10:03:50 +0200996 WARN_ON_ONCE(worker->task != current);
997
Tejun Heod302f012010-06-29 10:07:13 +0200998 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200999
Tejun Heo42c025f2011-01-11 15:58:49 +01001000 /*
1001 * If transitioning out of NOT_RUNNING, increment nr_running. Note
1002 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
1003 * of multiple flags, not a single flag.
1004 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001005 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1006 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -08001007 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +02001008}
1009
1010/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001011 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001012 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001013 * @work: work to find worker for
1014 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001015 * Find a worker which is executing @work on @pool by searching
1016 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001017 * to match, its current execution should match the address of @work and
1018 * its work function. This is to avoid unwanted dependency between
1019 * unrelated work executions through a work item being recycled while still
1020 * being executed.
1021 *
1022 * This is a bit tricky. A work item may be freed once its execution
1023 * starts and nothing prevents the freed area from being recycled for
1024 * another work item. If the same work item address ends up being reused
1025 * before the original execution finishes, workqueue will identify the
1026 * recycled work item as currently executing and make it wait until the
1027 * current execution finishes, introducing an unwanted dependency.
1028 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001029 * This function checks the work item address and work function to avoid
1030 * false positives. Note that this isn't complete as one may construct a
1031 * work function which can introduce dependency onto itself through a
1032 * recycled work item. Well, if somebody wants to shoot oneself in the
1033 * foot that badly, there's only so much we can do, and if such deadlock
1034 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001035 *
1036 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001037 * raw_spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001038 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001039 * Return:
1040 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001041 * otherwise.
1042 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001043static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001044 struct work_struct *work)
1045{
Sasha Levin42f85702012-12-17 10:01:23 -05001046 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001047
Sasha Levinb67bfe02013-02-27 17:06:00 -08001048 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001049 (unsigned long)work)
1050 if (worker->current_work == work &&
1051 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001052 return worker;
1053
1054 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001055}
1056
1057/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001058 * move_linked_works - move linked works to a list
1059 * @work: start of series of works to be scheduled
1060 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301061 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001062 *
1063 * Schedule linked works starting from @work to @head. Work series to
1064 * be scheduled starts at @work and includes any consecutive work with
1065 * WORK_STRUCT_LINKED set in its predecessor.
1066 *
1067 * If @nextp is not NULL, it's updated to point to the next work of
1068 * the last scheduled work. This allows move_linked_works() to be
1069 * nested inside outer list_for_each_entry_safe().
1070 *
1071 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001072 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001073 */
1074static void move_linked_works(struct work_struct *work, struct list_head *head,
1075 struct work_struct **nextp)
1076{
1077 struct work_struct *n;
1078
1079 /*
1080 * Linked worklist will always end before the end of the list,
1081 * use NULL for list head.
1082 */
1083 list_for_each_entry_safe_from(work, n, NULL, entry) {
1084 list_move_tail(&work->entry, head);
1085 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1086 break;
1087 }
1088
1089 /*
1090 * If we're already inside safe list traversal and have moved
1091 * multiple works to the scheduled queue, the next position
1092 * needs to be updated.
1093 */
1094 if (nextp)
1095 *nextp = n;
1096}
1097
Tejun Heo8864b4e2013-03-12 11:30:04 -07001098/**
1099 * get_pwq - get an extra reference on the specified pool_workqueue
1100 * @pwq: pool_workqueue to get
1101 *
1102 * Obtain an extra reference on @pwq. The caller should guarantee that
1103 * @pwq has positive refcnt and be holding the matching pool->lock.
1104 */
1105static void get_pwq(struct pool_workqueue *pwq)
1106{
1107 lockdep_assert_held(&pwq->pool->lock);
1108 WARN_ON_ONCE(pwq->refcnt <= 0);
1109 pwq->refcnt++;
1110}
1111
1112/**
1113 * put_pwq - put a pool_workqueue reference
1114 * @pwq: pool_workqueue to put
1115 *
1116 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1117 * destruction. The caller should be holding the matching pool->lock.
1118 */
1119static void put_pwq(struct pool_workqueue *pwq)
1120{
1121 lockdep_assert_held(&pwq->pool->lock);
1122 if (likely(--pwq->refcnt))
1123 return;
1124 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1125 return;
1126 /*
1127 * @pwq can't be released under pool->lock, bounce to
1128 * pwq_unbound_release_workfn(). This never recurses on the same
1129 * pool->lock as this path is taken only for unbound workqueues and
1130 * the release work item is scheduled on a per-cpu workqueue. To
1131 * avoid lockdep warning, unbound pool->locks are given lockdep
1132 * subclass of 1 in get_unbound_pool().
1133 */
1134 schedule_work(&pwq->unbound_release_work);
1135}
1136
Tejun Heodce90d42013-04-01 11:23:35 -07001137/**
1138 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1139 * @pwq: pool_workqueue to put (can be %NULL)
1140 *
1141 * put_pwq() with locking. This function also allows %NULL @pwq.
1142 */
1143static void put_pwq_unlocked(struct pool_workqueue *pwq)
1144{
1145 if (pwq) {
1146 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001147 * As both pwqs and pools are RCU protected, the
Tejun Heodce90d42013-04-01 11:23:35 -07001148 * following lock operations are safe.
1149 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001150 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001151 put_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001152 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001153 }
1154}
1155
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001156static void pwq_activate_inactive_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001157{
Tejun Heo112202d2013-02-13 19:29:12 -08001158 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001159
1160 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001161 if (list_empty(&pwq->pool->worklist))
1162 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001163 move_linked_works(work, &pwq->pool->worklist, NULL);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001164 __clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001165 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001166}
1167
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001168static void pwq_activate_first_inactive(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001169{
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001170 struct work_struct *work = list_first_entry(&pwq->inactive_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001171 struct work_struct, entry);
1172
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001173 pwq_activate_inactive_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001174}
1175
Tejun Heobf4ede02012-08-03 10:30:46 -07001176/**
Tejun Heo112202d2013-02-13 19:29:12 -08001177 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1178 * @pwq: pwq of interest
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001179 * @work_data: work_data of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001180 *
1181 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001182 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001183 *
1184 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001185 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001186 */
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001187static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
Tejun Heobf4ede02012-08-03 10:30:46 -07001188{
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001189 int color = get_work_color(work_data);
1190
Lai Jiangshan018f3a12021-08-17 09:32:37 +08001191 if (!(work_data & WORK_STRUCT_INACTIVE)) {
1192 pwq->nr_active--;
1193 if (!list_empty(&pwq->inactive_works)) {
1194 /* one down, submit an inactive one */
1195 if (pwq->nr_active < pwq->max_active)
1196 pwq_activate_first_inactive(pwq);
1197 }
1198 }
1199
Tejun Heo112202d2013-02-13 19:29:12 -08001200 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001201
Tejun Heobf4ede02012-08-03 10:30:46 -07001202 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001203 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001204 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001205
1206 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001207 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001208 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001209
Tejun Heo112202d2013-02-13 19:29:12 -08001210 /* this pwq is done, clear flush_color */
1211 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001212
1213 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001214 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001215 * will handle the rest.
1216 */
Tejun Heo112202d2013-02-13 19:29:12 -08001217 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1218 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001219out_put:
1220 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001221}
1222
Tejun Heo36e227d2012-08-03 10:30:46 -07001223/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001224 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001225 * @work: work item to steal
1226 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001227 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001228 *
1229 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001230 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001231 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001232 * Return:
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001233 *
1234 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001235 * 1 if @work was pending and we successfully stole PENDING
1236 * 0 if @work was idle and we claimed PENDING
1237 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001238 * -ENOENT if someone else is canceling @work, this state may persist
1239 * for arbitrarily long
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001240 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001241 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001242 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001243 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001244 * interrupted while holding PENDING and @work off queue, irq must be
1245 * disabled on entry. This, combined with delayed_work->timer being
1246 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001247 *
1248 * On successful return, >= 0, irq is disabled and the caller is
1249 * responsible for releasing it using local_irq_restore(*@flags).
1250 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001251 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001252 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001253static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1254 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001255{
Tejun Heod565ed62013-01-24 11:01:33 -08001256 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001257 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001258
Tejun Heobbb68df2012-08-03 10:30:46 -07001259 local_irq_save(*flags);
1260
Tejun Heo36e227d2012-08-03 10:30:46 -07001261 /* try to steal the timer if it exists */
1262 if (is_dwork) {
1263 struct delayed_work *dwork = to_delayed_work(work);
1264
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001265 /*
1266 * dwork->timer is irqsafe. If del_timer() fails, it's
1267 * guaranteed that the timer is not queued anywhere and not
1268 * running on the local CPU.
1269 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001270 if (likely(del_timer(&dwork->timer)))
1271 return 1;
1272 }
1273
1274 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001275 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1276 return 0;
1277
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001278 rcu_read_lock();
Tejun Heobf4ede02012-08-03 10:30:46 -07001279 /*
1280 * The queueing is in progress, or it is already queued. Try to
1281 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1282 */
Tejun Heod565ed62013-01-24 11:01:33 -08001283 pool = get_work_pool(work);
1284 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001285 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001286
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001287 raw_spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001288 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001289 * work->data is guaranteed to point to pwq only while the work
1290 * item is queued on pwq->wq, and both updating work->data to point
1291 * to pwq on queueing and to pool on dequeueing are done under
1292 * pwq->pool->lock. This in turn guarantees that, if work->data
1293 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001294 * item is currently queued on that pool.
1295 */
Tejun Heo112202d2013-02-13 19:29:12 -08001296 pwq = get_work_pwq(work);
1297 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001298 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001299
Tejun Heo16062832013-02-06 18:04:53 -08001300 /*
Lai Jiangshan018f3a12021-08-17 09:32:37 +08001301 * A cancelable inactive work item must be in the
1302 * pwq->inactive_works since a queued barrier can't be
1303 * canceled (see the comments in insert_wq_barrier()).
1304 *
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001305 * An inactive work item cannot be grabbed directly because
Lai Jiangshand8127962021-08-17 09:32:38 +08001306 * it might have linked barrier work items which, if left
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001307 * on the inactive_works list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001308 * management later on and cause stall. Make sure the work
1309 * item is activated before grabbing.
1310 */
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001311 if (*work_data_bits(work) & WORK_STRUCT_INACTIVE)
1312 pwq_activate_inactive_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001313
Tejun Heo16062832013-02-06 18:04:53 -08001314 list_del_init(&work->entry);
Lai Jiangshanc4560c22021-08-17 09:32:35 +08001315 pwq_dec_nr_in_flight(pwq, *work_data_bits(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001316
Tejun Heo112202d2013-02-13 19:29:12 -08001317 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001318 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001319
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001320 raw_spin_unlock(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001321 rcu_read_unlock();
Tejun Heo16062832013-02-06 18:04:53 -08001322 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001323 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001324 raw_spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001325fail:
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001326 rcu_read_unlock();
Tejun Heobbb68df2012-08-03 10:30:46 -07001327 local_irq_restore(*flags);
1328 if (work_is_canceling(work))
1329 return -ENOENT;
1330 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001331 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001332}
1333
1334/**
Tejun Heo706026c2013-01-24 11:01:34 -08001335 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001336 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001337 * @work: work to insert
1338 * @head: insertion point
1339 * @extra_flags: extra WORK_STRUCT_* flags to set
1340 *
Tejun Heo112202d2013-02-13 19:29:12 -08001341 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001342 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001343 *
1344 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001345 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001346 */
Tejun Heo112202d2013-02-13 19:29:12 -08001347static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1348 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001349{
Tejun Heo112202d2013-02-13 19:29:12 -08001350 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001351
Walter Wue89a85d2020-12-14 19:09:09 -08001352 /* record the work call stack in order to print it in KASAN reports */
1353 kasan_record_aux_stack(work);
1354
Tejun Heo4690c4a2010-06-29 10:07:10 +02001355 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001356 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001357 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001358 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001359
1360 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001361 * Ensure either wq_worker_sleeping() sees the above
1362 * list_add_tail() or we see zero nr_running to avoid workers lying
1363 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001364 */
1365 smp_mb();
1366
Tejun Heo63d95a92012-07-12 14:46:37 -07001367 if (__need_more_worker(pool))
1368 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001369}
1370
Tejun Heoc8efcc22010-12-20 19:32:04 +01001371/*
1372 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001373 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001374 */
1375static bool is_chained_work(struct workqueue_struct *wq)
1376{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001377 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001378
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001379 worker = current_wq_worker();
1380 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001381 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001382 * I'm @worker, it's safe to dereference it without locking.
1383 */
Tejun Heo112202d2013-02-13 19:29:12 -08001384 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001385}
1386
Mike Galbraithef5571802016-02-09 17:59:38 -05001387/*
1388 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1389 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1390 * avoid perturbing sensitive tasks.
1391 */
1392static int wq_select_unbound_cpu(int cpu)
1393{
Tejun Heof303fccb2016-02-09 17:59:38 -05001394 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001395 int new_cpu;
1396
Tejun Heof303fccb2016-02-09 17:59:38 -05001397 if (likely(!wq_debug_force_rr_cpu)) {
1398 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1399 return cpu;
1400 } else if (!printed_dbg_warning) {
1401 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1402 printed_dbg_warning = true;
1403 }
1404
Mike Galbraithef5571802016-02-09 17:59:38 -05001405 if (cpumask_empty(wq_unbound_cpumask))
1406 return cpu;
1407
1408 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1409 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1410 if (unlikely(new_cpu >= nr_cpu_ids)) {
1411 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1412 if (unlikely(new_cpu >= nr_cpu_ids))
1413 return cpu;
1414 }
1415 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1416
1417 return new_cpu;
1418}
1419
Tejun Heod84ff052013-03-12 11:29:59 -07001420static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 struct work_struct *work)
1422{
Tejun Heo112202d2013-02-13 19:29:12 -08001423 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001424 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001425 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001426 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001427 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001428
1429 /*
1430 * While a work item is PENDING && off queue, a task trying to
1431 * steal the PENDING will busy-loop waiting for it to either get
1432 * queued or lose PENDING. Grabbing PENDING and queueing should
1433 * happen with IRQ disabled.
1434 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001435 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001437
Li Bin9ef28a72013-09-09 13:13:58 +08001438 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001439 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001440 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001441 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001442 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001443retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001444 /* pwq which will be used unless @work is executing elsewhere */
Hillf Dantonaa202f12020-01-24 20:14:45 -05001445 if (wq->flags & WQ_UNBOUND) {
1446 if (req_cpu == WORK_CPU_UNBOUND)
1447 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001448 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Dantonaa202f12020-01-24 20:14:45 -05001449 } else {
1450 if (req_cpu == WORK_CPU_UNBOUND)
1451 cpu = raw_smp_processor_id();
1452 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1453 }
Tejun Heodbf25762012-08-20 14:51:23 -07001454
Tejun Heoc9178082013-03-12 11:30:04 -07001455 /*
1456 * If @work was previously on a different pool, it might still be
1457 * running there, in which case the work needs to be queued on that
1458 * pool to guarantee non-reentrancy.
1459 */
1460 last_pool = get_work_pool(work);
1461 if (last_pool && last_pool != pwq->pool) {
1462 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001463
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001464 raw_spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001465
Tejun Heoc9178082013-03-12 11:30:04 -07001466 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001467
Tejun Heoc9178082013-03-12 11:30:04 -07001468 if (worker && worker->current_pwq->wq == wq) {
1469 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001470 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001471 /* meh... not running there, queue here */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001472 raw_spin_unlock(&last_pool->lock);
1473 raw_spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001474 }
Tejun Heof3421792010-07-02 10:03:51 +02001475 } else {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001476 raw_spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001477 }
1478
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001479 /*
1480 * pwq is determined and locked. For unbound pools, we could have
1481 * raced with pwq release and it could already be dead. If its
1482 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001483 * without another pwq replacing it in the numa_pwq_tbl or while
1484 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001485 * make forward-progress.
1486 */
1487 if (unlikely(!pwq->refcnt)) {
1488 if (wq->flags & WQ_UNBOUND) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001489 raw_spin_unlock(&pwq->pool->lock);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001490 cpu_relax();
1491 goto retry;
1492 }
1493 /* oops */
1494 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1495 wq->name, cpu);
1496 }
1497
Tejun Heo112202d2013-02-13 19:29:12 -08001498 /* pwq determined, queue */
1499 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001500
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001501 if (WARN_ON(!list_empty(&work->entry)))
1502 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001503
Tejun Heo112202d2013-02-13 19:29:12 -08001504 pwq->nr_in_flight[pwq->work_color]++;
1505 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001506
Tejun Heo112202d2013-02-13 19:29:12 -08001507 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001508 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001509 pwq->nr_active++;
1510 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001511 if (list_empty(worklist))
1512 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001513 } else {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08001514 work_flags |= WORK_STRUCT_INACTIVE;
1515 worklist = &pwq->inactive_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001516 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001517
Zqiang0687c662021-02-18 11:16:49 +08001518 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001519 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001520
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001521out:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001522 raw_spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001523 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524}
1525
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001526/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001527 * queue_work_on - queue work on specific cpu
1528 * @cpu: CPU number to execute work on
1529 * @wq: workqueue to use
1530 * @work: work to queue
1531 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001532 * We queue the work to a specific CPU, the caller must ensure it
1533 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001534 *
1535 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001536 */
Tejun Heod4283e92012-08-03 10:30:44 -07001537bool queue_work_on(int cpu, struct workqueue_struct *wq,
1538 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001539{
Tejun Heod4283e92012-08-03 10:30:44 -07001540 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001541 unsigned long flags;
1542
1543 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001544
Tejun Heo22df02b2010-06-29 10:07:10 +02001545 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001546 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001547 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001548 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001549
1550 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001551 return ret;
1552}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001553EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001554
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001555/**
1556 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1557 * @node: NUMA node ID that we want to select a CPU from
1558 *
1559 * This function will attempt to find a "random" cpu available on a given
1560 * node. If there are no CPUs available on the given node it will return
1561 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1562 * available CPU if we need to schedule this work.
1563 */
1564static int workqueue_select_cpu_near(int node)
1565{
1566 int cpu;
1567
1568 /* No point in doing this if NUMA isn't enabled for workqueues */
1569 if (!wq_numa_enabled)
1570 return WORK_CPU_UNBOUND;
1571
1572 /* Delay binding to CPU if node is not valid or online */
1573 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1574 return WORK_CPU_UNBOUND;
1575
1576 /* Use local node/cpu if we are already there */
1577 cpu = raw_smp_processor_id();
1578 if (node == cpu_to_node(cpu))
1579 return cpu;
1580
1581 /* Use "random" otherwise know as "first" online CPU of node */
1582 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1583
1584 /* If CPU is valid return that, otherwise just defer */
1585 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1586}
1587
1588/**
1589 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1590 * @node: NUMA node that we are targeting the work for
1591 * @wq: workqueue to use
1592 * @work: work to queue
1593 *
1594 * We queue the work to a "random" CPU within a given NUMA node. The basic
1595 * idea here is to provide a way to somehow associate work with a given
1596 * NUMA node.
1597 *
1598 * This function will only make a best effort attempt at getting this onto
1599 * the right NUMA node. If no node is requested or the requested node is
1600 * offline then we just fall back to standard queue_work behavior.
1601 *
1602 * Currently the "random" CPU ends up being the first available CPU in the
1603 * intersection of cpu_online_mask and the cpumask of the node, unless we
1604 * are running on the node. In that case we just use the current CPU.
1605 *
1606 * Return: %false if @work was already on a queue, %true otherwise.
1607 */
1608bool queue_work_node(int node, struct workqueue_struct *wq,
1609 struct work_struct *work)
1610{
1611 unsigned long flags;
1612 bool ret = false;
1613
1614 /*
1615 * This current implementation is specific to unbound workqueues.
1616 * Specifically we only return the first available CPU for a given
1617 * node instead of cycling through individual CPUs within the node.
1618 *
1619 * If this is used with a per-cpu workqueue then the logic in
1620 * workqueue_select_cpu_near would need to be updated to allow for
1621 * some round robin type logic.
1622 */
1623 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1624
1625 local_irq_save(flags);
1626
1627 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1628 int cpu = workqueue_select_cpu_near(node);
1629
1630 __queue_work(cpu, wq, work);
1631 ret = true;
1632 }
1633
1634 local_irq_restore(flags);
1635 return ret;
1636}
1637EXPORT_SYMBOL_GPL(queue_work_node);
1638
Kees Cook8c20feb2017-10-04 16:27:07 -07001639void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640{
Kees Cook8c20feb2017-10-04 16:27:07 -07001641 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001643 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001644 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001646EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001648static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1649 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001651 struct timer_list *timer = &dwork->timer;
1652 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Tejun Heo637fdba2017-03-06 15:33:42 -05001654 WARN_ON_ONCE(!wq);
Sami Tolvanen98173112021-04-08 11:28:30 -07001655 WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001656 WARN_ON_ONCE(timer_pending(timer));
1657 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001658
Tejun Heo8852aac2012-12-01 16:23:42 -08001659 /*
1660 * If @delay is 0, queue @dwork->work immediately. This is for
1661 * both optimization and correctness. The earliest @timer can
1662 * expire is on the closest next tick and delayed_work users depend
1663 * on that there's no such delay when @delay is 0.
1664 */
1665 if (!delay) {
1666 __queue_work(cpu, wq, &dwork->work);
1667 return;
1668 }
1669
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001670 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001671 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001672 timer->expires = jiffies + delay;
1673
Tejun Heo041bd122016-02-09 16:11:26 -05001674 if (unlikely(cpu != WORK_CPU_UNBOUND))
1675 add_timer_on(timer, cpu);
1676 else
1677 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001680/**
1681 * queue_delayed_work_on - queue work on specific CPU after delay
1682 * @cpu: CPU number to execute work on
1683 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001684 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001685 * @delay: number of jiffies to wait before queueing
1686 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001687 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001688 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1689 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001690 */
Tejun Heod4283e92012-08-03 10:30:44 -07001691bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1692 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001693{
David Howells52bad642006-11-22 14:54:01 +00001694 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001695 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001696 unsigned long flags;
1697
1698 /* read the comment in __queue_work() */
1699 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001700
Tejun Heo22df02b2010-06-29 10:07:10 +02001701 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001702 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001703 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001704 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001705
1706 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001707 return ret;
1708}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001709EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Tejun Heoc8e55f32010-06-29 10:07:12 +02001711/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001712 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1713 * @cpu: CPU number to execute work on
1714 * @wq: workqueue to use
1715 * @dwork: work to queue
1716 * @delay: number of jiffies to wait before queueing
1717 *
1718 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1719 * modify @dwork's timer so that it expires after @delay. If @delay is
1720 * zero, @work is guaranteed to be scheduled immediately regardless of its
1721 * current state.
1722 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001723 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001724 * pending and its timer was modified.
1725 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001726 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001727 * See try_to_grab_pending() for details.
1728 */
1729bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1730 struct delayed_work *dwork, unsigned long delay)
1731{
1732 unsigned long flags;
1733 int ret;
1734
1735 do {
1736 ret = try_to_grab_pending(&dwork->work, true, &flags);
1737 } while (unlikely(ret == -EAGAIN));
1738
1739 if (likely(ret >= 0)) {
1740 __queue_delayed_work(cpu, wq, dwork, delay);
1741 local_irq_restore(flags);
1742 }
1743
1744 /* -ENOENT from try_to_grab_pending() becomes %true */
1745 return ret;
1746}
1747EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1748
Tejun Heo05f0fe62018-03-14 12:45:13 -07001749static void rcu_work_rcufn(struct rcu_head *rcu)
1750{
1751 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1752
1753 /* read the comment in __queue_work() */
1754 local_irq_disable();
1755 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1756 local_irq_enable();
1757}
1758
1759/**
1760 * queue_rcu_work - queue work after a RCU grace period
1761 * @wq: workqueue to use
1762 * @rwork: work to queue
1763 *
1764 * Return: %false if @rwork was already pending, %true otherwise. Note
1765 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001766 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001767 * execution may happen before a full RCU grace period has passed.
1768 */
1769bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1770{
1771 struct work_struct *work = &rwork->work;
1772
1773 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1774 rwork->wq = wq;
1775 call_rcu(&rwork->rcu, rcu_work_rcufn);
1776 return true;
1777 }
1778
1779 return false;
1780}
1781EXPORT_SYMBOL(queue_rcu_work);
1782
Tejun Heo8376fe22012-08-03 10:30:47 -07001783/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001784 * worker_enter_idle - enter idle state
1785 * @worker: worker which is entering idle state
1786 *
1787 * @worker is entering idle state. Update stats and idle timer if
1788 * necessary.
1789 *
1790 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001791 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001792 */
1793static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001795 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796
Tejun Heo6183c002013-03-12 11:29:57 -07001797 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1798 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1799 (worker->hentry.next || worker->hentry.pprev)))
1800 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801
Lai Jiangshan051e1852014-07-22 13:03:02 +08001802 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001803 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001804 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001805 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001806
Tejun Heoc8e55f32010-06-29 10:07:12 +02001807 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001808 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001809
Tejun Heo628c78e2012-07-17 12:39:27 -07001810 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1811 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001812
Tejun Heo544ecf32012-05-14 15:04:50 -07001813 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001814 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001815 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001816 * nr_running, the warning may trigger spuriously. Check iff
1817 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001818 */
Tejun Heo24647572013-01-24 11:01:33 -08001819 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001820 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001821 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822}
1823
Tejun Heoc8e55f32010-06-29 10:07:12 +02001824/**
1825 * worker_leave_idle - leave idle state
1826 * @worker: worker which is leaving idle state
1827 *
1828 * @worker is leaving idle state. Update stats.
1829 *
1830 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001831 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001832 */
1833static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001835 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
Tejun Heo6183c002013-03-12 11:29:57 -07001837 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1838 return;
Tejun Heod302f012010-06-29 10:07:13 +02001839 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001840 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001841 list_del_init(&worker->entry);
1842}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001844static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001845{
1846 struct worker *worker;
1847
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001848 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001849 if (worker) {
1850 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001851 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001852 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 /* on creation a worker is in !idle && prep state */
1854 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001855 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001856 return worker;
1857}
1858
1859/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001860 * worker_attach_to_pool() - attach a worker to a pool
1861 * @worker: worker to be attached
1862 * @pool: the target pool
1863 *
1864 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1865 * cpu-binding of @worker are kept coordinated with the pool across
1866 * cpu-[un]hotplugs.
1867 */
1868static void worker_attach_to_pool(struct worker *worker,
1869 struct worker_pool *pool)
1870{
Tejun Heo1258fae2018-05-18 08:47:13 -07001871 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001872
1873 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001874 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1875 * stable across this function. See the comments above the flag
1876 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001877 */
1878 if (pool->flags & POOL_DISASSOCIATED)
1879 worker->flags |= WORKER_UNBOUND;
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001880 else
1881 kthread_set_per_cpu(worker->task, pool->cpu);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001882
Peter Zijlstra640f17c2021-01-15 19:08:36 +01001883 if (worker->rescue_wq)
1884 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1885
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001886 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001887 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001888
Tejun Heo1258fae2018-05-18 08:47:13 -07001889 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001890}
1891
1892/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001893 * worker_detach_from_pool() - detach a worker from its pool
1894 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001895 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001896 * Undo the attaching which had been done in worker_attach_to_pool(). The
1897 * caller worker shouldn't access to the pool after detached except it has
1898 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001899 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001900static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001901{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001902 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001903 struct completion *detach_completion = NULL;
1904
Tejun Heo1258fae2018-05-18 08:47:13 -07001905 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001906
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001907 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshanda028462014-05-20 17:46:31 +08001908 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001909 worker->pool = NULL;
1910
Lai Jiangshanda028462014-05-20 17:46:31 +08001911 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001912 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001913 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001914
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001915 /* clear leftover flags without pool->lock after it is detached */
1916 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1917
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001918 if (detach_completion)
1919 complete(detach_completion);
1920}
1921
1922/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001923 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001925 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001926 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001927 *
1928 * CONTEXT:
1929 * Might sleep. Does GFP_KERNEL allocations.
1930 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001931 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001932 * Pointer to the newly created worker.
1933 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001934static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001935{
Zhen Leie441b562021-08-04 11:50:36 +08001936 struct worker *worker;
1937 int id;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001938 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001939
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001940 /* ID is needed to determine kthread name */
Zhen Leie441b562021-08-04 11:50:36 +08001941 id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001942 if (id < 0)
Zhen Leie441b562021-08-04 11:50:36 +08001943 return NULL;
Tejun Heoc34056a2010-06-29 10:07:11 +02001944
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001945 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001946 if (!worker)
1947 goto fail;
1948
Tejun Heoc34056a2010-06-29 10:07:11 +02001949 worker->id = id;
1950
Tejun Heo29c91e92013-03-12 11:30:03 -07001951 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001952 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1953 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001954 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001955 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1956
Tejun Heof3f90ad2013-04-01 11:23:34 -07001957 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001958 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 if (IS_ERR(worker->task))
1960 goto fail;
1961
Oleg Nesterov91151222013-11-14 12:56:18 +01001962 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001963 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001964
Lai Jiangshanda028462014-05-20 17:46:31 +08001965 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001966 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001967
Lai Jiangshan051e1852014-07-22 13:03:02 +08001968 /* start the newly created worker */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001969 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001970 worker->pool->nr_workers++;
1971 worker_enter_idle(worker);
1972 wake_up_process(worker->task);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001973 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001974
Tejun Heoc34056a2010-06-29 10:07:11 +02001975 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001976
Tejun Heoc34056a2010-06-29 10:07:11 +02001977fail:
Zhen Leie441b562021-08-04 11:50:36 +08001978 ida_free(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001979 kfree(worker);
1980 return NULL;
1981}
1982
1983/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001984 * destroy_worker - destroy a workqueue worker
1985 * @worker: worker to be destroyed
1986 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001987 * Destroy @worker and adjust @pool stats accordingly. The worker should
1988 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001989 *
1990 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001991 * raw_spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001992 */
1993static void destroy_worker(struct worker *worker)
1994{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001995 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001996
Tejun Heocd549682013-03-13 19:47:39 -07001997 lockdep_assert_held(&pool->lock);
1998
Tejun Heoc34056a2010-06-29 10:07:11 +02001999 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07002000 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08002001 WARN_ON(!list_empty(&worker->scheduled)) ||
2002 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07002003 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02002004
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08002005 pool->nr_workers--;
2006 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08002007
Tejun Heoc8e55f32010-06-29 10:07:12 +02002008 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02002009 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002010 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02002011}
2012
Kees Cook32a6c722017-10-16 15:58:25 -07002013static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002014{
Kees Cook32a6c722017-10-16 15:58:25 -07002015 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002016
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002017 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002018
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002019 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002020 struct worker *worker;
2021 unsigned long expires;
2022
2023 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07002024 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002025 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2026
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002027 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002028 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002029 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002030 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002031
2032 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 }
2034
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002035 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002036}
2037
Tejun Heo493a1722013-03-12 11:29:59 -07002038static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002039{
Tejun Heo112202d2013-02-13 19:29:12 -08002040 struct pool_workqueue *pwq = get_work_pwq(work);
2041 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002042
Tejun Heo2e109a22013-03-13 19:47:40 -07002043 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002044
Tejun Heo493008a2013-03-12 11:30:03 -07002045 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002046 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002047
2048 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002049 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002050 /*
2051 * If @pwq is for an unbound wq, its base ref may be put at
2052 * any time due to an attribute change. Pin @pwq until the
2053 * rescuer is done with it.
2054 */
2055 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002056 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002057 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002058 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002059}
2060
Kees Cook32a6c722017-10-16 15:58:25 -07002061static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002062{
Kees Cook32a6c722017-10-16 15:58:25 -07002063 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002064 struct work_struct *work;
2065
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002066 raw_spin_lock_irq(&pool->lock);
2067 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002068
Tejun Heo63d95a92012-07-12 14:46:37 -07002069 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002070 /*
2071 * We've been trying to create a new worker but
2072 * haven't been successful. We might be hitting an
2073 * allocation deadlock. Send distress signals to
2074 * rescuers.
2075 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002076 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002077 send_mayday(work);
2078 }
2079
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002080 raw_spin_unlock(&wq_mayday_lock);
2081 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002082
Tejun Heo63d95a92012-07-12 14:46:37 -07002083 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002084}
2085
2086/**
2087 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002088 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002089 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002090 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002091 * have at least one idle worker on return from this function. If
2092 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002093 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002094 * possible allocation deadlock.
2095 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002096 * On return, need_to_create_worker() is guaranteed to be %false and
2097 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002098 *
2099 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002100 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002101 * multiple times. Does GFP_KERNEL allocations. Called only from
2102 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002103 */
Tejun Heo29187a92015-01-16 14:21:16 -05002104static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002105__releases(&pool->lock)
2106__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002107{
Tejun Heoe22bee72010-06-29 10:07:14 +02002108restart:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002109 raw_spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002110
Tejun Heoe22bee72010-06-29 10:07:14 +02002111 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002112 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002113
2114 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002115 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002116 break;
2117
Lai Jiangshane212f362014-06-03 15:32:17 +08002118 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002119
Tejun Heo63d95a92012-07-12 14:46:37 -07002120 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002121 break;
2122 }
2123
Tejun Heo63d95a92012-07-12 14:46:37 -07002124 del_timer_sync(&pool->mayday_timer);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002125 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002126 /*
2127 * This is necessary even after a new worker was just successfully
2128 * created as @pool->lock was dropped and the new worker might have
2129 * already become busy.
2130 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002131 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002132 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002133}
2134
2135/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002136 * manage_workers - manage worker pool
2137 * @worker: self
2138 *
Tejun Heo706026c2013-01-24 11:01:34 -08002139 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002140 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002141 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002142 *
2143 * The caller can safely start processing works on false return. On
2144 * true return, it's guaranteed that need_to_create_worker() is false
2145 * and may_start_working() is true.
2146 *
2147 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002148 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002149 * multiple times. Does GFP_KERNEL allocations.
2150 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002151 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002152 * %false if the pool doesn't need management and the caller can safely
2153 * start processing works, %true if management function was performed and
2154 * the conditions that the caller verified before calling the function may
2155 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002156 */
2157static bool manage_workers(struct worker *worker)
2158{
Tejun Heo63d95a92012-07-12 14:46:37 -07002159 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002160
Tejun Heo692b4822017-10-09 08:04:13 -07002161 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002162 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002163
2164 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002165 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002166
Tejun Heo29187a92015-01-16 14:21:16 -05002167 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002168
Tejun Heo2607d7a2015-03-09 09:22:28 -04002169 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002170 pool->flags &= ~POOL_MANAGER_ACTIVE;
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02002171 rcuwait_wake_up(&manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002172 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002173}
2174
Tejun Heoa62428c2010-06-29 10:07:10 +02002175/**
2176 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002177 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002178 * @work: work to process
2179 *
2180 * Process @work. This function contains all the logics necessary to
2181 * process a single work including synchronization against and
2182 * interaction with other workers on the same cpu, queueing and
2183 * flushing. As long as context requirement is met, any worker can
2184 * call this function to process a work.
2185 *
2186 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002187 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002188 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002189static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002190__releases(&pool->lock)
2191__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002192{
Tejun Heo112202d2013-02-13 19:29:12 -08002193 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002194 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002195 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002196 unsigned long work_data;
Tejun Heo7e116292010-06-29 10:07:13 +02002197 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002198#ifdef CONFIG_LOCKDEP
2199 /*
2200 * It is permissible to free the struct work_struct from
2201 * inside the function that is called from it, this we need to
2202 * take into account for lockdep too. To avoid bogus "held
2203 * lock freed" warnings as well as problems when looking into
2204 * work->lockdep_map, make a copy and use that here.
2205 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002206 struct lockdep_map lockdep_map;
2207
2208 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002209#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002210 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002211 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002212 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002213
Tejun Heo7e116292010-06-29 10:07:13 +02002214 /*
2215 * A single work shouldn't be executed concurrently by
2216 * multiple workers on a single cpu. Check whether anyone is
2217 * already processing the work. If so, defer the work to the
2218 * currently executing one.
2219 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002220 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002221 if (unlikely(collision)) {
2222 move_linked_works(work, &collision->scheduled, NULL);
2223 return;
2224 }
2225
Tejun Heo8930cab2012-08-03 10:30:45 -07002226 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002227 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002228 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002229 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002230 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002231 worker->current_pwq = pwq;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002232 work_data = *work_data_bits(work);
Lai Jiangshand8127962021-08-17 09:32:38 +08002233 worker->current_color = get_work_color(work_data);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002234
Tejun Heo8bf89592018-05-18 08:47:13 -07002235 /*
2236 * Record wq name for cmdline and debug reporting, may get
2237 * overridden through set_worker_desc().
2238 */
2239 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2240
Tejun Heoa62428c2010-06-29 10:07:10 +02002241 list_del_init(&work->entry);
2242
Tejun Heo649027d2010-06-29 10:07:14 +02002243 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002244 * CPU intensive works don't participate in concurrency management.
2245 * They're the scheduler's responsibility. This takes @worker out
2246 * of concurrency management and the next code block will chain
2247 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002248 */
2249 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002250 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002251
Tejun Heo974271c2012-07-12 14:46:37 -07002252 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002253 * Wake up another worker if necessary. The condition is always
2254 * false for normal per-cpu workers since nr_running would always
2255 * be >= 1 at this point. This is used to chain execution of the
2256 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002257 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002258 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002259 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002260 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002261
Tejun Heo8930cab2012-08-03 10:30:45 -07002262 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002263 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002264 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002265 * PENDING and queued state changes happen together while IRQ is
2266 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002267 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002268 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002269
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002270 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002271
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002272 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002273 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002274 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002275 * Strictly speaking we should mark the invariant state without holding
2276 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002277 *
2278 * However, that would result in:
2279 *
2280 * A(W1)
2281 * WFC(C)
2282 * A(W1)
2283 * C(C)
2284 *
2285 * Which would create W1->C->W1 dependencies, even though there is no
2286 * actual deadlock possible. There are two solutions, using a
2287 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002288 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002289 * these locks.
2290 *
2291 * AFAICT there is no possible deadlock scenario between the
2292 * flush_work() and complete() primitives (except for single-threaded
2293 * workqueues), so hiding them isn't a problem.
2294 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002295 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002296 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002297 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002298 /*
2299 * While we must be careful to not use "work" after this, the trace
2300 * point will only record its address.
2301 */
Daniel Jordan1c5da0e2020-01-13 17:52:39 -05002302 trace_workqueue_execute_end(work, worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002303 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002304 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002305
2306 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002307 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002308 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002309 current->comm, preempt_count(), task_pid_nr(current),
2310 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002311 debug_show_held_locks(current);
2312 dump_stack();
2313 }
2314
Tejun Heob22ce272013-08-28 17:33:37 -04002315 /*
Sebastian Andrzej Siewior025f50f2019-10-15 21:18:21 +02002316 * The following prevents a kworker from hogging CPU on !PREEMPTION
Tejun Heob22ce272013-08-28 17:33:37 -04002317 * kernels, where a requeueing work item waiting for something to
2318 * happen could deadlock with stop_machine as such work item could
2319 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002320 * stop_machine. At the same time, report a quiescent RCU state so
2321 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002322 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002323 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002324
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002325 raw_spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002326
Tejun Heofb0e7be2010-06-29 10:07:15 +02002327 /* clear cpu intensive status */
2328 if (unlikely(cpu_intensive))
2329 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2330
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002331 /* tag the worker for identification in schedule() */
2332 worker->last_func = worker->current_func;
2333
Tejun Heoa62428c2010-06-29 10:07:10 +02002334 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002335 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002336 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002337 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002338 worker->current_pwq = NULL;
Lai Jiangshand8127962021-08-17 09:32:38 +08002339 worker->current_color = INT_MAX;
Lai Jiangshanc4560c22021-08-17 09:32:35 +08002340 pwq_dec_nr_in_flight(pwq, work_data);
Tejun Heoa62428c2010-06-29 10:07:10 +02002341}
2342
Tejun Heoaffee4b2010-06-29 10:07:12 +02002343/**
2344 * process_scheduled_works - process scheduled works
2345 * @worker: self
2346 *
2347 * Process all scheduled works. Please note that the scheduled list
2348 * may change while processing a work, so this function repeatedly
2349 * fetches a work from the top and executes it.
2350 *
2351 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002352 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002353 * multiple times.
2354 */
2355static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002357 while (!list_empty(&worker->scheduled)) {
2358 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002360 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362}
2363
Tejun Heo197f6ac2018-05-21 08:04:35 -07002364static void set_pf_worker(bool val)
2365{
2366 mutex_lock(&wq_pool_attach_mutex);
2367 if (val)
2368 current->flags |= PF_WQ_WORKER;
2369 else
2370 current->flags &= ~PF_WQ_WORKER;
2371 mutex_unlock(&wq_pool_attach_mutex);
2372}
2373
Tejun Heo4690c4a2010-06-29 10:07:10 +02002374/**
2375 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002376 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002377 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002378 * The worker thread function. All workers belong to a worker_pool -
2379 * either a per-cpu one or dynamic unbound one. These workers process all
2380 * work items regardless of their specific target workqueue. The only
2381 * exception is work items which belong to workqueues with a rescuer which
2382 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002383 *
2384 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002385 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002386static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387{
Tejun Heoc34056a2010-06-29 10:07:11 +02002388 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002389 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002392 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002393woke_up:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002394 raw_spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002395
Tejun Heoa9ab7752013-03-19 13:45:21 -07002396 /* am I supposed to die? */
2397 if (unlikely(worker->flags & WORKER_DIE)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002398 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002399 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002400 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002401
2402 set_task_comm(worker->task, "kworker/dying");
Zhen Leie441b562021-08-04 11:50:36 +08002403 ida_free(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002404 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002405 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002406 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002408
Tejun Heoc8e55f32010-06-29 10:07:12 +02002409 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002410recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002411 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002412 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002413 goto sleep;
2414
2415 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002416 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002417 goto recheck;
2418
Tejun Heoc8e55f32010-06-29 10:07:12 +02002419 /*
2420 * ->scheduled list can only be filled while a worker is
2421 * preparing to process a work or actually processing it.
2422 * Make sure nobody diddled with it while I was sleeping.
2423 */
Tejun Heo6183c002013-03-12 11:29:57 -07002424 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002425
Tejun Heoe22bee72010-06-29 10:07:14 +02002426 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002427 * Finish PREP stage. We're guaranteed to have at least one idle
2428 * worker or that someone else has already assumed the manager
2429 * role. This is where @worker starts participating in concurrency
2430 * management if applicable and concurrency management is restored
2431 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002432 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002433 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002434
2435 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002436 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002437 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002438 struct work_struct, entry);
2439
Tejun Heo82607adc2015-12-08 11:28:04 -05002440 pool->watchdog_ts = jiffies;
2441
Tejun Heoc8e55f32010-06-29 10:07:12 +02002442 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2443 /* optimization path, not strictly necessary */
2444 process_one_work(worker, work);
2445 if (unlikely(!list_empty(&worker->scheduled)))
2446 process_scheduled_works(worker);
2447 } else {
2448 move_linked_works(work, &worker->scheduled, NULL);
2449 process_scheduled_works(worker);
2450 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002451 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002452
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002453 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002454sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002455 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002456 * pool->lock is held and there's no work to process and no need to
2457 * manage, sleep. Workers are woken up only while holding
2458 * pool->lock or from local cpu, so setting the current state
2459 * before releasing pool->lock is enough to prevent losing any
2460 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002461 */
2462 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002463 __set_current_state(TASK_IDLE);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002464 raw_spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002465 schedule();
2466 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467}
2468
Tejun Heoe22bee72010-06-29 10:07:14 +02002469/**
2470 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002471 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002472 *
2473 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002474 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002475 *
Tejun Heo706026c2013-01-24 11:01:34 -08002476 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002477 * worker which uses GFP_KERNEL allocation which has slight chance of
2478 * developing into deadlock if some works currently on the same queue
2479 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2480 * the problem rescuer solves.
2481 *
Tejun Heo706026c2013-01-24 11:01:34 -08002482 * When such condition is possible, the pool summons rescuers of all
2483 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002484 * those works so that forward progress can be guaranteed.
2485 *
2486 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002487 *
2488 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002489 */
Tejun Heo111c2252013-01-17 17:16:24 -08002490static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002491{
Tejun Heo111c2252013-01-17 17:16:24 -08002492 struct worker *rescuer = __rescuer;
2493 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002494 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002495 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002496
2497 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002498
2499 /*
2500 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2501 * doesn't participate in concurrency management.
2502 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002503 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002504repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002505 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002506
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002507 /*
2508 * By the time the rescuer is requested to stop, the workqueue
2509 * shouldn't have any work pending, but @wq->maydays may still have
2510 * pwq(s) queued. This can happen by non-rescuer workers consuming
2511 * all the work items before the rescuer got to them. Go through
2512 * @wq->maydays processing before acting on should_stop so that the
2513 * list is always empty on exit.
2514 */
2515 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002516
Tejun Heo493a1722013-03-12 11:29:59 -07002517 /* see whether any pwq is asking for help */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002518 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002519
2520 while (!list_empty(&wq->maydays)) {
2521 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2522 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002523 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002524 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002525 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002526
2527 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002528 list_del_init(&pwq->mayday_node);
2529
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002530 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002531
Lai Jiangshan51697d392014-05-20 17:46:36 +08002532 worker_attach_to_pool(rescuer, pool);
2533
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002534 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002535
2536 /*
2537 * Slurp in all works issued via this workqueue and
2538 * process'em.
2539 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002540 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002541 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2542 if (get_work_pwq(work) == pwq) {
2543 if (first)
2544 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002545 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002546 }
2547 first = false;
2548 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002549
NeilBrown008847f2014-12-08 12:39:16 -05002550 if (!list_empty(scheduled)) {
2551 process_scheduled_works(rescuer);
2552
2553 /*
2554 * The above execution of rescued work items could
2555 * have created more to rescue through
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08002556 * pwq_activate_first_inactive() or chained
NeilBrown008847f2014-12-08 12:39:16 -05002557 * queueing. Let's put @pwq back on mayday list so
2558 * that such back-to-back work items, which may be
2559 * being used to relieve memory pressure, don't
2560 * incur MAYDAY_INTERVAL delay inbetween.
2561 */
Lai Jiangshan4f3f4cf2020-05-29 06:58:59 +00002562 if (pwq->nr_active && need_to_create_worker(pool)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002563 raw_spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002564 /*
2565 * Queue iff we aren't racing destruction
2566 * and somebody else hasn't queued it already.
2567 */
2568 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2569 get_pwq(pwq);
2570 list_add_tail(&pwq->mayday_node, &wq->maydays);
2571 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002572 raw_spin_unlock(&wq_mayday_lock);
NeilBrown008847f2014-12-08 12:39:16 -05002573 }
2574 }
Tejun Heo75769582011-02-14 14:04:46 +01002575
2576 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002577 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002578 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002579 */
2580 put_pwq(pwq);
2581
2582 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002583 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002584 * regular worker; otherwise, we end up with 0 concurrency
2585 * and stalling the execution.
2586 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002587 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002588 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002589
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002590 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002591
Tejun Heoa2d812a2018-05-18 08:47:13 -07002592 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002593
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002594 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002595 }
2596
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002597 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002598
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002599 if (should_stop) {
2600 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002601 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002602 return 0;
2603 }
2604
Tejun Heo111c2252013-01-17 17:16:24 -08002605 /* rescuers should never participate in concurrency management */
2606 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002607 schedule();
2608 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609}
2610
Tejun Heofca839c2015-12-07 10:58:57 -05002611/**
2612 * check_flush_dependency - check for flush dependency sanity
2613 * @target_wq: workqueue being flushed
2614 * @target_work: work item being flushed (NULL for workqueue flushes)
2615 *
2616 * %current is trying to flush the whole @target_wq or @target_work on it.
2617 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2618 * reclaiming memory or running on a workqueue which doesn't have
2619 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2620 * a deadlock.
2621 */
2622static void check_flush_dependency(struct workqueue_struct *target_wq,
2623 struct work_struct *target_work)
2624{
2625 work_func_t target_func = target_work ? target_work->func : NULL;
2626 struct worker *worker;
2627
2628 if (target_wq->flags & WQ_MEM_RECLAIM)
2629 return;
2630
2631 worker = current_wq_worker();
2632
2633 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002634 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002635 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002636 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2637 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002638 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002639 worker->current_pwq->wq->name, worker->current_func,
2640 target_wq->name, target_func);
2641}
2642
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002643struct wq_barrier {
2644 struct work_struct work;
2645 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002646 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002647};
2648
2649static void wq_barrier_func(struct work_struct *work)
2650{
2651 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2652 complete(&barr->done);
2653}
2654
Tejun Heo4690c4a2010-06-29 10:07:10 +02002655/**
2656 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002657 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002658 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002659 * @target: target work to attach @barr to
2660 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002661 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002662 * @barr is linked to @target such that @barr is completed only after
2663 * @target finishes execution. Please note that the ordering
2664 * guarantee is observed only with respect to @target and on the local
2665 * cpu.
2666 *
2667 * Currently, a queued barrier can't be canceled. This is because
2668 * try_to_grab_pending() can't determine whether the work to be
2669 * grabbed is at the head of the queue and thus can't clear LINKED
2670 * flag of the previous work while there must be a valid next work
2671 * after a work with LINKED flag set.
2672 *
2673 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002674 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002675 *
2676 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002677 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002678 */
Tejun Heo112202d2013-02-13 19:29:12 -08002679static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002680 struct wq_barrier *barr,
2681 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002682{
Lai Jiangshand8127962021-08-17 09:32:38 +08002683 unsigned int work_flags = 0;
2684 unsigned int work_color;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002685 struct list_head *head;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002686
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002687 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002688 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002689 * as we know for sure that this will not trigger any of the
2690 * checks and call back into the fixup functions where we
2691 * might deadlock.
2692 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002693 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002694 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002695
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002696 init_completion_map(&barr->done, &target->lockdep_map);
2697
Tejun Heo2607d7a2015-03-09 09:22:28 -04002698 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002699
Lai Jiangshan018f3a12021-08-17 09:32:37 +08002700 /* The barrier work item does not participate in pwq->nr_active. */
2701 work_flags |= WORK_STRUCT_INACTIVE;
2702
Tejun Heoaffee4b2010-06-29 10:07:12 +02002703 /*
2704 * If @target is currently being executed, schedule the
2705 * barrier to the worker; otherwise, put it after @target.
2706 */
Lai Jiangshand8127962021-08-17 09:32:38 +08002707 if (worker) {
Tejun Heoaffee4b2010-06-29 10:07:12 +02002708 head = worker->scheduled.next;
Lai Jiangshand8127962021-08-17 09:32:38 +08002709 work_color = worker->current_color;
2710 } else {
Tejun Heoaffee4b2010-06-29 10:07:12 +02002711 unsigned long *bits = work_data_bits(target);
2712
2713 head = target->entry.next;
2714 /* there can already be other linked works, inherit and set */
Lai Jiangshand21cece2021-08-17 09:32:36 +08002715 work_flags |= *bits & WORK_STRUCT_LINKED;
Lai Jiangshand8127962021-08-17 09:32:38 +08002716 work_color = get_work_color(*bits);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002717 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2718 }
2719
Lai Jiangshand8127962021-08-17 09:32:38 +08002720 pwq->nr_in_flight[work_color]++;
2721 work_flags |= work_color_to_flags(work_color);
2722
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002723 debug_work_activate(&barr->work);
Lai Jiangshand21cece2021-08-17 09:32:36 +08002724 insert_work(pwq, &barr->work, head, work_flags);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002725}
2726
Tejun Heo73f53c42010-06-29 10:07:11 +02002727/**
Tejun Heo112202d2013-02-13 19:29:12 -08002728 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002729 * @wq: workqueue being flushed
2730 * @flush_color: new flush color, < 0 for no-op
2731 * @work_color: new work color, < 0 for no-op
2732 *
Tejun Heo112202d2013-02-13 19:29:12 -08002733 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002734 *
Tejun Heo112202d2013-02-13 19:29:12 -08002735 * If @flush_color is non-negative, flush_color on all pwqs should be
2736 * -1. If no pwq has in-flight commands at the specified color, all
2737 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2738 * has in flight commands, its pwq->flush_color is set to
2739 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002740 * wakeup logic is armed and %true is returned.
2741 *
2742 * The caller should have initialized @wq->first_flusher prior to
2743 * calling this function with non-negative @flush_color. If
2744 * @flush_color is negative, no flush color update is done and %false
2745 * is returned.
2746 *
Tejun Heo112202d2013-02-13 19:29:12 -08002747 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002748 * work_color which is previous to @work_color and all will be
2749 * advanced to @work_color.
2750 *
2751 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002752 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002753 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002754 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002755 * %true if @flush_color >= 0 and there's something to flush. %false
2756 * otherwise.
2757 */
Tejun Heo112202d2013-02-13 19:29:12 -08002758static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002759 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760{
Tejun Heo73f53c42010-06-29 10:07:11 +02002761 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002762 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002763
Tejun Heo73f53c42010-06-29 10:07:11 +02002764 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002765 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002766 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002767 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002768
Tejun Heo49e3cf42013-03-12 11:29:58 -07002769 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002770 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002771
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002772 raw_spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002773
2774 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002775 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002776
Tejun Heo112202d2013-02-13 19:29:12 -08002777 if (pwq->nr_in_flight[flush_color]) {
2778 pwq->flush_color = flush_color;
2779 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002780 wait = true;
2781 }
2782 }
2783
2784 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002785 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002786 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002787 }
2788
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002789 raw_spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002790 }
2791
Tejun Heo112202d2013-02-13 19:29:12 -08002792 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002793 complete(&wq->first_flusher->done);
2794
2795 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796}
2797
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002798/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002800 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002802 * This function sleeps until all work items which were queued on entry
2803 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002805void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806{
Tejun Heo73f53c42010-06-29 10:07:11 +02002807 struct wq_flusher this_flusher = {
2808 .list = LIST_HEAD_INIT(this_flusher.list),
2809 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002810 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002811 };
2812 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002813
Tejun Heo3347fa02016-09-16 15:49:32 -04002814 if (WARN_ON(!wq_online))
2815 return;
2816
Johannes Berg87915ad2018-08-22 11:49:04 +02002817 lock_map_acquire(&wq->lockdep_map);
2818 lock_map_release(&wq->lockdep_map);
2819
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002820 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002821
2822 /*
2823 * Start-to-wait phase
2824 */
2825 next_color = work_next_color(wq->work_color);
2826
2827 if (next_color != wq->flush_color) {
2828 /*
2829 * Color space is not full. The current work_color
2830 * becomes our flush_color and work_color is advanced
2831 * by one.
2832 */
Tejun Heo6183c002013-03-12 11:29:57 -07002833 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002834 this_flusher.flush_color = wq->work_color;
2835 wq->work_color = next_color;
2836
2837 if (!wq->first_flusher) {
2838 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002839 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002840
2841 wq->first_flusher = &this_flusher;
2842
Tejun Heo112202d2013-02-13 19:29:12 -08002843 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002844 wq->work_color)) {
2845 /* nothing to flush, done */
2846 wq->flush_color = next_color;
2847 wq->first_flusher = NULL;
2848 goto out_unlock;
2849 }
2850 } else {
2851 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002852 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002853 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002854 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002855 }
2856 } else {
2857 /*
2858 * Oops, color space is full, wait on overflow queue.
2859 * The next flush completion will assign us
2860 * flush_color and transfer to flusher_queue.
2861 */
2862 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2863 }
2864
Tejun Heofca839c2015-12-07 10:58:57 -05002865 check_flush_dependency(wq, NULL);
2866
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002867 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002868
2869 wait_for_completion(&this_flusher.done);
2870
2871 /*
2872 * Wake-up-and-cascade phase
2873 *
2874 * First flushers are responsible for cascading flushes and
2875 * handling overflow. Non-first flushers can simply return.
2876 */
Chris Wilson00d5d152020-03-10 16:23:19 +00002877 if (READ_ONCE(wq->first_flusher) != &this_flusher)
Tejun Heo73f53c42010-06-29 10:07:11 +02002878 return;
2879
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002880 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002881
Tejun Heo4ce48b32010-07-02 10:03:51 +02002882 /* we might have raced, check again with mutex held */
2883 if (wq->first_flusher != &this_flusher)
2884 goto out_unlock;
2885
Chris Wilson00d5d152020-03-10 16:23:19 +00002886 WRITE_ONCE(wq->first_flusher, NULL);
Tejun Heo73f53c42010-06-29 10:07:11 +02002887
Tejun Heo6183c002013-03-12 11:29:57 -07002888 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2889 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002890
2891 while (true) {
2892 struct wq_flusher *next, *tmp;
2893
2894 /* complete all the flushers sharing the current flush color */
2895 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2896 if (next->flush_color != wq->flush_color)
2897 break;
2898 list_del_init(&next->list);
2899 complete(&next->done);
2900 }
2901
Tejun Heo6183c002013-03-12 11:29:57 -07002902 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2903 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002904
2905 /* this flush_color is finished, advance by one */
2906 wq->flush_color = work_next_color(wq->flush_color);
2907
2908 /* one color has been freed, handle overflow queue */
2909 if (!list_empty(&wq->flusher_overflow)) {
2910 /*
2911 * Assign the same color to all overflowed
2912 * flushers, advance work_color and append to
2913 * flusher_queue. This is the start-to-wait
2914 * phase for these overflowed flushers.
2915 */
2916 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2917 tmp->flush_color = wq->work_color;
2918
2919 wq->work_color = work_next_color(wq->work_color);
2920
2921 list_splice_tail_init(&wq->flusher_overflow,
2922 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002923 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002924 }
2925
2926 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002927 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002928 break;
2929 }
2930
2931 /*
2932 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002933 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002934 */
Tejun Heo6183c002013-03-12 11:29:57 -07002935 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2936 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002937
2938 list_del_init(&next->list);
2939 wq->first_flusher = next;
2940
Tejun Heo112202d2013-02-13 19:29:12 -08002941 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002942 break;
2943
2944 /*
2945 * Meh... this color is already done, clear first
2946 * flusher and repeat cascading.
2947 */
2948 wq->first_flusher = NULL;
2949 }
2950
2951out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002952 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002954EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002956/**
2957 * drain_workqueue - drain a workqueue
2958 * @wq: workqueue to drain
2959 *
2960 * Wait until the workqueue becomes empty. While draining is in progress,
2961 * only chain queueing is allowed. IOW, only currently pending or running
2962 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002963 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002964 * by the depth of chaining and should be relatively short. Whine if it
2965 * takes too long.
2966 */
2967void drain_workqueue(struct workqueue_struct *wq)
2968{
2969 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002970 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002971
2972 /*
2973 * __queue_work() needs to test whether there are drainers, is much
2974 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002975 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002976 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002977 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002978 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002979 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002980 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002981reflush:
2982 flush_workqueue(wq);
2983
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002984 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002985
Tejun Heo49e3cf42013-03-12 11:29:58 -07002986 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002987 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002988
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002989 raw_spin_lock_irq(&pwq->pool->lock);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08002990 drained = !pwq->nr_active && list_empty(&pwq->inactive_works);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002991 raw_spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002992
2993 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002994 continue;
2995
2996 if (++flush_cnt == 10 ||
2997 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Stephen Zhange9ad2eb2021-01-23 16:04:00 +08002998 pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
2999 wq->name, __func__, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07003000
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003001 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003002 goto reflush;
3003 }
3004
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003005 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07003006 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07003007 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003008}
3009EXPORT_SYMBOL_GPL(drain_workqueue);
3010
Johannes Bergd6e89782018-08-22 11:49:03 +02003011static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3012 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02003013{
3014 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003015 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08003016 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02003017
3018 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02003019
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003020 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07003021 pool = get_work_pool(work);
3022 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003023 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07003024 return false;
3025 }
3026
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003027 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08003028 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08003029 pwq = get_work_pwq(work);
3030 if (pwq) {
3031 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02003032 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07003033 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003034 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003035 if (!worker)
3036 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003037 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003038 }
Tejun Heobaf59022010-09-16 10:42:16 +02003039
Tejun Heofca839c2015-12-07 10:58:57 -05003040 check_flush_dependency(pwq->wq, work);
3041
Tejun Heo112202d2013-02-13 19:29:12 -08003042 insert_wq_barrier(pwq, barr, work, worker);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003043 raw_spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003044
Tejun Heoe159489b2011-01-09 23:32:15 +01003045 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003046 * Force a lock recursion deadlock when using flush_work() inside a
3047 * single-threaded or rescuer equipped workqueue.
3048 *
3049 * For single threaded workqueues the deadlock happens when the work
3050 * is after the work issuing the flush_work(). For rescuer equipped
3051 * workqueues the deadlock happens when the rescuer stalls, blocking
3052 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003053 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003054 if (!from_cancel &&
3055 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003056 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003057 lock_map_release(&pwq->wq->lockdep_map);
3058 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003059 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003060 return true;
3061already_gone:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003062 raw_spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003063 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003064 return false;
3065}
3066
Johannes Bergd6e89782018-08-22 11:49:03 +02003067static bool __flush_work(struct work_struct *work, bool from_cancel)
3068{
3069 struct wq_barrier barr;
3070
3071 if (WARN_ON(!wq_online))
3072 return false;
3073
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003074 if (WARN_ON(!work->func))
3075 return false;
3076
Johannes Berg87915ad2018-08-22 11:49:04 +02003077 if (!from_cancel) {
3078 lock_map_acquire(&work->lockdep_map);
3079 lock_map_release(&work->lockdep_map);
3080 }
3081
Johannes Bergd6e89782018-08-22 11:49:03 +02003082 if (start_flush_work(work, &barr, from_cancel)) {
3083 wait_for_completion(&barr.done);
3084 destroy_work_on_stack(&barr.work);
3085 return true;
3086 } else {
3087 return false;
3088 }
3089}
3090
Oleg Nesterovdb700892008-07-25 01:47:49 -07003091/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003092 * flush_work - wait for a work to finish executing the last queueing instance
3093 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003094 *
Tejun Heo606a5022012-08-20 14:51:23 -07003095 * Wait until @work has finished execution. @work is guaranteed to be idle
3096 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003097 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003098 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003099 * %true if flush_work() waited for the work to finish execution,
3100 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003101 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003102bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003103{
Johannes Bergd6e89782018-08-22 11:49:03 +02003104 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003105}
3106EXPORT_SYMBOL_GPL(flush_work);
3107
Tejun Heo8603e1b32015-03-05 08:04:13 -05003108struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003109 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003110 struct work_struct *work;
3111};
3112
Ingo Molnarac6424b2017-06-20 12:06:13 +02003113static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003114{
3115 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3116
3117 if (cwait->work != key)
3118 return 0;
3119 return autoremove_wake_function(wait, mode, sync, key);
3120}
3121
Tejun Heo36e227d2012-08-03 10:30:46 -07003122static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003123{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003124 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003125 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003126 int ret;
3127
3128 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003129 ret = try_to_grab_pending(work, is_dwork, &flags);
3130 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003131 * If someone else is already canceling, wait for it to
3132 * finish. flush_work() doesn't work for PREEMPT_NONE
3133 * because we may get scheduled between @work's completion
3134 * and the other canceling task resuming and clearing
3135 * CANCELING - flush_work() will return false immediately
3136 * as @work is no longer busy, try_to_grab_pending() will
3137 * return -ENOENT as @work is still being canceled and the
3138 * other canceling task won't be able to clear CANCELING as
3139 * we're hogging the CPU.
3140 *
3141 * Let's wait for completion using a waitqueue. As this
3142 * may lead to the thundering herd problem, use a custom
3143 * wake function which matches @work along with exclusive
3144 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003145 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003146 if (unlikely(ret == -ENOENT)) {
3147 struct cwt_wait cwait;
3148
3149 init_wait(&cwait.wait);
3150 cwait.wait.func = cwt_wakefn;
3151 cwait.work = work;
3152
3153 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3154 TASK_UNINTERRUPTIBLE);
3155 if (work_is_canceling(work))
3156 schedule();
3157 finish_wait(&cancel_waitq, &cwait.wait);
3158 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003159 } while (unlikely(ret < 0));
3160
Tejun Heobbb68df2012-08-03 10:30:46 -07003161 /* tell other tasks trying to grab @work to back off */
3162 mark_work_canceling(work);
3163 local_irq_restore(flags);
3164
Tejun Heo3347fa02016-09-16 15:49:32 -04003165 /*
3166 * This allows canceling during early boot. We know that @work
3167 * isn't executing.
3168 */
3169 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003170 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003171
Tejun Heo7a22ad72010-06-29 10:07:13 +02003172 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003173
3174 /*
3175 * Paired with prepare_to_wait() above so that either
3176 * waitqueue_active() is visible here or !work_is_canceling() is
3177 * visible there.
3178 */
3179 smp_mb();
3180 if (waitqueue_active(&cancel_waitq))
3181 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3182
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003183 return ret;
3184}
3185
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003186/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003187 * cancel_work_sync - cancel a work and wait for it to finish
3188 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003189 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003190 * Cancel @work and wait for its execution to finish. This function
3191 * can be used even if the work re-queues itself or migrates to
3192 * another workqueue. On return from this function, @work is
3193 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003194 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003195 * cancel_work_sync(&delayed_work->work) must not be used for
3196 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003197 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003198 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003199 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003200 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003201 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003202 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003203 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003204bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003205{
Tejun Heo36e227d2012-08-03 10:30:46 -07003206 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003207}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003208EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003209
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003210/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003211 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3212 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003213 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003214 * Delayed timer is cancelled and the pending work is queued for
3215 * immediate execution. Like flush_work(), this function only
3216 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003217 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003218 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003219 * %true if flush_work() waited for the work to finish execution,
3220 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003221 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003222bool flush_delayed_work(struct delayed_work *dwork)
3223{
Tejun Heo8930cab2012-08-03 10:30:45 -07003224 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003225 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003226 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003227 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003228 return flush_work(&dwork->work);
3229}
3230EXPORT_SYMBOL(flush_delayed_work);
3231
Tejun Heo05f0fe62018-03-14 12:45:13 -07003232/**
3233 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3234 * @rwork: the rcu work to flush
3235 *
3236 * Return:
3237 * %true if flush_rcu_work() waited for the work to finish execution,
3238 * %false if it was already idle.
3239 */
3240bool flush_rcu_work(struct rcu_work *rwork)
3241{
3242 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3243 rcu_barrier();
3244 flush_work(&rwork->work);
3245 return true;
3246 } else {
3247 return flush_work(&rwork->work);
3248 }
3249}
3250EXPORT_SYMBOL(flush_rcu_work);
3251
Jens Axboef72b8792016-08-24 15:51:50 -06003252static bool __cancel_work(struct work_struct *work, bool is_dwork)
3253{
3254 unsigned long flags;
3255 int ret;
3256
3257 do {
3258 ret = try_to_grab_pending(work, is_dwork, &flags);
3259 } while (unlikely(ret == -EAGAIN));
3260
3261 if (unlikely(ret < 0))
3262 return false;
3263
3264 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3265 local_irq_restore(flags);
3266 return ret;
3267}
3268
Tejun Heo401a8d02010-09-16 10:36:00 +02003269/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003270 * cancel_delayed_work - cancel a delayed work
3271 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003272 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003273 * Kill off a pending delayed_work.
3274 *
3275 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3276 * pending.
3277 *
3278 * Note:
3279 * The work callback function may still be running on return, unless
3280 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3281 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003282 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003283 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003284 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003285bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003286{
Jens Axboef72b8792016-08-24 15:51:50 -06003287 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003288}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003289EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003290
3291/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003292 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3293 * @dwork: the delayed work cancel
3294 *
3295 * This is cancel_work_sync() for delayed works.
3296 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003297 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003298 * %true if @dwork was pending, %false otherwise.
3299 */
3300bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003301{
Tejun Heo36e227d2012-08-03 10:30:46 -07003302 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003303}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003304EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003306/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003307 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003308 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003309 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003310 * schedule_on_each_cpu() executes @func on each online CPU using the
3311 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003312 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003313 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003314 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003315 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003316 */
David Howells65f27f32006-11-22 14:55:48 +00003317int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003318{
3319 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003320 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003321
Andrew Mortonb6136772006-06-25 05:47:49 -07003322 works = alloc_percpu(struct work_struct);
3323 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003324 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003325
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02003326 cpus_read_lock();
Tejun Heo93981802009-11-17 14:06:20 -08003327
Christoph Lameter15316ba2006-01-08 01:00:43 -08003328 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003329 struct work_struct *work = per_cpu_ptr(works, cpu);
3330
3331 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003332 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003333 }
Tejun Heo93981802009-11-17 14:06:20 -08003334
3335 for_each_online_cpu(cpu)
3336 flush_work(per_cpu_ptr(works, cpu));
3337
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02003338 cpus_read_unlock();
Andrew Mortonb6136772006-06-25 05:47:49 -07003339 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003340 return 0;
3341}
3342
Alan Sterneef6a7d2010-02-12 17:39:21 +09003343/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003344 * execute_in_process_context - reliably execute the routine with user context
3345 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003346 * @ew: guaranteed storage for the execute work structure (must
3347 * be available when the work executes)
3348 *
3349 * Executes the function immediately if process context is available,
3350 * otherwise schedules the function for delayed execution.
3351 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003352 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003353 * 1 - function was scheduled for execution
3354 */
David Howells65f27f32006-11-22 14:55:48 +00003355int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003356{
3357 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003358 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003359 return 0;
3360 }
3361
David Howells65f27f32006-11-22 14:55:48 +00003362 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003363 schedule_work(&ew->work);
3364
3365 return 1;
3366}
3367EXPORT_SYMBOL_GPL(execute_in_process_context);
3368
Tejun Heo7a4e3442013-03-12 11:30:00 -07003369/**
3370 * free_workqueue_attrs - free a workqueue_attrs
3371 * @attrs: workqueue_attrs to free
3372 *
3373 * Undo alloc_workqueue_attrs().
3374 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003375void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003376{
3377 if (attrs) {
3378 free_cpumask_var(attrs->cpumask);
3379 kfree(attrs);
3380 }
3381}
3382
3383/**
3384 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003385 *
3386 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003387 * return it.
3388 *
3389 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003390 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003391struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003392{
3393 struct workqueue_attrs *attrs;
3394
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003395 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003396 if (!attrs)
3397 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003398 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003399 goto fail;
3400
Tejun Heo13e2e552013-04-01 11:23:31 -07003401 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003402 return attrs;
3403fail:
3404 free_workqueue_attrs(attrs);
3405 return NULL;
3406}
3407
Tejun Heo29c91e92013-03-12 11:30:03 -07003408static void copy_workqueue_attrs(struct workqueue_attrs *to,
3409 const struct workqueue_attrs *from)
3410{
3411 to->nice = from->nice;
3412 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003413 /*
3414 * Unlike hash and equality test, this function doesn't ignore
3415 * ->no_numa as it is used for both pool and wq attrs. Instead,
3416 * get_unbound_pool() explicitly clears ->no_numa after copying.
3417 */
3418 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003419}
3420
Tejun Heo29c91e92013-03-12 11:30:03 -07003421/* hash value of the content of @attr */
3422static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3423{
3424 u32 hash = 0;
3425
3426 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003427 hash = jhash(cpumask_bits(attrs->cpumask),
3428 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003429 return hash;
3430}
3431
3432/* content equality test */
3433static bool wqattrs_equal(const struct workqueue_attrs *a,
3434 const struct workqueue_attrs *b)
3435{
3436 if (a->nice != b->nice)
3437 return false;
3438 if (!cpumask_equal(a->cpumask, b->cpumask))
3439 return false;
3440 return true;
3441}
3442
Tejun Heo7a4e3442013-03-12 11:30:00 -07003443/**
3444 * init_worker_pool - initialize a newly zalloc'd worker_pool
3445 * @pool: worker_pool to initialize
3446 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303447 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003448 *
3449 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003450 * inside @pool proper are initialized and put_unbound_pool() can be called
3451 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003452 */
3453static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003454{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003455 raw_spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003456 pool->id = -1;
3457 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003458 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003459 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003460 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003461 INIT_LIST_HEAD(&pool->worklist);
3462 INIT_LIST_HEAD(&pool->idle_list);
3463 hash_init(pool->busy_hash);
3464
Kees Cook32a6c722017-10-16 15:58:25 -07003465 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003466
Kees Cook32a6c722017-10-16 15:58:25 -07003467 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003468
Lai Jiangshanda028462014-05-20 17:46:31 +08003469 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003470
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003471 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003472 INIT_HLIST_NODE(&pool->hash_node);
3473 pool->refcnt = 1;
3474
3475 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003476 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003477 if (!pool->attrs)
3478 return -ENOMEM;
3479 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003480}
3481
Bart Van Assche669de8b2019-02-14 15:00:54 -08003482#ifdef CONFIG_LOCKDEP
3483static void wq_init_lockdep(struct workqueue_struct *wq)
3484{
3485 char *lock_name;
3486
3487 lockdep_register_key(&wq->key);
3488 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3489 if (!lock_name)
3490 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003491
3492 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003493 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3494}
3495
3496static void wq_unregister_lockdep(struct workqueue_struct *wq)
3497{
3498 lockdep_unregister_key(&wq->key);
3499}
3500
3501static void wq_free_lockdep(struct workqueue_struct *wq)
3502{
3503 if (wq->lock_name != wq->name)
3504 kfree(wq->lock_name);
3505}
3506#else
3507static void wq_init_lockdep(struct workqueue_struct *wq)
3508{
3509}
3510
3511static void wq_unregister_lockdep(struct workqueue_struct *wq)
3512{
3513}
3514
3515static void wq_free_lockdep(struct workqueue_struct *wq)
3516{
3517}
3518#endif
3519
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003520static void rcu_free_wq(struct rcu_head *rcu)
3521{
3522 struct workqueue_struct *wq =
3523 container_of(rcu, struct workqueue_struct, rcu);
3524
Bart Van Assche669de8b2019-02-14 15:00:54 -08003525 wq_free_lockdep(wq);
3526
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003527 if (!(wq->flags & WQ_UNBOUND))
3528 free_percpu(wq->cpu_pwqs);
3529 else
3530 free_workqueue_attrs(wq->unbound_attrs);
3531
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003532 kfree(wq);
3533}
3534
Tejun Heo29c91e92013-03-12 11:30:03 -07003535static void rcu_free_pool(struct rcu_head *rcu)
3536{
3537 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3538
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003539 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003540 free_workqueue_attrs(pool->attrs);
3541 kfree(pool);
3542}
3543
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003544/* This returns with the lock held on success (pool manager is inactive). */
3545static bool wq_manager_inactive(struct worker_pool *pool)
3546{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003547 raw_spin_lock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003548
3549 if (pool->flags & POOL_MANAGER_ACTIVE) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003550 raw_spin_unlock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003551 return false;
3552 }
3553 return true;
3554}
3555
Tejun Heo29c91e92013-03-12 11:30:03 -07003556/**
3557 * put_unbound_pool - put a worker_pool
3558 * @pool: worker_pool to put
3559 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003560 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003561 * safe manner. get_unbound_pool() calls this function on its failure path
3562 * and this function should be able to release pools which went through,
3563 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003564 *
3565 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003566 */
3567static void put_unbound_pool(struct worker_pool *pool)
3568{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003569 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003570 struct worker *worker;
3571
Tejun Heoa892cac2013-04-01 11:23:32 -07003572 lockdep_assert_held(&wq_pool_mutex);
3573
3574 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003575 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003576
3577 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003578 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003579 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003580 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003581
3582 /* release id and unhash */
3583 if (pool->id >= 0)
3584 idr_remove(&worker_pool_idr, pool->id);
3585 hash_del(&pool->hash_node);
3586
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003587 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003588 * Become the manager and destroy all workers. This prevents
3589 * @pool's workers from blocking on attach_mutex. We're the last
3590 * manager and @pool gets freed with the flag set.
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003591 * Because of how wq_manager_inactive() works, we will hold the
3592 * spinlock after a successful wait.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003593 */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003594 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3595 TASK_UNINTERRUPTIBLE);
Tejun Heo692b4822017-10-09 08:04:13 -07003596 pool->flags |= POOL_MANAGER_ACTIVE;
3597
Lai Jiangshan1037de32014-05-22 16:44:07 +08003598 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003599 destroy_worker(worker);
3600 WARN_ON(pool->nr_workers || pool->nr_idle);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003601 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003602
Tejun Heo1258fae2018-05-18 08:47:13 -07003603 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003604 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003605 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003606 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003607
3608 if (pool->detach_completion)
3609 wait_for_completion(pool->detach_completion);
3610
Tejun Heo29c91e92013-03-12 11:30:03 -07003611 /* shut down the timers */
3612 del_timer_sync(&pool->idle_timer);
3613 del_timer_sync(&pool->mayday_timer);
3614
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003615 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003616 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003617}
3618
3619/**
3620 * get_unbound_pool - get a worker_pool with the specified attributes
3621 * @attrs: the attributes of the worker_pool to get
3622 *
3623 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3624 * reference count and return it. If there already is a matching
3625 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003626 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003627 *
3628 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003629 *
3630 * Return: On success, a worker_pool with the same attributes as @attrs.
3631 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003632 */
3633static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3634{
Tejun Heo29c91e92013-03-12 11:30:03 -07003635 u32 hash = wqattrs_hash(attrs);
3636 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003637 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003638 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003639
Tejun Heoa892cac2013-04-01 11:23:32 -07003640 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003641
3642 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003643 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3644 if (wqattrs_equal(pool->attrs, attrs)) {
3645 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003646 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003647 }
3648 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003649
Xunlei Pange22735842015-10-09 11:53:12 +08003650 /* if cpumask is contained inside a NUMA node, we belong to that node */
3651 if (wq_numa_enabled) {
3652 for_each_node(node) {
3653 if (cpumask_subset(attrs->cpumask,
3654 wq_numa_possible_cpumask[node])) {
3655 target_node = node;
3656 break;
3657 }
3658 }
3659 }
3660
Tejun Heo29c91e92013-03-12 11:30:03 -07003661 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003662 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003663 if (!pool || init_worker_pool(pool) < 0)
3664 goto fail;
3665
Tejun Heo8864b4e2013-03-12 11:30:04 -07003666 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003667 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003668 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003669
Shaohua Li2865a8f2013-08-01 09:56:36 +08003670 /*
3671 * no_numa isn't a worker_pool attribute, always clear it. See
3672 * 'struct workqueue_attrs' comments for detail.
3673 */
3674 pool->attrs->no_numa = false;
3675
Tejun Heo29c91e92013-03-12 11:30:03 -07003676 if (worker_pool_assign_id(pool) < 0)
3677 goto fail;
3678
3679 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003680 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003681 goto fail;
3682
Tejun Heo29c91e92013-03-12 11:30:03 -07003683 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003684 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003685
Tejun Heo29c91e92013-03-12 11:30:03 -07003686 return pool;
3687fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003688 if (pool)
3689 put_unbound_pool(pool);
3690 return NULL;
3691}
3692
Tejun Heo8864b4e2013-03-12 11:30:04 -07003693static void rcu_free_pwq(struct rcu_head *rcu)
3694{
3695 kmem_cache_free(pwq_cache,
3696 container_of(rcu, struct pool_workqueue, rcu));
3697}
3698
3699/*
3700 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3701 * and needs to be destroyed.
3702 */
3703static void pwq_unbound_release_workfn(struct work_struct *work)
3704{
3705 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3706 unbound_release_work);
3707 struct workqueue_struct *wq = pwq->wq;
3708 struct worker_pool *pool = pwq->pool;
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003709 bool is_last = false;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003710
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003711 /*
3712 * when @pwq is not linked, it doesn't hold any reference to the
3713 * @wq, and @wq is invalid to access.
3714 */
3715 if (!list_empty(&pwq->pwqs_node)) {
3716 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3717 return;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003718
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003719 mutex_lock(&wq->mutex);
3720 list_del_rcu(&pwq->pwqs_node);
3721 is_last = list_empty(&wq->pwqs);
3722 mutex_unlock(&wq->mutex);
3723 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003724
Tejun Heoa892cac2013-04-01 11:23:32 -07003725 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003726 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003727 mutex_unlock(&wq_pool_mutex);
3728
Paul E. McKenney25b00772018-11-06 19:18:45 -08003729 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003730
3731 /*
3732 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003733 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003734 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003735 if (is_last) {
3736 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003737 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003738 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003739}
3740
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003741/**
Tejun Heo699ce092013-03-13 16:51:35 -07003742 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003743 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003744 *
Tejun Heo699ce092013-03-13 16:51:35 -07003745 * If @pwq isn't freezing, set @pwq->max_active to the associated
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003746 * workqueue's saved_max_active and activate inactive work items
Tejun Heo699ce092013-03-13 16:51:35 -07003747 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003748 */
Tejun Heo699ce092013-03-13 16:51:35 -07003749static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003750{
Tejun Heo699ce092013-03-13 16:51:35 -07003751 struct workqueue_struct *wq = pwq->wq;
3752 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003753 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003754
Tejun Heo699ce092013-03-13 16:51:35 -07003755 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003756 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003757
3758 /* fast exit for non-freezable wqs */
3759 if (!freezable && pwq->max_active == wq->saved_max_active)
3760 return;
3761
Tejun Heo3347fa02016-09-16 15:49:32 -04003762 /* this function can be called during early boot w/ irq disabled */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003763 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003764
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003765 /*
3766 * During [un]freezing, the caller is responsible for ensuring that
3767 * this function is called at least once after @workqueue_freezing
3768 * is updated and visible.
3769 */
3770 if (!freezable || !workqueue_freezing) {
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003771 bool kick = false;
3772
Tejun Heo699ce092013-03-13 16:51:35 -07003773 pwq->max_active = wq->saved_max_active;
3774
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003775 while (!list_empty(&pwq->inactive_works) &&
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003776 pwq->nr_active < pwq->max_active) {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003777 pwq_activate_first_inactive(pwq);
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003778 kick = true;
3779 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003780
3781 /*
3782 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003783 * max_active is bumped. In realtime scenarios, always kicking a
3784 * worker will cause interference on the isolated cpu cores, so
3785 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003786 */
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003787 if (kick)
3788 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003789 } else {
3790 pwq->max_active = 0;
3791 }
3792
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003793 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003794}
3795
Cai Huoqing67dc8322021-07-31 08:01:29 +08003796/* initialize newly allocated @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003797static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3798 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003799{
3800 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3801
Tejun Heoe50aba92013-04-01 11:23:35 -07003802 memset(pwq, 0, sizeof(*pwq));
3803
Tejun Heod2c1d402013-03-12 11:30:04 -07003804 pwq->pool = pool;
3805 pwq->wq = wq;
3806 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003807 pwq->refcnt = 1;
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08003808 INIT_LIST_HEAD(&pwq->inactive_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003809 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003810 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003811 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003812}
Tejun Heod2c1d402013-03-12 11:30:04 -07003813
Tejun Heof147f292013-04-01 11:23:35 -07003814/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003815static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003816{
3817 struct workqueue_struct *wq = pwq->wq;
3818
3819 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003820
Tejun Heo1befcf32013-04-01 11:23:35 -07003821 /* may be called multiple times, ignore if already linked */
3822 if (!list_empty(&pwq->pwqs_node))
3823 return;
3824
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003825 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003826 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003827
3828 /* sync max_active to the current setting */
3829 pwq_adjust_max_active(pwq);
3830
3831 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003832 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003833}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003834
Tejun Heof147f292013-04-01 11:23:35 -07003835/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3836static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3837 const struct workqueue_attrs *attrs)
3838{
3839 struct worker_pool *pool;
3840 struct pool_workqueue *pwq;
3841
3842 lockdep_assert_held(&wq_pool_mutex);
3843
3844 pool = get_unbound_pool(attrs);
3845 if (!pool)
3846 return NULL;
3847
Tejun Heoe50aba92013-04-01 11:23:35 -07003848 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003849 if (!pwq) {
3850 put_unbound_pool(pool);
3851 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003852 }
Tejun Heo6029a912013-04-01 11:23:34 -07003853
Tejun Heof147f292013-04-01 11:23:35 -07003854 init_pwq(pwq, wq, pool);
3855 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003856}
3857
Tejun Heo4c16bd32013-04-01 11:23:36 -07003858/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003859 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003860 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003861 * @node: the target NUMA node
3862 * @cpu_going_down: if >= 0, the CPU to consider as offline
3863 * @cpumask: outarg, the resulting cpumask
3864 *
3865 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3866 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003867 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003868 *
3869 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3870 * enabled and @node has online CPUs requested by @attrs, the returned
3871 * cpumask is the intersection of the possible CPUs of @node and
3872 * @attrs->cpumask.
3873 *
3874 * The caller is responsible for ensuring that the cpumask of @node stays
3875 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003876 *
3877 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3878 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003879 */
3880static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3881 int cpu_going_down, cpumask_t *cpumask)
3882{
Tejun Heod55262c2013-04-01 11:23:38 -07003883 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003884 goto use_dfl;
3885
3886 /* does @node have any online CPUs @attrs wants? */
3887 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3888 if (cpu_going_down >= 0)
3889 cpumask_clear_cpu(cpu_going_down, cpumask);
3890
3891 if (cpumask_empty(cpumask))
3892 goto use_dfl;
3893
3894 /* yeap, return possible CPUs in @node that @attrs wants */
3895 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003896
3897 if (cpumask_empty(cpumask)) {
3898 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3899 "possible intersect\n");
3900 return false;
3901 }
3902
Tejun Heo4c16bd32013-04-01 11:23:36 -07003903 return !cpumask_equal(cpumask, attrs->cpumask);
3904
3905use_dfl:
3906 cpumask_copy(cpumask, attrs->cpumask);
3907 return false;
3908}
3909
Tejun Heo1befcf32013-04-01 11:23:35 -07003910/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3911static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3912 int node,
3913 struct pool_workqueue *pwq)
3914{
3915 struct pool_workqueue *old_pwq;
3916
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003917 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003918 lockdep_assert_held(&wq->mutex);
3919
3920 /* link_pwq() can handle duplicate calls */
3921 link_pwq(pwq);
3922
3923 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3924 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3925 return old_pwq;
3926}
3927
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003928/* context to store the prepared attrs & pwqs before applying */
3929struct apply_wqattrs_ctx {
3930 struct workqueue_struct *wq; /* target workqueue */
3931 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003932 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003933 struct pool_workqueue *dfl_pwq;
3934 struct pool_workqueue *pwq_tbl[];
3935};
3936
3937/* free the resources after success or abort */
3938static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3939{
3940 if (ctx) {
3941 int node;
3942
3943 for_each_node(node)
3944 put_pwq_unlocked(ctx->pwq_tbl[node]);
3945 put_pwq_unlocked(ctx->dfl_pwq);
3946
3947 free_workqueue_attrs(ctx->attrs);
3948
3949 kfree(ctx);
3950 }
3951}
3952
3953/* allocate the attrs and pwqs for later installation */
3954static struct apply_wqattrs_ctx *
3955apply_wqattrs_prepare(struct workqueue_struct *wq,
3956 const struct workqueue_attrs *attrs)
3957{
3958 struct apply_wqattrs_ctx *ctx;
3959 struct workqueue_attrs *new_attrs, *tmp_attrs;
3960 int node;
3961
3962 lockdep_assert_held(&wq_pool_mutex);
3963
Kees Cookacafe7e2018-05-08 13:45:50 -07003964 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003965
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003966 new_attrs = alloc_workqueue_attrs();
3967 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003968 if (!ctx || !new_attrs || !tmp_attrs)
3969 goto out_free;
3970
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003971 /*
3972 * Calculate the attrs of the default pwq.
3973 * If the user configured cpumask doesn't overlap with the
3974 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3975 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003976 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003977 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003978 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3979 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003980
3981 /*
3982 * We may create multiple pwqs with differing cpumasks. Make a
3983 * copy of @new_attrs which will be modified and used to obtain
3984 * pools.
3985 */
3986 copy_workqueue_attrs(tmp_attrs, new_attrs);
3987
3988 /*
3989 * If something goes wrong during CPU up/down, we'll fall back to
3990 * the default pwq covering whole @attrs->cpumask. Always create
3991 * it even if we don't use it immediately.
3992 */
3993 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3994 if (!ctx->dfl_pwq)
3995 goto out_free;
3996
3997 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003998 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003999 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
4000 if (!ctx->pwq_tbl[node])
4001 goto out_free;
4002 } else {
4003 ctx->dfl_pwq->refcnt++;
4004 ctx->pwq_tbl[node] = ctx->dfl_pwq;
4005 }
4006 }
4007
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004008 /* save the user configured attrs and sanitize it. */
4009 copy_workqueue_attrs(new_attrs, attrs);
4010 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004011 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004012
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004013 ctx->wq = wq;
4014 free_workqueue_attrs(tmp_attrs);
4015 return ctx;
4016
4017out_free:
4018 free_workqueue_attrs(tmp_attrs);
4019 free_workqueue_attrs(new_attrs);
4020 apply_wqattrs_cleanup(ctx);
4021 return NULL;
4022}
4023
4024/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
4025static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
4026{
4027 int node;
4028
4029 /* all pwqs have been created successfully, let's install'em */
4030 mutex_lock(&ctx->wq->mutex);
4031
4032 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
4033
4034 /* save the previous pwq and install the new one */
4035 for_each_node(node)
4036 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4037 ctx->pwq_tbl[node]);
4038
4039 /* @dfl_pwq might not have been used, ensure it's linked */
4040 link_pwq(ctx->dfl_pwq);
4041 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
4042
4043 mutex_unlock(&ctx->wq->mutex);
4044}
4045
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004046static void apply_wqattrs_lock(void)
4047{
4048 /* CPUs should stay stable across pwq creations and installations */
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004049 cpus_read_lock();
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004050 mutex_lock(&wq_pool_mutex);
4051}
4052
4053static void apply_wqattrs_unlock(void)
4054{
4055 mutex_unlock(&wq_pool_mutex);
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004056 cpus_read_unlock();
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004057}
4058
4059static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4060 const struct workqueue_attrs *attrs)
4061{
4062 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004063
4064 /* only unbound workqueues can change attributes */
4065 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4066 return -EINVAL;
4067
4068 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004069 if (!list_empty(&wq->pwqs)) {
4070 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4071 return -EINVAL;
4072
4073 wq->flags &= ~__WQ_ORDERED;
4074 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004075
4076 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004077 if (!ctx)
4078 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004079
4080 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004081 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004082 apply_wqattrs_cleanup(ctx);
4083
wanghaibin62011712016-01-07 20:38:59 +08004084 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004085}
4086
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004087/**
4088 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4089 * @wq: the target workqueue
4090 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4091 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004092 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4093 * machines, this function maps a separate pwq to each NUMA node with
4094 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4095 * NUMA node it was issued on. Older pwqs are released as in-flight work
4096 * items finish. Note that a work item which repeatedly requeues itself
4097 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004098 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004099 * Performs GFP_KERNEL allocations.
4100 *
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004101 * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
Daniel Jordan509b3202019-09-05 21:40:23 -04004102 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004103 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004104 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004105int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004106 const struct workqueue_attrs *attrs)
4107{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004108 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004109
Daniel Jordan509b3202019-09-05 21:40:23 -04004110 lockdep_assert_cpus_held();
4111
4112 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004113 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004114 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004115
Tejun Heo48621252013-04-01 11:23:31 -07004116 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004117}
4118
Tejun Heo4c16bd32013-04-01 11:23:36 -07004119/**
4120 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4121 * @wq: the target workqueue
4122 * @cpu: the CPU coming up or going down
4123 * @online: whether @cpu is coming up or going down
4124 *
4125 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4126 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4127 * @wq accordingly.
4128 *
4129 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4130 * falls back to @wq->dfl_pwq which may not be optimal but is always
4131 * correct.
4132 *
4133 * Note that when the last allowed CPU of a NUMA node goes offline for a
4134 * workqueue with a cpumask spanning multiple nodes, the workers which were
4135 * already executing the work items for the workqueue will lose their CPU
4136 * affinity and may execute on any CPU. This is similar to how per-cpu
4137 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4138 * affinity, it's the user's responsibility to flush the work item from
4139 * CPU_DOWN_PREPARE.
4140 */
4141static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4142 bool online)
4143{
4144 int node = cpu_to_node(cpu);
4145 int cpu_off = online ? -1 : cpu;
4146 struct pool_workqueue *old_pwq = NULL, *pwq;
4147 struct workqueue_attrs *target_attrs;
4148 cpumask_t *cpumask;
4149
4150 lockdep_assert_held(&wq_pool_mutex);
4151
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004152 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4153 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004154 return;
4155
4156 /*
4157 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4158 * Let's use a preallocated one. The following buf is protected by
4159 * CPU hotplug exclusion.
4160 */
4161 target_attrs = wq_update_unbound_numa_attrs_buf;
4162 cpumask = target_attrs->cpumask;
4163
Tejun Heo4c16bd32013-04-01 11:23:36 -07004164 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4165 pwq = unbound_pwq_by_node(wq, node);
4166
4167 /*
4168 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004169 * different from the default pwq's, we need to compare it to @pwq's
4170 * and create a new one if they don't match. If the target cpumask
4171 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004172 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004173 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004174 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004175 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004176 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004177 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004178 }
4179
Tejun Heo4c16bd32013-04-01 11:23:36 -07004180 /* create a new pwq */
4181 pwq = alloc_unbound_pwq(wq, target_attrs);
4182 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004183 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4184 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004185 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004186 }
4187
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004188 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004189 mutex_lock(&wq->mutex);
4190 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4191 goto out_unlock;
4192
4193use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004194 mutex_lock(&wq->mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004195 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004196 get_pwq(wq->dfl_pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004197 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004198 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4199out_unlock:
4200 mutex_unlock(&wq->mutex);
4201 put_pwq_unlocked(old_pwq);
4202}
4203
Tejun Heo30cdf2492013-03-12 11:29:57 -07004204static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004205{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004206 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004207 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004208
Tejun Heo30cdf2492013-03-12 11:29:57 -07004209 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004210 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4211 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004212 return -ENOMEM;
4213
4214 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004215 struct pool_workqueue *pwq =
4216 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004217 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004218 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004219
Tejun Heof147f292013-04-01 11:23:35 -07004220 init_pwq(pwq, wq, &cpu_pools[highpri]);
4221
4222 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004223 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004224 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004225 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004226 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004227 }
4228
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004229 cpus_read_lock();
Daniel Jordan509b3202019-09-05 21:40:23 -04004230 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004231 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4232 /* there should only be single pwq for ordering guarantee */
4233 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4234 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4235 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004236 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004237 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004238 }
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02004239 cpus_read_unlock();
Daniel Jordan509b3202019-09-05 21:40:23 -04004240
4241 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004242}
4243
Tejun Heof3421792010-07-02 10:03:51 +02004244static int wq_clamp_max_active(int max_active, unsigned int flags,
4245 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004246{
Tejun Heof3421792010-07-02 10:03:51 +02004247 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4248
4249 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004250 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4251 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004252
Tejun Heof3421792010-07-02 10:03:51 +02004253 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004254}
4255
Tejun Heo983c7512018-01-08 05:38:32 -08004256/*
4257 * Workqueues which may be used during memory reclaim should have a rescuer
4258 * to guarantee forward progress.
4259 */
4260static int init_rescuer(struct workqueue_struct *wq)
4261{
4262 struct worker *rescuer;
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004263 int ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004264
4265 if (!(wq->flags & WQ_MEM_RECLAIM))
4266 return 0;
4267
4268 rescuer = alloc_worker(NUMA_NO_NODE);
4269 if (!rescuer)
4270 return -ENOMEM;
4271
4272 rescuer->rescue_wq = wq;
4273 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
Sean Fuf187b692020-04-29 12:04:13 +08004274 if (IS_ERR(rescuer->task)) {
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004275 ret = PTR_ERR(rescuer->task);
Tejun Heo983c7512018-01-08 05:38:32 -08004276 kfree(rescuer);
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004277 return ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004278 }
4279
4280 wq->rescuer = rescuer;
4281 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4282 wake_up_process(rescuer->task);
4283
4284 return 0;
4285}
4286
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004287__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004288struct workqueue_struct *alloc_workqueue(const char *fmt,
4289 unsigned int flags,
4290 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004291{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004292 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004293 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004294 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004295 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004296
Tejun Heo5c0338c2017-07-18 18:41:52 -04004297 /*
4298 * Unbound && max_active == 1 used to imply ordered, which is no
4299 * longer the case on NUMA machines due to per-node pools. While
4300 * alloc_ordered_workqueue() is the right way to create an ordered
4301 * workqueue, keep the previous behavior to avoid subtle breakages
4302 * on NUMA.
4303 */
4304 if ((flags & WQ_UNBOUND) && max_active == 1)
4305 flags |= __WQ_ORDERED;
4306
Viresh Kumarcee22a12013-04-08 16:45:40 +05304307 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4308 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4309 flags |= WQ_UNBOUND;
4310
Tejun Heoecf68812013-04-01 11:23:34 -07004311 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004312 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004313 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004314
4315 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004316 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004317 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004318
Tejun Heo6029a912013-04-01 11:23:34 -07004319 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004320 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004321 if (!wq->unbound_attrs)
4322 goto err_free_wq;
4323 }
4324
Bart Van Assche669de8b2019-02-14 15:00:54 -08004325 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004326 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004327 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004328
Tejun Heod320c032010-06-29 10:07:14 +02004329 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004330 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004331
Tejun Heob196be82012-01-10 15:11:35 -08004332 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004333 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004334 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004335 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004336 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004337 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004338 INIT_LIST_HEAD(&wq->flusher_queue);
4339 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004340 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004341
Bart Van Assche669de8b2019-02-14 15:00:54 -08004342 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004343 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004344
Tejun Heo30cdf2492013-03-12 11:29:57 -07004345 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004346 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004347
Tejun Heo40c17f72018-01-08 05:38:37 -08004348 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004349 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004350
Tejun Heo226223a2013-03-12 11:30:05 -07004351 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4352 goto err_destroy;
4353
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004354 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004355 * wq_pool_mutex protects global freeze state and workqueues list.
4356 * Grab it, adjust max_active and add the new @wq to workqueues
4357 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004358 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004359 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004360
Lai Jiangshana357fc02013-03-25 16:57:19 -07004361 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004362 for_each_pwq(pwq, wq)
4363 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004364 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004365
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004366 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004367
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004368 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004369
Oleg Nesterov3af244332007-05-09 02:34:09 -07004370 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004371
Bart Van Assche82efcab2019-03-11 16:02:55 -07004372err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004373 wq_unregister_lockdep(wq);
4374 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004375err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004376 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004377 kfree(wq);
4378 return NULL;
4379err_destroy:
4380 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004381 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004382}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004383EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004384
Tejun Heoc29eb852019-09-23 11:08:58 -07004385static bool pwq_busy(struct pool_workqueue *pwq)
4386{
4387 int i;
4388
4389 for (i = 0; i < WORK_NR_COLORS; i++)
4390 if (pwq->nr_in_flight[i])
4391 return true;
4392
4393 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4394 return true;
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004395 if (pwq->nr_active || !list_empty(&pwq->inactive_works))
Tejun Heoc29eb852019-09-23 11:08:58 -07004396 return true;
4397
4398 return false;
4399}
4400
Oleg Nesterov3af244332007-05-09 02:34:09 -07004401/**
4402 * destroy_workqueue - safely terminate a workqueue
4403 * @wq: target workqueue
4404 *
4405 * Safely destroy a workqueue. All work currently pending will be done first.
4406 */
4407void destroy_workqueue(struct workqueue_struct *wq)
4408{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004409 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004410 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004411
Tejun Heodef98c82019-09-18 18:43:40 -07004412 /*
4413 * Remove it from sysfs first so that sanity check failure doesn't
4414 * lead to sysfs name conflicts.
4415 */
4416 workqueue_sysfs_unregister(wq);
4417
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004418 /* drain it before proceeding with destruction */
4419 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004420
Tejun Heodef98c82019-09-18 18:43:40 -07004421 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4422 if (wq->rescuer) {
4423 struct worker *rescuer = wq->rescuer;
4424
4425 /* this prevents new queueing */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004426 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004427 wq->rescuer = NULL;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004428 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004429
4430 /* rescuer will empty maydays list before exiting */
4431 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004432 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004433 }
4434
Tejun Heoc29eb852019-09-23 11:08:58 -07004435 /*
4436 * Sanity checks - grab all the locks so that we wait for all
4437 * in-flight operations which may do put_pwq().
4438 */
4439 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004440 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004441 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004442 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heoc29eb852019-09-23 11:08:58 -07004443 if (WARN_ON(pwq_busy(pwq))) {
Kefeng Wang1d9a6152019-11-28 08:47:49 +08004444 pr_warn("%s: %s has the following busy pwq\n",
4445 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004446 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004447 raw_spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004448 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004449 mutex_unlock(&wq_pool_mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004450 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004451 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004452 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004453 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004454 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004455 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004456
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004457 /*
4458 * wq list is used to freeze wq, remove from list after
4459 * flushing is complete in case freeze races us.
4460 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004461 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004462 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004463
Tejun Heo8864b4e2013-03-12 11:30:04 -07004464 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004465 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004466 /*
4467 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004468 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004469 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004470 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004471 } else {
4472 /*
4473 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004474 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4475 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004476 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004477 for_each_node(node) {
4478 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4479 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4480 put_pwq_unlocked(pwq);
4481 }
4482
4483 /*
4484 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4485 * put. Don't access it afterwards.
4486 */
4487 pwq = wq->dfl_pwq;
4488 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004489 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004490 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004491}
4492EXPORT_SYMBOL_GPL(destroy_workqueue);
4493
Tejun Heodcd989c2010-06-29 10:07:14 +02004494/**
4495 * workqueue_set_max_active - adjust max_active of a workqueue
4496 * @wq: target workqueue
4497 * @max_active: new max_active value.
4498 *
4499 * Set max_active of @wq to @max_active.
4500 *
4501 * CONTEXT:
4502 * Don't call from IRQ context.
4503 */
4504void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4505{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004506 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004507
Tejun Heo8719dce2013-03-12 11:30:04 -07004508 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004509 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004510 return;
4511
Tejun Heof3421792010-07-02 10:03:51 +02004512 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004513
Lai Jiangshana357fc02013-03-25 16:57:19 -07004514 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004515
Tejun Heo0a94efb2017-07-23 08:36:15 -04004516 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004517 wq->saved_max_active = max_active;
4518
Tejun Heo699ce092013-03-13 16:51:35 -07004519 for_each_pwq(pwq, wq)
4520 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004521
Lai Jiangshana357fc02013-03-25 16:57:19 -07004522 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004523}
4524EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4525
4526/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004527 * current_work - retrieve %current task's work struct
4528 *
4529 * Determine if %current task is a workqueue worker and what it's working on.
4530 * Useful to find out the context that the %current task is running in.
4531 *
4532 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4533 */
4534struct work_struct *current_work(void)
4535{
4536 struct worker *worker = current_wq_worker();
4537
4538 return worker ? worker->current_work : NULL;
4539}
4540EXPORT_SYMBOL(current_work);
4541
4542/**
Tejun Heoe62676162013-03-12 17:41:37 -07004543 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4544 *
4545 * Determine whether %current is a workqueue rescuer. Can be used from
4546 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004547 *
4548 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004549 */
4550bool current_is_workqueue_rescuer(void)
4551{
4552 struct worker *worker = current_wq_worker();
4553
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004554 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004555}
4556
4557/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004558 * workqueue_congested - test whether a workqueue is congested
4559 * @cpu: CPU in question
4560 * @wq: target workqueue
4561 *
4562 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4563 * no synchronization around this function and the test result is
4564 * unreliable and only useful as advisory hints or for debugging.
4565 *
Tejun Heod3251852013-05-10 11:10:17 -07004566 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4567 * Note that both per-cpu and unbound workqueues may be associated with
4568 * multiple pool_workqueues which have separate congested states. A
4569 * workqueue being congested on one CPU doesn't mean the workqueue is also
4570 * contested on other CPUs / NUMA nodes.
4571 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004572 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004573 * %true if congested, %false otherwise.
4574 */
Tejun Heod84ff052013-03-12 11:29:59 -07004575bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004576{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004577 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004578 bool ret;
4579
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004580 rcu_read_lock();
4581 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004582
Tejun Heod3251852013-05-10 11:10:17 -07004583 if (cpu == WORK_CPU_UNBOUND)
4584 cpu = smp_processor_id();
4585
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004586 if (!(wq->flags & WQ_UNBOUND))
4587 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4588 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004589 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004590
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004591 ret = !list_empty(&pwq->inactive_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004592 preempt_enable();
4593 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004594
4595 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004596}
4597EXPORT_SYMBOL_GPL(workqueue_congested);
4598
4599/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004600 * work_busy - test whether a work is currently pending or running
4601 * @work: the work to be tested
4602 *
4603 * Test whether @work is currently pending or running. There is no
4604 * synchronization around this function and the test result is
4605 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004606 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004607 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004608 * OR'd bitmask of WORK_BUSY_* bits.
4609 */
4610unsigned int work_busy(struct work_struct *work)
4611{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004612 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004613 unsigned long flags;
4614 unsigned int ret = 0;
4615
Tejun Heodcd989c2010-06-29 10:07:14 +02004616 if (work_pending(work))
4617 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004618
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004619 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004620 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004621 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004622 raw_spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004623 if (find_worker_executing_work(pool, work))
4624 ret |= WORK_BUSY_RUNNING;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004625 raw_spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004626 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004627 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004628
4629 return ret;
4630}
4631EXPORT_SYMBOL_GPL(work_busy);
4632
Tejun Heo3d1cb202013-04-30 15:27:22 -07004633/**
4634 * set_worker_desc - set description for the current work item
4635 * @fmt: printf-style format string
4636 * @...: arguments for the format string
4637 *
4638 * This function can be called by a running work function to describe what
4639 * the work item is about. If the worker task gets dumped, this
4640 * information will be printed out together to help debugging. The
4641 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4642 */
4643void set_worker_desc(const char *fmt, ...)
4644{
4645 struct worker *worker = current_wq_worker();
4646 va_list args;
4647
4648 if (worker) {
4649 va_start(args, fmt);
4650 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4651 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004652 }
4653}
Steffen Maier5c750d52018-05-17 19:14:57 +02004654EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004655
4656/**
4657 * print_worker_info - print out worker information and description
4658 * @log_lvl: the log level to use when printing
4659 * @task: target task
4660 *
4661 * If @task is a worker and currently executing a work item, print out the
4662 * name of the workqueue being serviced and worker description set with
4663 * set_worker_desc() by the currently executing work item.
4664 *
4665 * This function can be safely called on any task as long as the
4666 * task_struct itself is accessible. While safe, this function isn't
4667 * synchronized and may print out mixups or garbages of limited length.
4668 */
4669void print_worker_info(const char *log_lvl, struct task_struct *task)
4670{
4671 work_func_t *fn = NULL;
4672 char name[WQ_NAME_LEN] = { };
4673 char desc[WORKER_DESC_LEN] = { };
4674 struct pool_workqueue *pwq = NULL;
4675 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004676 struct worker *worker;
4677
4678 if (!(task->flags & PF_WQ_WORKER))
4679 return;
4680
4681 /*
4682 * This function is called without any synchronization and @task
4683 * could be in any state. Be careful with dereferences.
4684 */
Petr Mladeke7005912016-10-11 13:55:17 -07004685 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004686
4687 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004688 * Carefully copy the associated workqueue's workfn, name and desc.
4689 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004690 */
Christoph Hellwigfe557312020-06-17 09:37:53 +02004691 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4692 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4693 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4694 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4695 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004696
4697 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004698 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004699 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004700 pr_cont(" (%s)", desc);
4701 pr_cont("\n");
4702 }
4703}
4704
Tejun Heo3494fc32015-03-09 09:22:28 -04004705static void pr_cont_pool_info(struct worker_pool *pool)
4706{
4707 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4708 if (pool->node != NUMA_NO_NODE)
4709 pr_cont(" node=%d", pool->node);
4710 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4711}
4712
4713static void pr_cont_work(bool comma, struct work_struct *work)
4714{
4715 if (work->func == wq_barrier_func) {
4716 struct wq_barrier *barr;
4717
4718 barr = container_of(work, struct wq_barrier, work);
4719
4720 pr_cont("%s BAR(%d)", comma ? "," : "",
4721 task_pid_nr(barr->task));
4722 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004723 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004724 }
4725}
4726
4727static void show_pwq(struct pool_workqueue *pwq)
4728{
4729 struct worker_pool *pool = pwq->pool;
4730 struct work_struct *work;
4731 struct worker *worker;
4732 bool has_in_flight = false, has_pending = false;
4733 int bkt;
4734
4735 pr_info(" pwq %d:", pool->id);
4736 pr_cont_pool_info(pool);
4737
Tejun Heoe66b39a2019-09-25 06:59:15 -07004738 pr_cont(" active=%d/%d refcnt=%d%s\n",
4739 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004740 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4741
4742 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4743 if (worker->current_pwq == pwq) {
4744 has_in_flight = true;
4745 break;
4746 }
4747 }
4748 if (has_in_flight) {
4749 bool comma = false;
4750
4751 pr_info(" in-flight:");
4752 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4753 if (worker->current_pwq != pwq)
4754 continue;
4755
Sakari Ailusd75f7732019-03-25 21:32:28 +02004756 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004757 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004758 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004759 worker->current_func);
4760 list_for_each_entry(work, &worker->scheduled, entry)
4761 pr_cont_work(false, work);
4762 comma = true;
4763 }
4764 pr_cont("\n");
4765 }
4766
4767 list_for_each_entry(work, &pool->worklist, entry) {
4768 if (get_work_pwq(work) == pwq) {
4769 has_pending = true;
4770 break;
4771 }
4772 }
4773 if (has_pending) {
4774 bool comma = false;
4775
4776 pr_info(" pending:");
4777 list_for_each_entry(work, &pool->worklist, entry) {
4778 if (get_work_pwq(work) != pwq)
4779 continue;
4780
4781 pr_cont_work(comma, work);
4782 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4783 }
4784 pr_cont("\n");
4785 }
4786
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004787 if (!list_empty(&pwq->inactive_works)) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004788 bool comma = false;
4789
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004790 pr_info(" inactive:");
4791 list_for_each_entry(work, &pwq->inactive_works, entry) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004792 pr_cont_work(comma, work);
4793 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4794 }
4795 pr_cont("\n");
4796 }
4797}
4798
4799/**
4800 * show_workqueue_state - dump workqueue state
4801 *
Roger Lu7b776af2016-07-01 11:05:02 +08004802 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4803 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004804 */
4805void show_workqueue_state(void)
4806{
4807 struct workqueue_struct *wq;
4808 struct worker_pool *pool;
4809 unsigned long flags;
4810 int pi;
4811
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004812 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004813
4814 pr_info("Showing busy workqueues and worker pools:\n");
4815
4816 list_for_each_entry_rcu(wq, &workqueues, list) {
4817 struct pool_workqueue *pwq;
4818 bool idle = true;
4819
4820 for_each_pwq(pwq, wq) {
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004821 if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
Tejun Heo3494fc32015-03-09 09:22:28 -04004822 idle = false;
4823 break;
4824 }
4825 }
4826 if (idle)
4827 continue;
4828
4829 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4830
4831 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004832 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08004833 if (pwq->nr_active || !list_empty(&pwq->inactive_works))
Tejun Heo3494fc32015-03-09 09:22:28 -04004834 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004835 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004836 /*
4837 * We could be printing a lot from atomic context, e.g.
4838 * sysrq-t -> show_workqueue_state(). Avoid triggering
4839 * hard lockup.
4840 */
4841 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004842 }
4843 }
4844
4845 for_each_pool(pool, pi) {
4846 struct worker *worker;
4847 bool first = true;
4848
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004849 raw_spin_lock_irqsave(&pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004850 if (pool->nr_workers == pool->nr_idle)
4851 goto next_pool;
4852
4853 pr_info("pool %d:", pool->id);
4854 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004855 pr_cont(" hung=%us workers=%d",
4856 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4857 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004858 if (pool->manager)
4859 pr_cont(" manager: %d",
4860 task_pid_nr(pool->manager->task));
4861 list_for_each_entry(worker, &pool->idle_list, entry) {
4862 pr_cont(" %s%d", first ? "idle: " : "",
4863 task_pid_nr(worker->task));
4864 first = false;
4865 }
4866 pr_cont("\n");
4867 next_pool:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004868 raw_spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004869 /*
4870 * We could be printing a lot from atomic context, e.g.
4871 * sysrq-t -> show_workqueue_state(). Avoid triggering
4872 * hard lockup.
4873 */
4874 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004875 }
4876
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004877 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004878}
4879
Tejun Heo6b598082018-05-18 08:47:13 -07004880/* used to show worker information through /proc/PID/{comm,stat,status} */
4881void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4882{
Tejun Heo6b598082018-05-18 08:47:13 -07004883 int off;
4884
4885 /* always show the actual comm */
4886 off = strscpy(buf, task->comm, size);
4887 if (off < 0)
4888 return;
4889
Tejun Heo197f6ac2018-05-21 08:04:35 -07004890 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004891 mutex_lock(&wq_pool_attach_mutex);
4892
Tejun Heo197f6ac2018-05-21 08:04:35 -07004893 if (task->flags & PF_WQ_WORKER) {
4894 struct worker *worker = kthread_data(task);
4895 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004896
Tejun Heo197f6ac2018-05-21 08:04:35 -07004897 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004898 raw_spin_lock_irq(&pool->lock);
Tejun Heo197f6ac2018-05-21 08:04:35 -07004899 /*
4900 * ->desc tracks information (wq name or
4901 * set_worker_desc()) for the latest execution. If
4902 * current, prepend '+', otherwise '-'.
4903 */
4904 if (worker->desc[0] != '\0') {
4905 if (worker->current_work)
4906 scnprintf(buf + off, size - off, "+%s",
4907 worker->desc);
4908 else
4909 scnprintf(buf + off, size - off, "-%s",
4910 worker->desc);
4911 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004912 raw_spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004913 }
Tejun Heo6b598082018-05-18 08:47:13 -07004914 }
4915
4916 mutex_unlock(&wq_pool_attach_mutex);
4917}
4918
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004919#ifdef CONFIG_SMP
4920
Tejun Heodb7bccf2010-06-29 10:07:12 +02004921/*
4922 * CPU hotplug.
4923 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004924 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004925 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004926 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004927 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004928 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004929 * blocked draining impractical.
4930 *
Tejun Heo24647572013-01-24 11:01:33 -08004931 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004932 * running as an unbound one and allowing it to be reattached later if the
4933 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004934 */
4935
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004936static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004937{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004938 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004939 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004940
Tejun Heof02ae732013-03-12 11:30:03 -07004941 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004942 mutex_lock(&wq_pool_attach_mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004943 raw_spin_lock_irq(&pool->lock);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004944
4945 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004946 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004947 * unbound and set DISASSOCIATED. Before this, all workers
4948 * except for the ones which are still executing works from
4949 * before the last CPU down must be on the cpu. After
4950 * this, they may become diasporas.
4951 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004952 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004953 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004954
Tejun Heo24647572013-01-24 11:01:33 -08004955 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004956
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004957 raw_spin_unlock_irq(&pool->lock);
Peter Zijlstra06249732020-09-25 15:45:11 +02004958
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004959 for_each_pool_worker(worker, pool) {
4960 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshan547a77d2021-01-11 23:26:33 +08004961 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004962 }
Peter Zijlstra06249732020-09-25 15:45:11 +02004963
Tejun Heo1258fae2018-05-18 08:47:13 -07004964 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004965
Lai Jiangshaneb283422013-03-08 15:18:28 -08004966 /*
4967 * Call schedule() so that we cross rq->lock and thus can
4968 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4969 * This is necessary as scheduler callbacks may be invoked
4970 * from other cpus.
4971 */
4972 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004973
Lai Jiangshaneb283422013-03-08 15:18:28 -08004974 /*
4975 * Sched callbacks are disabled now. Zap nr_running.
4976 * After this, nr_running stays zero and need_more_worker()
4977 * and keep_working() are always true as long as the
4978 * worklist is not empty. This pool now behaves as an
4979 * unbound (in terms of concurrency management) pool which
4980 * are served by workers tied to the pool.
4981 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004982 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004983
4984 /*
4985 * With concurrency management just turned off, a busy
4986 * worker blocking could lead to lengthy stalls. Kick off
4987 * unbound chain execution of currently pending work items.
4988 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004989 raw_spin_lock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004990 wake_up_worker(pool);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004991 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004992 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004993}
4994
Tejun Heobd7c0892013-03-19 13:45:21 -07004995/**
4996 * rebind_workers - rebind all workers of a pool to the associated CPU
4997 * @pool: pool of interest
4998 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004999 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07005000 */
5001static void rebind_workers(struct worker_pool *pool)
5002{
Tejun Heoa9ab7752013-03-19 13:45:21 -07005003 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07005004
Tejun Heo1258fae2018-05-18 08:47:13 -07005005 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07005006
Tejun Heoa9ab7752013-03-19 13:45:21 -07005007 /*
5008 * Restore CPU affinity of all workers. As all idle workers should
5009 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05305010 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07005011 * of all workers first and then clear UNBOUND. As we're called
5012 * from CPU_ONLINE, the following shouldn't fail.
5013 */
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01005014 for_each_pool_worker(worker, pool) {
5015 kthread_set_per_cpu(worker->task, pool->cpu);
Tejun Heoa9ab7752013-03-19 13:45:21 -07005016 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
5017 pool->attrs->cpumask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01005018 }
Tejun Heoa9ab7752013-03-19 13:45:21 -07005019
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005020 raw_spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08005021
Lai Jiangshan3de5e882014-06-03 15:33:27 +08005022 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07005023
Lai Jiangshanda028462014-05-20 17:46:31 +08005024 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07005025 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07005026
5027 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07005028 * A bound idle worker should actually be on the runqueue
5029 * of the associated CPU for local wake-ups targeting it to
5030 * work. Kick all idle workers so that they migrate to the
5031 * associated CPU. Doing this in the same loop as
5032 * replacing UNBOUND with REBOUND is safe as no worker will
5033 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07005034 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07005035 if (worker_flags & WORKER_IDLE)
5036 wake_up_process(worker->task);
5037
5038 /*
5039 * We want to clear UNBOUND but can't directly call
5040 * worker_clr_flags() or adjust nr_running. Atomically
5041 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5042 * @worker will clear REBOUND using worker_clr_flags() when
5043 * it initiates the next execution cycle thus restoring
5044 * concurrency management. Note that when or whether
5045 * @worker clears REBOUND doesn't affect correctness.
5046 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07005047 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07005048 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01005049 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07005050 * fail incorrectly leading to premature concurrency
5051 * management operations.
5052 */
5053 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5054 worker_flags |= WORKER_REBOUND;
5055 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07005056 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07005057 }
5058
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005059 raw_spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07005060}
5061
Tejun Heo7dbc7252013-03-19 13:45:21 -07005062/**
5063 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5064 * @pool: unbound pool of interest
5065 * @cpu: the CPU which is coming up
5066 *
5067 * An unbound pool may end up with a cpumask which doesn't have any online
5068 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5069 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5070 * online CPU before, cpus_allowed of all its workers should be restored.
5071 */
5072static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5073{
5074 static cpumask_t cpumask;
5075 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005076
Tejun Heo1258fae2018-05-18 08:47:13 -07005077 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005078
5079 /* is @cpu allowed for @pool? */
5080 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5081 return;
5082
Tejun Heo7dbc7252013-03-19 13:45:21 -07005083 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005084
5085 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005086 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005087 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005088}
5089
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005090int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005091{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005092 struct worker_pool *pool;
5093
5094 for_each_cpu_worker_pool(pool, cpu) {
5095 if (pool->nr_workers)
5096 continue;
5097 if (!create_worker(pool))
5098 return -ENOMEM;
5099 }
5100 return 0;
5101}
5102
5103int workqueue_online_cpu(unsigned int cpu)
5104{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005105 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005106 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005107 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005108
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005109 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005110
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005111 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005112 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005113
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005114 if (pool->cpu == cpu)
5115 rebind_workers(pool);
5116 else if (pool->cpu < 0)
5117 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005118
Tejun Heo1258fae2018-05-18 08:47:13 -07005119 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005120 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005121
5122 /* update NUMA affinity of unbound workqueues */
5123 list_for_each_entry(wq, &workqueues, list)
5124 wq_update_unbound_numa(wq, cpu, true);
5125
5126 mutex_unlock(&wq_pool_mutex);
5127 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005128}
5129
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005130int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005131{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005132 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005133
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005134 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005135 if (WARN_ON(cpu != smp_processor_id()))
5136 return -1;
5137
5138 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005139
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005140 /* update NUMA affinity of unbound workqueues */
5141 mutex_lock(&wq_pool_mutex);
5142 list_for_each_entry(wq, &workqueues, list)
5143 wq_update_unbound_numa(wq, cpu, false);
5144 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005145
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005146 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005147}
5148
Rusty Russell2d3854a2008-11-05 13:39:10 +11005149struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005150 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005151 long (*fn)(void *);
5152 void *arg;
5153 long ret;
5154};
5155
Tejun Heoed48ece2012-09-18 12:48:43 -07005156static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005157{
Tejun Heoed48ece2012-09-18 12:48:43 -07005158 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5159
Rusty Russell2d3854a2008-11-05 13:39:10 +11005160 wfc->ret = wfc->fn(wfc->arg);
5161}
5162
5163/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005164 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005165 * @cpu: the cpu to run on
5166 * @fn: the function to run
5167 * @arg: the function arg
5168 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005169 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005170 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005171 *
5172 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005173 */
Tejun Heod84ff052013-03-12 11:29:59 -07005174long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005175{
Tejun Heoed48ece2012-09-18 12:48:43 -07005176 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005177
Tejun Heoed48ece2012-09-18 12:48:43 -07005178 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5179 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005180 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005181 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005182 return wfc.ret;
5183}
5184EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005185
5186/**
5187 * work_on_cpu_safe - run a function in thread context on a particular cpu
5188 * @cpu: the cpu to run on
5189 * @fn: the function to run
5190 * @arg: the function argument
5191 *
5192 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5193 * any locks which would prevent @fn from completing.
5194 *
5195 * Return: The value @fn returns.
5196 */
5197long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5198{
5199 long ret = -ENODEV;
5200
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005201 cpus_read_lock();
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005202 if (cpu_online(cpu))
5203 ret = work_on_cpu(cpu, fn, arg);
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005204 cpus_read_unlock();
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005205 return ret;
5206}
5207EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005208#endif /* CONFIG_SMP */
5209
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005210#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305211
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005212/**
5213 * freeze_workqueues_begin - begin freezing workqueues
5214 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005215 * Start freezing workqueues. After this function returns, all freezable
Lai Jiangshanf97a4a12021-08-17 09:32:34 +08005216 * workqueues will queue new works to their inactive_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005217 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005218 *
5219 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005220 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005221 */
5222void freeze_workqueues_begin(void)
5223{
Tejun Heo24b8a842013-03-12 11:29:58 -07005224 struct workqueue_struct *wq;
5225 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005226
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005227 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005228
Tejun Heo6183c002013-03-12 11:29:57 -07005229 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005230 workqueue_freezing = true;
5231
Tejun Heo24b8a842013-03-12 11:29:58 -07005232 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005233 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005234 for_each_pwq(pwq, wq)
5235 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005236 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005237 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005238
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005239 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005240}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005241
5242/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005243 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005244 *
5245 * Check whether freezing is complete. This function must be called
5246 * between freeze_workqueues_begin() and thaw_workqueues().
5247 *
5248 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005249 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005250 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005251 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005252 * %true if some freezable workqueues are still busy. %false if freezing
5253 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005254 */
5255bool freeze_workqueues_busy(void)
5256{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005257 bool busy = false;
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
Tejun Heo24b8a842013-03-12 11:29:58 -07005265 list_for_each_entry(wq, &workqueues, list) {
5266 if (!(wq->flags & WQ_FREEZABLE))
5267 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005268 /*
5269 * nr_active is monotonically decreasing. It's safe
5270 * to peek without lock.
5271 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005272 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005273 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005274 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005275 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005276 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005277 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005278 goto out_unlock;
5279 }
5280 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005281 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005282 }
5283out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005284 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005285 return busy;
5286}
5287
5288/**
5289 * thaw_workqueues - thaw workqueues
5290 *
5291 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005292 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005293 *
5294 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005295 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005296 */
5297void thaw_workqueues(void)
5298{
Tejun Heo24b8a842013-03-12 11:29:58 -07005299 struct workqueue_struct *wq;
5300 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005301
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005302 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005303
5304 if (!workqueue_freezing)
5305 goto out_unlock;
5306
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005307 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005308
Tejun Heo24b8a842013-03-12 11:29:58 -07005309 /* restore max_active and repopulate worklist */
5310 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005311 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005312 for_each_pwq(pwq, wq)
5313 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005314 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005315 }
5316
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005317out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005318 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005319}
5320#endif /* CONFIG_FREEZER */
5321
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005322static int workqueue_apply_unbound_cpumask(void)
5323{
5324 LIST_HEAD(ctxs);
5325 int ret = 0;
5326 struct workqueue_struct *wq;
5327 struct apply_wqattrs_ctx *ctx, *n;
5328
5329 lockdep_assert_held(&wq_pool_mutex);
5330
5331 list_for_each_entry(wq, &workqueues, list) {
5332 if (!(wq->flags & WQ_UNBOUND))
5333 continue;
5334 /* creating multiple pwqs breaks ordering guarantee */
5335 if (wq->flags & __WQ_ORDERED)
5336 continue;
5337
5338 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5339 if (!ctx) {
5340 ret = -ENOMEM;
5341 break;
5342 }
5343
5344 list_add_tail(&ctx->list, &ctxs);
5345 }
5346
5347 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5348 if (!ret)
5349 apply_wqattrs_commit(ctx);
5350 apply_wqattrs_cleanup(ctx);
5351 }
5352
5353 return ret;
5354}
5355
5356/**
5357 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5358 * @cpumask: the cpumask to set
5359 *
5360 * The low-level workqueues cpumask is a global cpumask that limits
5361 * the affinity of all unbound workqueues. This function check the @cpumask
5362 * and apply it to all unbound workqueues and updates all pwqs of them.
5363 *
Cai Huoqing67dc8322021-07-31 08:01:29 +08005364 * Return: 0 - Success
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005365 * -EINVAL - Invalid @cpumask
5366 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5367 */
5368int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5369{
5370 int ret = -EINVAL;
5371 cpumask_var_t saved_cpumask;
5372
5373 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5374 return -ENOMEM;
5375
Tal Shorerc98a9802017-11-03 17:27:50 +02005376 /*
5377 * Not excluding isolated cpus on purpose.
5378 * If the user wishes to include them, we allow that.
5379 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005380 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5381 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005382 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005383
5384 /* save the old wq_unbound_cpumask. */
5385 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5386
5387 /* update wq_unbound_cpumask at first and apply it to wqs. */
5388 cpumask_copy(wq_unbound_cpumask, cpumask);
5389 ret = workqueue_apply_unbound_cpumask();
5390
5391 /* restore the wq_unbound_cpumask when failed. */
5392 if (ret < 0)
5393 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5394
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005395 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005396 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005397
5398 free_cpumask_var(saved_cpumask);
5399 return ret;
5400}
5401
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005402#ifdef CONFIG_SYSFS
5403/*
5404 * Workqueues with WQ_SYSFS flag set is visible to userland via
5405 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5406 * following attributes.
5407 *
5408 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5409 * max_active RW int : maximum number of in-flight work items
5410 *
5411 * Unbound workqueues have the following extra attributes.
5412 *
Wang Long9a19b462017-11-02 23:05:12 -04005413 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005414 * nice RW int : nice value of the workers
5415 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005416 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005417 */
5418struct wq_device {
5419 struct workqueue_struct *wq;
5420 struct device dev;
5421};
5422
5423static struct workqueue_struct *dev_to_wq(struct device *dev)
5424{
5425 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5426
5427 return wq_dev->wq;
5428}
5429
5430static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5431 char *buf)
5432{
5433 struct workqueue_struct *wq = dev_to_wq(dev);
5434
5435 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5436}
5437static DEVICE_ATTR_RO(per_cpu);
5438
5439static ssize_t max_active_show(struct device *dev,
5440 struct device_attribute *attr, char *buf)
5441{
5442 struct workqueue_struct *wq = dev_to_wq(dev);
5443
5444 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5445}
5446
5447static ssize_t max_active_store(struct device *dev,
5448 struct device_attribute *attr, const char *buf,
5449 size_t count)
5450{
5451 struct workqueue_struct *wq = dev_to_wq(dev);
5452 int val;
5453
5454 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5455 return -EINVAL;
5456
5457 workqueue_set_max_active(wq, val);
5458 return count;
5459}
5460static DEVICE_ATTR_RW(max_active);
5461
5462static struct attribute *wq_sysfs_attrs[] = {
5463 &dev_attr_per_cpu.attr,
5464 &dev_attr_max_active.attr,
5465 NULL,
5466};
5467ATTRIBUTE_GROUPS(wq_sysfs);
5468
5469static ssize_t wq_pool_ids_show(struct device *dev,
5470 struct device_attribute *attr, char *buf)
5471{
5472 struct workqueue_struct *wq = dev_to_wq(dev);
5473 const char *delim = "";
5474 int node, written = 0;
5475
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005476 cpus_read_lock();
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005477 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005478 for_each_node(node) {
5479 written += scnprintf(buf + written, PAGE_SIZE - written,
5480 "%s%d:%d", delim, node,
5481 unbound_pwq_by_node(wq, node)->pool->id);
5482 delim = " ";
5483 }
5484 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005485 rcu_read_unlock();
Sebastian Andrzej Siewiorffd8bea2021-08-03 16:16:20 +02005486 cpus_read_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005487
5488 return written;
5489}
5490
5491static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5492 char *buf)
5493{
5494 struct workqueue_struct *wq = dev_to_wq(dev);
5495 int written;
5496
5497 mutex_lock(&wq->mutex);
5498 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5499 mutex_unlock(&wq->mutex);
5500
5501 return written;
5502}
5503
5504/* prepare workqueue_attrs for sysfs store operations */
5505static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5506{
5507 struct workqueue_attrs *attrs;
5508
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005509 lockdep_assert_held(&wq_pool_mutex);
5510
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005511 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005512 if (!attrs)
5513 return NULL;
5514
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005515 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005516 return attrs;
5517}
5518
5519static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5520 const char *buf, size_t count)
5521{
5522 struct workqueue_struct *wq = dev_to_wq(dev);
5523 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005524 int ret = -ENOMEM;
5525
5526 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005527
5528 attrs = wq_sysfs_prep_attrs(wq);
5529 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005530 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005531
5532 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5533 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005534 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005535 else
5536 ret = -EINVAL;
5537
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005538out_unlock:
5539 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005540 free_workqueue_attrs(attrs);
5541 return ret ?: count;
5542}
5543
5544static ssize_t wq_cpumask_show(struct device *dev,
5545 struct device_attribute *attr, char *buf)
5546{
5547 struct workqueue_struct *wq = dev_to_wq(dev);
5548 int written;
5549
5550 mutex_lock(&wq->mutex);
5551 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5552 cpumask_pr_args(wq->unbound_attrs->cpumask));
5553 mutex_unlock(&wq->mutex);
5554 return written;
5555}
5556
5557static ssize_t wq_cpumask_store(struct device *dev,
5558 struct device_attribute *attr,
5559 const char *buf, size_t count)
5560{
5561 struct workqueue_struct *wq = dev_to_wq(dev);
5562 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005563 int ret = -ENOMEM;
5564
5565 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005566
5567 attrs = wq_sysfs_prep_attrs(wq);
5568 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005569 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005570
5571 ret = cpumask_parse(buf, attrs->cpumask);
5572 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005573 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005574
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005575out_unlock:
5576 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005577 free_workqueue_attrs(attrs);
5578 return ret ?: count;
5579}
5580
5581static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5582 char *buf)
5583{
5584 struct workqueue_struct *wq = dev_to_wq(dev);
5585 int written;
5586
5587 mutex_lock(&wq->mutex);
5588 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5589 !wq->unbound_attrs->no_numa);
5590 mutex_unlock(&wq->mutex);
5591
5592 return written;
5593}
5594
5595static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5596 const char *buf, size_t count)
5597{
5598 struct workqueue_struct *wq = dev_to_wq(dev);
5599 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005600 int v, ret = -ENOMEM;
5601
5602 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005603
5604 attrs = wq_sysfs_prep_attrs(wq);
5605 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005606 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005607
5608 ret = -EINVAL;
5609 if (sscanf(buf, "%d", &v) == 1) {
5610 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005611 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005612 }
5613
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005614out_unlock:
5615 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005616 free_workqueue_attrs(attrs);
5617 return ret ?: count;
5618}
5619
5620static struct device_attribute wq_sysfs_unbound_attrs[] = {
5621 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5622 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5623 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5624 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5625 __ATTR_NULL,
5626};
5627
5628static struct bus_type wq_subsys = {
5629 .name = "workqueue",
5630 .dev_groups = wq_sysfs_groups,
5631};
5632
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005633static ssize_t wq_unbound_cpumask_show(struct device *dev,
5634 struct device_attribute *attr, char *buf)
5635{
5636 int written;
5637
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005638 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005639 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5640 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005641 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005642
5643 return written;
5644}
5645
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005646static ssize_t wq_unbound_cpumask_store(struct device *dev,
5647 struct device_attribute *attr, const char *buf, size_t count)
5648{
5649 cpumask_var_t cpumask;
5650 int ret;
5651
5652 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5653 return -ENOMEM;
5654
5655 ret = cpumask_parse(buf, cpumask);
5656 if (!ret)
5657 ret = workqueue_set_unbound_cpumask(cpumask);
5658
5659 free_cpumask_var(cpumask);
5660 return ret ? ret : count;
5661}
5662
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005663static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005664 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5665 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005666
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005667static int __init wq_sysfs_init(void)
5668{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005669 int err;
5670
5671 err = subsys_virtual_register(&wq_subsys, NULL);
5672 if (err)
5673 return err;
5674
5675 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005676}
5677core_initcall(wq_sysfs_init);
5678
5679static void wq_device_release(struct device *dev)
5680{
5681 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5682
5683 kfree(wq_dev);
5684}
5685
5686/**
5687 * workqueue_sysfs_register - make a workqueue visible in sysfs
5688 * @wq: the workqueue to register
5689 *
5690 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5691 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5692 * which is the preferred method.
5693 *
5694 * Workqueue user should use this function directly iff it wants to apply
5695 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5696 * apply_workqueue_attrs() may race against userland updating the
5697 * attributes.
5698 *
5699 * Return: 0 on success, -errno on failure.
5700 */
5701int workqueue_sysfs_register(struct workqueue_struct *wq)
5702{
5703 struct wq_device *wq_dev;
5704 int ret;
5705
5706 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305707 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005708 * attributes breaks ordering guarantee. Disallow exposing ordered
5709 * workqueues.
5710 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005711 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005712 return -EINVAL;
5713
5714 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5715 if (!wq_dev)
5716 return -ENOMEM;
5717
5718 wq_dev->wq = wq;
5719 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005720 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005721 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005722
5723 /*
5724 * unbound_attrs are created separately. Suppress uevent until
5725 * everything is ready.
5726 */
5727 dev_set_uevent_suppress(&wq_dev->dev, true);
5728
5729 ret = device_register(&wq_dev->dev);
5730 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305731 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005732 wq->wq_dev = NULL;
5733 return ret;
5734 }
5735
5736 if (wq->flags & WQ_UNBOUND) {
5737 struct device_attribute *attr;
5738
5739 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5740 ret = device_create_file(&wq_dev->dev, attr);
5741 if (ret) {
5742 device_unregister(&wq_dev->dev);
5743 wq->wq_dev = NULL;
5744 return ret;
5745 }
5746 }
5747 }
5748
5749 dev_set_uevent_suppress(&wq_dev->dev, false);
5750 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5751 return 0;
5752}
5753
5754/**
5755 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5756 * @wq: the workqueue to unregister
5757 *
5758 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5759 */
5760static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5761{
5762 struct wq_device *wq_dev = wq->wq_dev;
5763
5764 if (!wq->wq_dev)
5765 return;
5766
5767 wq->wq_dev = NULL;
5768 device_unregister(&wq_dev->dev);
5769}
5770#else /* CONFIG_SYSFS */
5771static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5772#endif /* CONFIG_SYSFS */
5773
Tejun Heo82607adc2015-12-08 11:28:04 -05005774/*
5775 * Workqueue watchdog.
5776 *
5777 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5778 * flush dependency, a concurrency managed work item which stays RUNNING
5779 * indefinitely. Workqueue stalls can be very difficult to debug as the
5780 * usual warning mechanisms don't trigger and internal workqueue state is
5781 * largely opaque.
5782 *
5783 * Workqueue watchdog monitors all worker pools periodically and dumps
5784 * state if some pools failed to make forward progress for a while where
5785 * forward progress is defined as the first item on ->worklist changing.
5786 *
5787 * This mechanism is controlled through the kernel parameter
5788 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5789 * corresponding sysfs parameter file.
5790 */
5791#ifdef CONFIG_WQ_WATCHDOG
5792
Tejun Heo82607adc2015-12-08 11:28:04 -05005793static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005794static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005795
5796static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5797static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5798
5799static void wq_watchdog_reset_touched(void)
5800{
5801 int cpu;
5802
5803 wq_watchdog_touched = jiffies;
5804 for_each_possible_cpu(cpu)
5805 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5806}
5807
Kees Cook5cd79d62017-10-04 16:27:00 -07005808static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005809{
5810 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5811 bool lockup_detected = false;
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005812 unsigned long now = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005813 struct worker_pool *pool;
5814 int pi;
5815
5816 if (!thresh)
5817 return;
5818
5819 rcu_read_lock();
5820
5821 for_each_pool(pool, pi) {
5822 unsigned long pool_ts, touched, ts;
5823
5824 if (list_empty(&pool->worklist))
5825 continue;
5826
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005827 /*
5828 * If a virtual machine is stopped by the host it can look to
5829 * the watchdog like a stall.
5830 */
5831 kvm_check_and_clear_guest_paused();
5832
Tejun Heo82607adc2015-12-08 11:28:04 -05005833 /* get the latest of pool and touched timestamps */
Wang Qing89e28ce2021-03-24 19:40:29 +08005834 if (pool->cpu >= 0)
5835 touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
5836 else
5837 touched = READ_ONCE(wq_watchdog_touched);
Tejun Heo82607adc2015-12-08 11:28:04 -05005838 pool_ts = READ_ONCE(pool->watchdog_ts);
Tejun Heo82607adc2015-12-08 11:28:04 -05005839
5840 if (time_after(pool_ts, touched))
5841 ts = pool_ts;
5842 else
5843 ts = touched;
5844
Tejun Heo82607adc2015-12-08 11:28:04 -05005845 /* did we stall? */
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005846 if (time_after(now, ts + thresh)) {
Tejun Heo82607adc2015-12-08 11:28:04 -05005847 lockup_detected = true;
5848 pr_emerg("BUG: workqueue lockup - pool");
5849 pr_cont_pool_info(pool);
5850 pr_cont(" stuck for %us!\n",
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005851 jiffies_to_msecs(now - pool_ts) / 1000);
Tejun Heo82607adc2015-12-08 11:28:04 -05005852 }
5853 }
5854
5855 rcu_read_unlock();
5856
5857 if (lockup_detected)
5858 show_workqueue_state();
5859
5860 wq_watchdog_reset_touched();
5861 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5862}
5863
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005864notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005865{
5866 if (cpu >= 0)
5867 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
Wang Qing89e28ce2021-03-24 19:40:29 +08005868
5869 wq_watchdog_touched = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005870}
5871
5872static void wq_watchdog_set_thresh(unsigned long thresh)
5873{
5874 wq_watchdog_thresh = 0;
5875 del_timer_sync(&wq_watchdog_timer);
5876
5877 if (thresh) {
5878 wq_watchdog_thresh = thresh;
5879 wq_watchdog_reset_touched();
5880 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5881 }
5882}
5883
5884static int wq_watchdog_param_set_thresh(const char *val,
5885 const struct kernel_param *kp)
5886{
5887 unsigned long thresh;
5888 int ret;
5889
5890 ret = kstrtoul(val, 0, &thresh);
5891 if (ret)
5892 return ret;
5893
5894 if (system_wq)
5895 wq_watchdog_set_thresh(thresh);
5896 else
5897 wq_watchdog_thresh = thresh;
5898
5899 return 0;
5900}
5901
5902static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5903 .set = wq_watchdog_param_set_thresh,
5904 .get = param_get_ulong,
5905};
5906
5907module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5908 0644);
5909
5910static void wq_watchdog_init(void)
5911{
Kees Cook5cd79d62017-10-04 16:27:00 -07005912 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005913 wq_watchdog_set_thresh(wq_watchdog_thresh);
5914}
5915
5916#else /* CONFIG_WQ_WATCHDOG */
5917
5918static inline void wq_watchdog_init(void) { }
5919
5920#endif /* CONFIG_WQ_WATCHDOG */
5921
Tejun Heobce90382013-04-01 11:23:32 -07005922static void __init wq_numa_init(void)
5923{
5924 cpumask_var_t *tbl;
5925 int node, cpu;
5926
Tejun Heobce90382013-04-01 11:23:32 -07005927 if (num_possible_nodes() <= 1)
5928 return;
5929
Tejun Heod55262c2013-04-01 11:23:38 -07005930 if (wq_disable_numa) {
5931 pr_info("workqueue: NUMA affinity support disabled\n");
5932 return;
5933 }
5934
Zhen Leif728c4a92021-07-22 11:03:52 +08005935 for_each_possible_cpu(cpu) {
5936 if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) {
5937 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5938 return;
5939 }
5940 }
5941
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005942 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005943 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5944
Tejun Heobce90382013-04-01 11:23:32 -07005945 /*
5946 * We want masks of possible CPUs of each node which isn't readily
5947 * available. Build one from cpu_to_node() which should have been
5948 * fully initialized by now.
5949 */
Kees Cook6396bb22018-06-12 14:03:40 -07005950 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005951 BUG_ON(!tbl);
5952
5953 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005954 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005955 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005956
5957 for_each_possible_cpu(cpu) {
5958 node = cpu_to_node(cpu);
Tejun Heobce90382013-04-01 11:23:32 -07005959 cpumask_set_cpu(cpu, tbl[node]);
5960 }
5961
5962 wq_numa_possible_cpumask = tbl;
5963 wq_numa_enabled = true;
5964}
5965
Tejun Heo3347fa02016-09-16 15:49:32 -04005966/**
5967 * workqueue_init_early - early init for workqueue subsystem
5968 *
5969 * This is the first half of two-staged workqueue subsystem initialization
5970 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5971 * idr are up. It sets up all the data structures and system workqueues
5972 * and allows early boot code to create workqueues and queue/cancel work
5973 * items. Actual work item execution starts only after kthreads can be
5974 * created and scheduled right before early initcalls.
5975 */
Yu Chen2333e822020-02-23 15:28:52 +08005976void __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005977{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005978 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005979 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005980 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005981
Lai Jiangshan10cdb152020-06-01 08:44:40 +00005982 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
Tejun Heoe904e6c2013-03-12 11:29:57 -07005983
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005984 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005985 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005986
Tejun Heoe904e6c2013-03-12 11:29:57 -07005987 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5988
Tejun Heo706026c2013-01-24 11:01:34 -08005989 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005990 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005991 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005992
Tejun Heo7a4e3442013-03-12 11:30:00 -07005993 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005994 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005995 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005996 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005997 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005998 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005999 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07006000
Tejun Heo9daf9e62013-01-24 11:01:33 -08006001 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07006002 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08006003 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07006004 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07006005 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02006006 }
6007
Tejun Heo8a2b7532013-09-05 12:30:04 -04006008 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07006009 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
6010 struct workqueue_attrs *attrs;
6011
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02006012 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07006013 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07006014 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04006015
6016 /*
6017 * An ordered wq should have only one pwq as ordering is
6018 * guaranteed by max_active which is enforced by pwqs.
6019 * Turn off NUMA so that dfl_pwq is used for all nodes.
6020 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02006021 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04006022 attrs->nice = std_nice[i];
6023 attrs->no_numa = true;
6024 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07006025 }
6026
Tejun Heod320c032010-06-29 10:07:14 +02006027 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006028 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02006029 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02006030 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
6031 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01006032 system_freezable_wq = alloc_workqueue("events_freezable",
6033 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05306034 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
6035 WQ_POWER_EFFICIENT, 0);
6036 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
6037 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
6038 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006039 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05306040 !system_unbound_wq || !system_freezable_wq ||
6041 !system_power_efficient_wq ||
6042 !system_freezable_power_efficient_wq);
Tejun Heo3347fa02016-09-16 15:49:32 -04006043}
6044
6045/**
6046 * workqueue_init - bring workqueue subsystem fully online
6047 *
6048 * This is the latter half of two-staged workqueue subsystem initialization
6049 * and invoked as soon as kthreads can be created and scheduled.
6050 * Workqueues have been created and work items queued on them, but there
6051 * are no kworkers executing the work items yet. Populate the worker pools
6052 * with the initial workers and enable future kworker creations.
6053 */
Yu Chen2333e822020-02-23 15:28:52 +08006054void __init workqueue_init(void)
Tejun Heo3347fa02016-09-16 15:49:32 -04006055{
Tejun Heo2186d9f2016-10-19 12:01:27 -04006056 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04006057 struct worker_pool *pool;
6058 int cpu, bkt;
6059
Tejun Heo2186d9f2016-10-19 12:01:27 -04006060 /*
6061 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6062 * CPU to node mapping may not be available that early on some
6063 * archs such as power and arm64. As per-cpu pools created
6064 * previously could be missing node hint and unbound pools NUMA
6065 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08006066 *
6067 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006068 */
6069 wq_numa_init();
6070
6071 mutex_lock(&wq_pool_mutex);
6072
6073 for_each_possible_cpu(cpu) {
6074 for_each_cpu_worker_pool(pool, cpu) {
6075 pool->node = cpu_to_node(cpu);
6076 }
6077 }
6078
Tejun Heo40c17f72018-01-08 05:38:37 -08006079 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006080 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006081 WARN(init_rescuer(wq),
6082 "workqueue: failed to create early rescuer for %s",
6083 wq->name);
6084 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006085
6086 mutex_unlock(&wq_pool_mutex);
6087
Tejun Heo3347fa02016-09-16 15:49:32 -04006088 /* create the initial workers */
6089 for_each_online_cpu(cpu) {
6090 for_each_cpu_worker_pool(pool, cpu) {
6091 pool->flags &= ~POOL_DISASSOCIATED;
6092 BUG_ON(!create_worker(pool));
6093 }
6094 }
6095
6096 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6097 BUG_ON(!create_worker(pool));
6098
6099 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006100 wq_watchdog_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006101}