blob: d3c35e47aa90963b4ebbf6d7ae8b0f3c0b5ed546 [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 */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200209 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200210 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700211 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700212 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700213
214 /*
215 * Release of unbound pwq is punted to system_wq. See put_pwq()
216 * and pwq_unbound_release_workfn() for details. pool_workqueue
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100217 * itself is also RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700218 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700219 */
220 struct work_struct unbound_release_work;
221 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700222} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200225 * Structure used to wait for workqueue flush.
226 */
227struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700228 struct list_head list; /* WQ: list of flushers */
229 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200230 struct completion done; /* flush completion */
231};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Tejun Heo226223a2013-03-12 11:30:05 -0700233struct wq_device;
234
Tejun Heo73f53c42010-06-29 10:07:11 +0200235/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700236 * The externally visible workqueue. It relays the issued work items to
237 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 */
239struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700240 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400241 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200242
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700243 struct mutex mutex; /* protects this wq */
244 int work_color; /* WQ: current work color */
245 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800246 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700247 struct wq_flusher *first_flusher; /* WQ: first flusher */
248 struct list_head flusher_queue; /* WQ: flush waiters */
249 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200250
Tejun Heo2e109a22013-03-13 19:47:40 -0700251 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heo30ae2fc2019-09-20 14:09:14 -0700252 struct worker *rescuer; /* MD: rescue worker */
Tejun Heoe22bee72010-06-29 10:07:14 +0200253
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700254 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700255 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700256
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800257 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
258 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700259
Tejun Heo226223a2013-03-12 11:30:05 -0700260#ifdef CONFIG_SYSFS
261 struct wq_device *wq_dev; /* I: for sysfs interface */
262#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800264 char *lock_name;
265 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200266 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700267#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700268 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700269
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400270 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100271 * Destruction of workqueue_struct is RCU protected to allow walking
272 * the workqueues list without grabbing wq_pool_mutex.
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400273 * This is used to dump all workqueues from sysrq.
274 */
275 struct rcu_head rcu;
276
Tejun Heo2728fd22013-04-01 11:23:35 -0700277 /* hot fields used during command issue, aligned to cacheline */
278 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
279 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800280 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
Tejun Heoe904e6c2013-03-12 11:29:57 -0700283static struct kmem_cache *pwq_cache;
284
Tejun Heobce90382013-04-01 11:23:32 -0700285static cpumask_var_t *wq_numa_possible_cpumask;
286 /* possible CPUs of each node */
287
Tejun Heod55262c2013-04-01 11:23:38 -0700288static bool wq_disable_numa;
289module_param_named(disable_numa, wq_disable_numa, bool, 0444);
290
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930292static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530293module_param_named(power_efficient, wq_power_efficient, bool, 0444);
294
Tejun Heo863b7102016-09-16 15:49:34 -0400295static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400296
Tejun Heobce90382013-04-01 11:23:32 -0700297static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
298
Tejun Heo4c16bd32013-04-01 11:23:36 -0700299/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
300static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
301
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700302static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700303static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200304static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +0200305/* wait for manager to go away */
306static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
Tejun Heo5bcab332013-03-13 19:47:40 -0700307
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400308static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700309static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700310
Mike Galbraithef5571802016-02-09 17:59:38 -0500311/* PL: allowable cpus for unbound wqs and work items */
312static cpumask_var_t wq_unbound_cpumask;
313
314/* CPU where unbound work was last round robin scheduled from this CPU */
315static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800316
Tejun Heof303fccb2016-02-09 17:59:38 -0500317/*
318 * Local execution of unbound work items is no longer guaranteed. The
319 * following always forces round-robin CPU selection on unbound work items
320 * to uncover usages which depend on it.
321 */
322#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
323static bool wq_debug_force_rr_cpu = true;
324#else
325static bool wq_debug_force_rr_cpu = false;
326#endif
327module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
328
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700329/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700330static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700331
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700332static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700333
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700334/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700335static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
336
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700337/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700338static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
339
Tejun Heo8a2b7532013-09-05 12:30:04 -0400340/* I: attributes used when instantiating ordered pools on demand */
341static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
342
Tejun Heod320c032010-06-29 10:07:14 +0200343struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400344EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300345struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900346EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300347struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200348EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300349struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200350EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300351struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100352EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530353struct workqueue_struct *system_power_efficient_wq __read_mostly;
354EXPORT_SYMBOL_GPL(system_power_efficient_wq);
355struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
356EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200357
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700358static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800359static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heoc29eb852019-09-23 11:08:58 -0700360static void show_pwq(struct pool_workqueue *pwq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700361
Tejun Heo97bd2342010-10-05 10:41:14 +0200362#define CREATE_TRACE_POINTS
363#include <trace/events/workqueue.h>
364
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700365#define assert_rcu_or_pool_mutex() \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100366 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700367 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100368 "RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700369
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800370#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100371 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700372 !lockdep_is_held(&wq->mutex) && \
373 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100374 "RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800375
Tejun Heof02ae732013-03-12 11:30:03 -0700376#define for_each_cpu_worker_pool(pool, cpu) \
377 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
378 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700379 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700380
Tejun Heo49e3cf42013-03-12 11:29:58 -0700381/**
Tejun Heo17116962013-03-12 11:29:58 -0700382 * for_each_pool - iterate through all worker_pools in the system
383 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700384 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700385 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100386 * This must be called either with wq_pool_mutex held or RCU read
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700387 * locked. If the pool needs to be used beyond the locking in effect, the
388 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700389 *
390 * The if/else clause exists only for the lockdep assertion and can be
391 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700392 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700393#define for_each_pool(pool, pi) \
394 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700395 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700396 else
Tejun Heo17116962013-03-12 11:29:58 -0700397
398/**
Tejun Heo822d8402013-03-19 13:45:21 -0700399 * for_each_pool_worker - iterate through all workers of a worker_pool
400 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700401 * @pool: worker_pool to iterate workers of
402 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700403 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700404 *
405 * The if/else clause exists only for the lockdep assertion and can be
406 * ignored.
407 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800408#define for_each_pool_worker(worker, pool) \
409 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700410 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700411 else
412
413/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700414 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
415 * @pwq: iteration cursor
416 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700417 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100418 * This must be called either with wq->mutex held or RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700419 * If the pwq needs to be used beyond the locking in effect, the caller is
420 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700421 *
422 * The if/else clause exists only for the lockdep assertion and can be
423 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700424 */
425#define for_each_pwq(pwq, wq) \
Sebastian Andrzej Siewior49e9d1a2019-11-15 19:01:25 +0100426 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
Joel Fernandes (Google)5a644662019-08-15 10:18:42 -0400427 lockdep_is_held(&(wq->mutex)))
Tejun Heof3421792010-07-02 10:03:51 +0200428
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900429#ifdef CONFIG_DEBUG_OBJECTS_WORK
430
Stephen Boydf9e62f32020-08-14 17:40:27 -0700431static const struct debug_obj_descr work_debug_descr;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900432
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100433static void *work_debug_hint(void *addr)
434{
435 return ((struct work_struct *) addr)->func;
436}
437
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700438static bool work_is_static_object(void *addr)
439{
440 struct work_struct *work = addr;
441
442 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
443}
444
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900445/*
446 * fixup_init is called when:
447 * - an active object is initialized
448 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700449static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900450{
451 struct work_struct *work = addr;
452
453 switch (state) {
454 case ODEBUG_STATE_ACTIVE:
455 cancel_work_sync(work);
456 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700457 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900458 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700459 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900460 }
461}
462
463/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900464 * fixup_free is called when:
465 * - an active object is freed
466 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700467static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900468{
469 struct work_struct *work = addr;
470
471 switch (state) {
472 case ODEBUG_STATE_ACTIVE:
473 cancel_work_sync(work);
474 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700475 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900476 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 }
479}
480
Stephen Boydf9e62f32020-08-14 17:40:27 -0700481static const struct debug_obj_descr work_debug_descr = {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900482 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100483 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700484 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900485 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900486 .fixup_free = work_fixup_free,
487};
488
489static inline void debug_work_activate(struct work_struct *work)
490{
491 debug_object_activate(work, &work_debug_descr);
492}
493
494static inline void debug_work_deactivate(struct work_struct *work)
495{
496 debug_object_deactivate(work, &work_debug_descr);
497}
498
499void __init_work(struct work_struct *work, int onstack)
500{
501 if (onstack)
502 debug_object_init_on_stack(work, &work_debug_descr);
503 else
504 debug_object_init(work, &work_debug_descr);
505}
506EXPORT_SYMBOL_GPL(__init_work);
507
508void destroy_work_on_stack(struct work_struct *work)
509{
510 debug_object_free(work, &work_debug_descr);
511}
512EXPORT_SYMBOL_GPL(destroy_work_on_stack);
513
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000514void destroy_delayed_work_on_stack(struct delayed_work *work)
515{
516 destroy_timer_on_stack(&work->timer);
517 debug_object_free(&work->work, &work_debug_descr);
518}
519EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
520
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900521#else
522static inline void debug_work_activate(struct work_struct *work) { }
523static inline void debug_work_deactivate(struct work_struct *work) { }
524#endif
525
Li Bin4e8b22b2013-09-10 09:52:35 +0800526/**
Cai Huoqing67dc8322021-07-31 08:01:29 +0800527 * worker_pool_assign_id - allocate ID and assign it to @pool
Li Bin4e8b22b2013-09-10 09:52:35 +0800528 * @pool: the pool pointer of interest
529 *
530 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
531 * successfully, -errno on failure.
532 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800533static int worker_pool_assign_id(struct worker_pool *pool)
534{
535 int ret;
536
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700537 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700538
Li Bin4e8b22b2013-09-10 09:52:35 +0800539 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
540 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700541 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700542 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700543 return 0;
544 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800545 return ret;
546}
547
Tejun Heo76af4d92013-03-12 11:30:00 -0700548/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700549 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
550 * @wq: the target workqueue
551 * @node: the node ID
552 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100553 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800554 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700555 * If the pwq needs to be used beyond the locking in effect, the caller is
556 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700557 *
558 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700559 */
560static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
561 int node)
562{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800563 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500564
565 /*
566 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
567 * delayed item is pending. The plan is to keep CPU -> NODE
568 * mapping valid and stable across CPU on/offlines. Once that
569 * happens, this workaround can be removed.
570 */
571 if (unlikely(node == NUMA_NO_NODE))
572 return wq->dfl_pwq;
573
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700574 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
575}
576
Tejun Heo73f53c42010-06-29 10:07:11 +0200577static unsigned int work_color_to_flags(int color)
578{
579 return color << WORK_STRUCT_COLOR_SHIFT;
580}
581
582static int get_work_color(struct work_struct *work)
583{
584 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
585 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
586}
587
588static int work_next_color(int color)
589{
590 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700591}
592
David Howells4594bf12006-12-07 11:33:26 +0000593/*
Tejun Heo112202d2013-02-13 19:29:12 -0800594 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
595 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800596 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200597 *
Tejun Heo112202d2013-02-13 19:29:12 -0800598 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
599 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700600 * work->data. These functions should only be called while the work is
601 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 *
Tejun Heo112202d2013-02-13 19:29:12 -0800603 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800604 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700607 *
608 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
609 * canceled. While being canceled, a work item may have its PENDING set
610 * but stay off timer and worklist for arbitrarily long and nobody should
611 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000612 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200613static inline void set_work_data(struct work_struct *work, unsigned long data,
614 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000615{
Tejun Heo6183c002013-03-12 11:29:57 -0700616 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000618}
David Howells365970a2006-11-22 14:54:49 +0000619
Tejun Heo112202d2013-02-13 19:29:12 -0800620static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200621 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200622{
Tejun Heo112202d2013-02-13 19:29:12 -0800623 set_work_data(work, (unsigned long)pwq,
624 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200625}
626
Lai Jiangshan4468a002013-02-06 18:04:53 -0800627static void set_work_pool_and_keep_pending(struct work_struct *work,
628 int pool_id)
629{
630 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
631 WORK_STRUCT_PENDING);
632}
633
Tejun Heo7c3eed52013-01-24 11:01:33 -0800634static void set_work_pool_and_clear_pending(struct work_struct *work,
635 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000636{
Tejun Heo23657bb2012-08-13 17:08:19 -0700637 /*
638 * The following wmb is paired with the implied mb in
639 * test_and_set_bit(PENDING) and ensures all updates to @work made
640 * here are visible to and precede any updates by the next PENDING
641 * owner.
642 */
643 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800644 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200645 /*
646 * The following mb guarantees that previous clear of a PENDING bit
647 * will not be reordered with any speculative LOADS or STORES from
648 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800649 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200650 * the same @work. E.g. consider this case:
651 *
652 * CPU#0 CPU#1
653 * ---------------------------- --------------------------------
654 *
655 * 1 STORE event_indicated
656 * 2 queue_work_on() {
657 * 3 test_and_set_bit(PENDING)
658 * 4 } set_..._and_clear_pending() {
659 * 5 set_work_data() # clear bit
660 * 6 smp_mb()
661 * 7 work->current_func() {
662 * 8 LOAD event_indicated
663 * }
664 *
665 * Without an explicit full barrier speculative LOAD on line 8 can
666 * be executed before CPU#0 does STORE on line 1. If that happens,
667 * CPU#0 observes the PENDING bit is still set and new execution of
668 * a @work is not queued in a hope, that CPU#1 will eventually
669 * finish the queued @work. Meanwhile CPU#1 does not see
670 * event_indicated is set, because speculative LOAD was executed
671 * before actual STORE.
672 */
673 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200674}
675
676static void clear_work_data(struct work_struct *work)
677{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800678 smp_wmb(); /* see set_work_pool_and_clear_pending() */
679 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200680}
681
Tejun Heo112202d2013-02-13 19:29:12 -0800682static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200683{
Tejun Heoe1201532010-07-22 14:14:25 +0200684 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685
Tejun Heo112202d2013-02-13 19:29:12 -0800686 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200687 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
688 else
689 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200690}
691
Tejun Heo7c3eed52013-01-24 11:01:33 -0800692/**
693 * get_work_pool - return the worker_pool a given work was associated with
694 * @work: the work item of interest
695 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700696 * Pools are created and destroyed under wq_pool_mutex, and allows read
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100697 * access under RCU read lock. As such, this function should be
698 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700699 *
700 * All fields of the returned pool are accessible as long as the above
701 * mentioned locking is in effect. If the returned pool needs to be used
702 * beyond the critical section, the caller is responsible for ensuring the
703 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700704 *
705 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800706 */
707static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200708{
Tejun Heoe1201532010-07-22 14:14:25 +0200709 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200711
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700712 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700713
Tejun Heo112202d2013-02-13 19:29:12 -0800714 if (data & WORK_STRUCT_PWQ)
715 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800716 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200717
Tejun Heo7c3eed52013-01-24 11:01:33 -0800718 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
719 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200720 return NULL;
721
Tejun Heofa1b54e2013-03-12 11:30:00 -0700722 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723}
724
725/**
726 * get_work_pool_id - return the worker pool ID a given work is associated with
727 * @work: the work item of interest
728 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700729 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800730 * %WORK_OFFQ_POOL_NONE if none.
731 */
732static int get_work_pool_id(struct work_struct *work)
733{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800734 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800735
Tejun Heo112202d2013-02-13 19:29:12 -0800736 if (data & WORK_STRUCT_PWQ)
737 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800738 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
739
740 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800741}
742
Tejun Heobbb68df2012-08-03 10:30:46 -0700743static void mark_work_canceling(struct work_struct *work)
744{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800745 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700746
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 pool_id <<= WORK_OFFQ_POOL_SHIFT;
748 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700749}
750
751static bool work_is_canceling(struct work_struct *work)
752{
753 unsigned long data = atomic_long_read(&work->data);
754
Tejun Heo112202d2013-02-13 19:29:12 -0800755 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700756}
757
David Howells365970a2006-11-22 14:54:49 +0000758/*
Tejun Heo32704762012-07-13 22:16:45 -0700759 * Policy functions. These define the policies on how the global worker
760 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800761 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000762 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200763
Tejun Heo63d95a92012-07-12 14:46:37 -0700764static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000765{
Tejun Heoe19e3972013-01-24 11:39:44 -0800766 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000767}
768
Tejun Heoe22bee72010-06-29 10:07:14 +0200769/*
770 * Need to wake up a worker? Called from anything but currently
771 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700772 *
773 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800774 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700775 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200776 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700777static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000778{
Tejun Heo63d95a92012-07-12 14:46:37 -0700779 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000780}
781
Tejun Heoe22bee72010-06-29 10:07:14 +0200782/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700783static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200784{
Tejun Heo63d95a92012-07-12 14:46:37 -0700785 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200786}
787
788/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700789static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200790{
Tejun Heoe19e3972013-01-24 11:39:44 -0800791 return !list_empty(&pool->worklist) &&
792 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200793}
794
795/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700796static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200797{
Tejun Heo63d95a92012-07-12 14:46:37 -0700798 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200799}
800
Tejun Heoe22bee72010-06-29 10:07:14 +0200801/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700802static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200803{
Tejun Heo692b4822017-10-09 08:04:13 -0700804 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700805 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
806 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807
808 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
809}
810
811/*
812 * Wake up functions.
813 */
814
Lai Jiangshan1037de32014-05-22 16:44:07 +0800815/* Return the first idle worker. Safe with preemption disabled */
816static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200817{
Tejun Heo63d95a92012-07-12 14:46:37 -0700818 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200819 return NULL;
820
Tejun Heo63d95a92012-07-12 14:46:37 -0700821 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200822}
823
824/**
825 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700826 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200827 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
830 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200831 * raw_spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200832 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700833static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200834{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800835 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200836
837 if (likely(worker))
838 wake_up_process(worker->task);
839}
840
Tejun Heo4690c4a2010-06-29 10:07:10 +0200841/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100842 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100845 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200846 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100847void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200848{
849 struct worker *worker = kthread_data(task);
850
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100851 if (!worker->sleeping)
852 return;
853 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800854 atomic_inc(&worker->pool->nr_running);
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100855 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200856}
857
858/**
859 * wq_worker_sleeping - a worker is going to sleep
860 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200861 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100862 * This function is called from schedule() when a busy worker is
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100863 * going to sleep. Preemption needs to be disabled to protect ->sleeping
864 * assignment.
Tejun Heoe22bee72010-06-29 10:07:14 +0200865 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100866void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200867{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100868 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800869 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200870
Tejun Heo111c2252013-01-17 17:16:24 -0800871 /*
872 * Rescuers, which may not have all the fields set up like normal
873 * workers, also reach here, let's not access anything before
874 * checking NOT_RUNNING.
875 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500876 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100877 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200878
Tejun Heo111c2252013-01-17 17:16:24 -0800879 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800880
Sebastian Andrzej Siewior62849a92020-03-28 00:29:59 +0100881 /* Return if preempted before wq_worker_running() was reached */
882 if (worker->sleeping)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100883 return;
884
885 worker->sleeping = 1;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200886 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200887
888 /*
889 * The counterpart of the following dec_and_test, implied mb,
890 * worklist not empty test sequence is in insert_work().
891 * Please read comment there.
892 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700893 * NOT_RUNNING is clear. This means that we're bound to and
894 * running on the local cpu w/ rq lock held and preemption
895 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800896 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700897 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200898 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800899 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100900 !list_empty(&pool->worklist)) {
901 next = first_idle_worker(pool);
902 if (next)
903 wake_up_process(next->task);
904 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200905 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200906}
907
908/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800909 * wq_worker_last_func - retrieve worker's last work function
Bart Van Assche8194fe92019-03-19 10:45:09 -0700910 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800911 *
912 * Determine the last function a worker executed. This is called from
913 * the scheduler to get a worker's last known identity.
914 *
915 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200916 * raw_spin_lock_irq(rq->lock)
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800917 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800918 * This function is called during schedule() when a kworker is going
919 * to sleep. It's used by psi to identify aggregation workers during
920 * dequeuing, to allow periodic aggregation to shut-off when that
921 * worker is the last task in the system or cgroup to go to sleep.
922 *
923 * As this function doesn't involve any workqueue-related locking, it
924 * only returns stable values when called from inside the scheduler's
925 * queuing and dequeuing paths, when @task, which must be a kworker,
926 * is guaranteed to not be processing any works.
927 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800928 * Return:
929 * The last work function %current executed as a worker, NULL if it
930 * hasn't executed any work yet.
931 */
932work_func_t wq_worker_last_func(struct task_struct *task)
933{
934 struct worker *worker = kthread_data(task);
935
936 return worker->last_func;
937}
938
939/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200940 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200941 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200942 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200943 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800944 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200945 *
Tejun Heocb444762010-07-02 10:03:50 +0200946 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200947 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200948 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800949static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200950{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700951 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200952
Tejun Heocb444762010-07-02 10:03:50 +0200953 WARN_ON_ONCE(worker->task != current);
954
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800955 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200956 if ((flags & WORKER_NOT_RUNNING) &&
957 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800958 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200959 }
960
Tejun Heod302f012010-06-29 10:07:13 +0200961 worker->flags |= flags;
962}
963
964/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200965 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200966 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200967 * @flags: flags to clear
968 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200969 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200970 *
Tejun Heocb444762010-07-02 10:03:50 +0200971 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +0200972 * raw_spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200973 */
974static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
975{
Tejun Heo63d95a92012-07-12 14:46:37 -0700976 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200977 unsigned int oflags = worker->flags;
978
Tejun Heocb444762010-07-02 10:03:50 +0200979 WARN_ON_ONCE(worker->task != current);
980
Tejun Heod302f012010-06-29 10:07:13 +0200981 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200982
Tejun Heo42c025f2011-01-11 15:58:49 +0100983 /*
984 * If transitioning out of NOT_RUNNING, increment nr_running. Note
985 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
986 * of multiple flags, not a single flag.
987 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200988 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
989 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800990 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200991}
992
993/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200994 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800995 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200996 * @work: work to find worker for
997 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800998 * Find a worker which is executing @work on @pool by searching
999 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001000 * to match, its current execution should match the address of @work and
1001 * its work function. This is to avoid unwanted dependency between
1002 * unrelated work executions through a work item being recycled while still
1003 * being executed.
1004 *
1005 * This is a bit tricky. A work item may be freed once its execution
1006 * starts and nothing prevents the freed area from being recycled for
1007 * another work item. If the same work item address ends up being reused
1008 * before the original execution finishes, workqueue will identify the
1009 * recycled work item as currently executing and make it wait until the
1010 * current execution finishes, introducing an unwanted dependency.
1011 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001012 * This function checks the work item address and work function to avoid
1013 * false positives. Note that this isn't complete as one may construct a
1014 * work function which can introduce dependency onto itself through a
1015 * recycled work item. Well, if somebody wants to shoot oneself in the
1016 * foot that badly, there's only so much we can do, and if such deadlock
1017 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001018 *
1019 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001020 * raw_spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001021 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001022 * Return:
1023 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001024 * otherwise.
1025 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001026static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001027 struct work_struct *work)
1028{
Sasha Levin42f85702012-12-17 10:01:23 -05001029 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001030
Sasha Levinb67bfe02013-02-27 17:06:00 -08001031 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001032 (unsigned long)work)
1033 if (worker->current_work == work &&
1034 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001035 return worker;
1036
1037 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001038}
1039
1040/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001041 * move_linked_works - move linked works to a list
1042 * @work: start of series of works to be scheduled
1043 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301044 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001045 *
1046 * Schedule linked works starting from @work to @head. Work series to
1047 * be scheduled starts at @work and includes any consecutive work with
1048 * WORK_STRUCT_LINKED set in its predecessor.
1049 *
1050 * If @nextp is not NULL, it's updated to point to the next work of
1051 * the last scheduled work. This allows move_linked_works() to be
1052 * nested inside outer list_for_each_entry_safe().
1053 *
1054 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001055 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001056 */
1057static void move_linked_works(struct work_struct *work, struct list_head *head,
1058 struct work_struct **nextp)
1059{
1060 struct work_struct *n;
1061
1062 /*
1063 * Linked worklist will always end before the end of the list,
1064 * use NULL for list head.
1065 */
1066 list_for_each_entry_safe_from(work, n, NULL, entry) {
1067 list_move_tail(&work->entry, head);
1068 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1069 break;
1070 }
1071
1072 /*
1073 * If we're already inside safe list traversal and have moved
1074 * multiple works to the scheduled queue, the next position
1075 * needs to be updated.
1076 */
1077 if (nextp)
1078 *nextp = n;
1079}
1080
Tejun Heo8864b4e2013-03-12 11:30:04 -07001081/**
1082 * get_pwq - get an extra reference on the specified pool_workqueue
1083 * @pwq: pool_workqueue to get
1084 *
1085 * Obtain an extra reference on @pwq. The caller should guarantee that
1086 * @pwq has positive refcnt and be holding the matching pool->lock.
1087 */
1088static void get_pwq(struct pool_workqueue *pwq)
1089{
1090 lockdep_assert_held(&pwq->pool->lock);
1091 WARN_ON_ONCE(pwq->refcnt <= 0);
1092 pwq->refcnt++;
1093}
1094
1095/**
1096 * put_pwq - put a pool_workqueue reference
1097 * @pwq: pool_workqueue to put
1098 *
1099 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1100 * destruction. The caller should be holding the matching pool->lock.
1101 */
1102static void put_pwq(struct pool_workqueue *pwq)
1103{
1104 lockdep_assert_held(&pwq->pool->lock);
1105 if (likely(--pwq->refcnt))
1106 return;
1107 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1108 return;
1109 /*
1110 * @pwq can't be released under pool->lock, bounce to
1111 * pwq_unbound_release_workfn(). This never recurses on the same
1112 * pool->lock as this path is taken only for unbound workqueues and
1113 * the release work item is scheduled on a per-cpu workqueue. To
1114 * avoid lockdep warning, unbound pool->locks are given lockdep
1115 * subclass of 1 in get_unbound_pool().
1116 */
1117 schedule_work(&pwq->unbound_release_work);
1118}
1119
Tejun Heodce90d42013-04-01 11:23:35 -07001120/**
1121 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1122 * @pwq: pool_workqueue to put (can be %NULL)
1123 *
1124 * put_pwq() with locking. This function also allows %NULL @pwq.
1125 */
1126static void put_pwq_unlocked(struct pool_workqueue *pwq)
1127{
1128 if (pwq) {
1129 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001130 * As both pwqs and pools are RCU protected, the
Tejun Heodce90d42013-04-01 11:23:35 -07001131 * following lock operations are safe.
1132 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001133 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001134 put_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001135 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heodce90d42013-04-01 11:23:35 -07001136 }
1137}
1138
Tejun Heo112202d2013-02-13 19:29:12 -08001139static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001140{
Tejun Heo112202d2013-02-13 19:29:12 -08001141 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001142
1143 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001144 if (list_empty(&pwq->pool->worklist))
1145 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001146 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001147 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001148 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001149}
1150
Tejun Heo112202d2013-02-13 19:29:12 -08001151static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001152{
Tejun Heo112202d2013-02-13 19:29:12 -08001153 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001154 struct work_struct, entry);
1155
Tejun Heo112202d2013-02-13 19:29:12 -08001156 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001157}
1158
Tejun Heobf4ede02012-08-03 10:30:46 -07001159/**
Tejun Heo112202d2013-02-13 19:29:12 -08001160 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1161 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001162 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001163 *
1164 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001165 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001166 *
1167 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001168 * raw_spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001169 */
Tejun Heo112202d2013-02-13 19:29:12 -08001170static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001171{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001172 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001173 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001174 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001175
Tejun Heo112202d2013-02-13 19:29:12 -08001176 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001177
Tejun Heo112202d2013-02-13 19:29:12 -08001178 pwq->nr_active--;
1179 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001180 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001181 if (pwq->nr_active < pwq->max_active)
1182 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001183 }
1184
1185 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001186 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001187 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001188
1189 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001190 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001191 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001192
Tejun Heo112202d2013-02-13 19:29:12 -08001193 /* this pwq is done, clear flush_color */
1194 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001195
1196 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001197 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001198 * will handle the rest.
1199 */
Tejun Heo112202d2013-02-13 19:29:12 -08001200 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1201 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001202out_put:
1203 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001204}
1205
Tejun Heo36e227d2012-08-03 10:30:46 -07001206/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001207 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001208 * @work: work item to steal
1209 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001210 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001211 *
1212 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001213 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001215 * Return:
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001216 *
1217 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001218 * 1 if @work was pending and we successfully stole PENDING
1219 * 0 if @work was idle and we claimed PENDING
1220 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001221 * -ENOENT if someone else is canceling @work, this state may persist
1222 * for arbitrarily long
Mauro Carvalho Chehab3eb6b312020-09-29 13:12:51 +02001223 * ======== ================================================================
Tejun Heo36e227d2012-08-03 10:30:46 -07001224 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001225 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001226 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001227 * interrupted while holding PENDING and @work off queue, irq must be
1228 * disabled on entry. This, combined with delayed_work->timer being
1229 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001230 *
1231 * On successful return, >= 0, irq is disabled and the caller is
1232 * responsible for releasing it using local_irq_restore(*@flags).
1233 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001234 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001235 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001236static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1237 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001238{
Tejun Heod565ed62013-01-24 11:01:33 -08001239 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001240 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001241
Tejun Heobbb68df2012-08-03 10:30:46 -07001242 local_irq_save(*flags);
1243
Tejun Heo36e227d2012-08-03 10:30:46 -07001244 /* try to steal the timer if it exists */
1245 if (is_dwork) {
1246 struct delayed_work *dwork = to_delayed_work(work);
1247
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001248 /*
1249 * dwork->timer is irqsafe. If del_timer() fails, it's
1250 * guaranteed that the timer is not queued anywhere and not
1251 * running on the local CPU.
1252 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001253 if (likely(del_timer(&dwork->timer)))
1254 return 1;
1255 }
1256
1257 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001258 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1259 return 0;
1260
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001261 rcu_read_lock();
Tejun Heobf4ede02012-08-03 10:30:46 -07001262 /*
1263 * The queueing is in progress, or it is already queued. Try to
1264 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1265 */
Tejun Heod565ed62013-01-24 11:01:33 -08001266 pool = get_work_pool(work);
1267 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001268 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001269
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001270 raw_spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001271 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001272 * work->data is guaranteed to point to pwq only while the work
1273 * item is queued on pwq->wq, and both updating work->data to point
1274 * to pwq on queueing and to pool on dequeueing are done under
1275 * pwq->pool->lock. This in turn guarantees that, if work->data
1276 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001277 * item is currently queued on that pool.
1278 */
Tejun Heo112202d2013-02-13 19:29:12 -08001279 pwq = get_work_pwq(work);
1280 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001281 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001282
Tejun Heo16062832013-02-06 18:04:53 -08001283 /*
1284 * A delayed work item cannot be grabbed directly because
1285 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001286 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001287 * management later on and cause stall. Make sure the work
1288 * item is activated before grabbing.
1289 */
1290 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001291 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001292
Tejun Heo16062832013-02-06 18:04:53 -08001293 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001294 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001295
Tejun Heo112202d2013-02-13 19:29:12 -08001296 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001297 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001298
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001299 raw_spin_unlock(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001300 rcu_read_unlock();
Tejun Heo16062832013-02-06 18:04:53 -08001301 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001302 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001303 raw_spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001304fail:
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001305 rcu_read_unlock();
Tejun Heobbb68df2012-08-03 10:30:46 -07001306 local_irq_restore(*flags);
1307 if (work_is_canceling(work))
1308 return -ENOENT;
1309 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001310 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001311}
1312
1313/**
Tejun Heo706026c2013-01-24 11:01:34 -08001314 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001315 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001316 * @work: work to insert
1317 * @head: insertion point
1318 * @extra_flags: extra WORK_STRUCT_* flags to set
1319 *
Tejun Heo112202d2013-02-13 19:29:12 -08001320 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001321 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001322 *
1323 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001324 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001325 */
Tejun Heo112202d2013-02-13 19:29:12 -08001326static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1327 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001328{
Tejun Heo112202d2013-02-13 19:29:12 -08001329 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001330
Walter Wue89a85d2020-12-14 19:09:09 -08001331 /* record the work call stack in order to print it in KASAN reports */
1332 kasan_record_aux_stack(work);
1333
Tejun Heo4690c4a2010-06-29 10:07:10 +02001334 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001335 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001336 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001337 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001338
1339 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001340 * Ensure either wq_worker_sleeping() sees the above
1341 * list_add_tail() or we see zero nr_running to avoid workers lying
1342 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001343 */
1344 smp_mb();
1345
Tejun Heo63d95a92012-07-12 14:46:37 -07001346 if (__need_more_worker(pool))
1347 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001348}
1349
Tejun Heoc8efcc22010-12-20 19:32:04 +01001350/*
1351 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001352 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001353 */
1354static bool is_chained_work(struct workqueue_struct *wq)
1355{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001356 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001357
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001358 worker = current_wq_worker();
1359 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001360 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001361 * I'm @worker, it's safe to dereference it without locking.
1362 */
Tejun Heo112202d2013-02-13 19:29:12 -08001363 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001364}
1365
Mike Galbraithef5571802016-02-09 17:59:38 -05001366/*
1367 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1368 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1369 * avoid perturbing sensitive tasks.
1370 */
1371static int wq_select_unbound_cpu(int cpu)
1372{
Tejun Heof303fccb2016-02-09 17:59:38 -05001373 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001374 int new_cpu;
1375
Tejun Heof303fccb2016-02-09 17:59:38 -05001376 if (likely(!wq_debug_force_rr_cpu)) {
1377 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1378 return cpu;
1379 } else if (!printed_dbg_warning) {
1380 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1381 printed_dbg_warning = true;
1382 }
1383
Mike Galbraithef5571802016-02-09 17:59:38 -05001384 if (cpumask_empty(wq_unbound_cpumask))
1385 return cpu;
1386
1387 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1388 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1389 if (unlikely(new_cpu >= nr_cpu_ids)) {
1390 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1391 if (unlikely(new_cpu >= nr_cpu_ids))
1392 return cpu;
1393 }
1394 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1395
1396 return new_cpu;
1397}
1398
Tejun Heod84ff052013-03-12 11:29:59 -07001399static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 struct work_struct *work)
1401{
Tejun Heo112202d2013-02-13 19:29:12 -08001402 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001403 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001404 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001405 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001406 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001407
1408 /*
1409 * While a work item is PENDING && off queue, a task trying to
1410 * steal the PENDING will busy-loop waiting for it to either get
1411 * queued or lose PENDING. Grabbing PENDING and queueing should
1412 * happen with IRQ disabled.
1413 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001414 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001416
Li Bin9ef28a72013-09-09 13:13:58 +08001417 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001418 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001419 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001420 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001421 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001422retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001423 /* pwq which will be used unless @work is executing elsewhere */
Hillf Dantonaa202f12020-01-24 20:14:45 -05001424 if (wq->flags & WQ_UNBOUND) {
1425 if (req_cpu == WORK_CPU_UNBOUND)
1426 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001427 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Dantonaa202f12020-01-24 20:14:45 -05001428 } else {
1429 if (req_cpu == WORK_CPU_UNBOUND)
1430 cpu = raw_smp_processor_id();
1431 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1432 }
Tejun Heodbf25762012-08-20 14:51:23 -07001433
Tejun Heoc9178082013-03-12 11:30:04 -07001434 /*
1435 * If @work was previously on a different pool, it might still be
1436 * running there, in which case the work needs to be queued on that
1437 * pool to guarantee non-reentrancy.
1438 */
1439 last_pool = get_work_pool(work);
1440 if (last_pool && last_pool != pwq->pool) {
1441 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001442
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001443 raw_spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001444
Tejun Heoc9178082013-03-12 11:30:04 -07001445 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001446
Tejun Heoc9178082013-03-12 11:30:04 -07001447 if (worker && worker->current_pwq->wq == wq) {
1448 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001449 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001450 /* meh... not running there, queue here */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001451 raw_spin_unlock(&last_pool->lock);
1452 raw_spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001453 }
Tejun Heof3421792010-07-02 10:03:51 +02001454 } else {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001455 raw_spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001456 }
1457
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001458 /*
1459 * pwq is determined and locked. For unbound pools, we could have
1460 * raced with pwq release and it could already be dead. If its
1461 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001462 * without another pwq replacing it in the numa_pwq_tbl or while
1463 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001464 * make forward-progress.
1465 */
1466 if (unlikely(!pwq->refcnt)) {
1467 if (wq->flags & WQ_UNBOUND) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001468 raw_spin_unlock(&pwq->pool->lock);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001469 cpu_relax();
1470 goto retry;
1471 }
1472 /* oops */
1473 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1474 wq->name, cpu);
1475 }
1476
Tejun Heo112202d2013-02-13 19:29:12 -08001477 /* pwq determined, queue */
1478 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001479
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001480 if (WARN_ON(!list_empty(&work->entry)))
1481 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001482
Tejun Heo112202d2013-02-13 19:29:12 -08001483 pwq->nr_in_flight[pwq->work_color]++;
1484 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001485
Tejun Heo112202d2013-02-13 19:29:12 -08001486 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001487 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001488 pwq->nr_active++;
1489 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001490 if (list_empty(worklist))
1491 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001492 } else {
1493 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001494 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001495 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001496
Zqiang0687c662021-02-18 11:16:49 +08001497 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001498 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001499
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001500out:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001501 raw_spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001502 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503}
1504
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001505/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001506 * queue_work_on - queue work on specific cpu
1507 * @cpu: CPU number to execute work on
1508 * @wq: workqueue to use
1509 * @work: work to queue
1510 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001511 * We queue the work to a specific CPU, the caller must ensure it
1512 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001513 *
1514 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001515 */
Tejun Heod4283e92012-08-03 10:30:44 -07001516bool queue_work_on(int cpu, struct workqueue_struct *wq,
1517 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001518{
Tejun Heod4283e92012-08-03 10:30:44 -07001519 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001520 unsigned long flags;
1521
1522 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001523
Tejun Heo22df02b2010-06-29 10:07:10 +02001524 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001525 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001526 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001527 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001528
1529 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001530 return ret;
1531}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001532EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001533
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001534/**
1535 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1536 * @node: NUMA node ID that we want to select a CPU from
1537 *
1538 * This function will attempt to find a "random" cpu available on a given
1539 * node. If there are no CPUs available on the given node it will return
1540 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1541 * available CPU if we need to schedule this work.
1542 */
1543static int workqueue_select_cpu_near(int node)
1544{
1545 int cpu;
1546
1547 /* No point in doing this if NUMA isn't enabled for workqueues */
1548 if (!wq_numa_enabled)
1549 return WORK_CPU_UNBOUND;
1550
1551 /* Delay binding to CPU if node is not valid or online */
1552 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1553 return WORK_CPU_UNBOUND;
1554
1555 /* Use local node/cpu if we are already there */
1556 cpu = raw_smp_processor_id();
1557 if (node == cpu_to_node(cpu))
1558 return cpu;
1559
1560 /* Use "random" otherwise know as "first" online CPU of node */
1561 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1562
1563 /* If CPU is valid return that, otherwise just defer */
1564 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1565}
1566
1567/**
1568 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1569 * @node: NUMA node that we are targeting the work for
1570 * @wq: workqueue to use
1571 * @work: work to queue
1572 *
1573 * We queue the work to a "random" CPU within a given NUMA node. The basic
1574 * idea here is to provide a way to somehow associate work with a given
1575 * NUMA node.
1576 *
1577 * This function will only make a best effort attempt at getting this onto
1578 * the right NUMA node. If no node is requested or the requested node is
1579 * offline then we just fall back to standard queue_work behavior.
1580 *
1581 * Currently the "random" CPU ends up being the first available CPU in the
1582 * intersection of cpu_online_mask and the cpumask of the node, unless we
1583 * are running on the node. In that case we just use the current CPU.
1584 *
1585 * Return: %false if @work was already on a queue, %true otherwise.
1586 */
1587bool queue_work_node(int node, struct workqueue_struct *wq,
1588 struct work_struct *work)
1589{
1590 unsigned long flags;
1591 bool ret = false;
1592
1593 /*
1594 * This current implementation is specific to unbound workqueues.
1595 * Specifically we only return the first available CPU for a given
1596 * node instead of cycling through individual CPUs within the node.
1597 *
1598 * If this is used with a per-cpu workqueue then the logic in
1599 * workqueue_select_cpu_near would need to be updated to allow for
1600 * some round robin type logic.
1601 */
1602 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1603
1604 local_irq_save(flags);
1605
1606 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1607 int cpu = workqueue_select_cpu_near(node);
1608
1609 __queue_work(cpu, wq, work);
1610 ret = true;
1611 }
1612
1613 local_irq_restore(flags);
1614 return ret;
1615}
1616EXPORT_SYMBOL_GPL(queue_work_node);
1617
Kees Cook8c20feb2017-10-04 16:27:07 -07001618void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619{
Kees Cook8c20feb2017-10-04 16:27:07 -07001620 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001622 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001623 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001625EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001627static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1628 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001630 struct timer_list *timer = &dwork->timer;
1631 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
Tejun Heo637fdba2017-03-06 15:33:42 -05001633 WARN_ON_ONCE(!wq);
Sami Tolvanen98173112021-04-08 11:28:30 -07001634 WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001635 WARN_ON_ONCE(timer_pending(timer));
1636 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001637
Tejun Heo8852aac2012-12-01 16:23:42 -08001638 /*
1639 * If @delay is 0, queue @dwork->work immediately. This is for
1640 * both optimization and correctness. The earliest @timer can
1641 * expire is on the closest next tick and delayed_work users depend
1642 * on that there's no such delay when @delay is 0.
1643 */
1644 if (!delay) {
1645 __queue_work(cpu, wq, &dwork->work);
1646 return;
1647 }
1648
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001649 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001650 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001651 timer->expires = jiffies + delay;
1652
Tejun Heo041bd122016-02-09 16:11:26 -05001653 if (unlikely(cpu != WORK_CPU_UNBOUND))
1654 add_timer_on(timer, cpu);
1655 else
1656 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657}
1658
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001659/**
1660 * queue_delayed_work_on - queue work on specific CPU after delay
1661 * @cpu: CPU number to execute work on
1662 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001663 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001664 * @delay: number of jiffies to wait before queueing
1665 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001666 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001667 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1668 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001669 */
Tejun Heod4283e92012-08-03 10:30:44 -07001670bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1671 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001672{
David Howells52bad642006-11-22 14:54:01 +00001673 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001674 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001675 unsigned long flags;
1676
1677 /* read the comment in __queue_work() */
1678 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001679
Tejun Heo22df02b2010-06-29 10:07:10 +02001680 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001681 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001682 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001683 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001684
1685 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001686 return ret;
1687}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001688EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689
Tejun Heoc8e55f32010-06-29 10:07:12 +02001690/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001691 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1692 * @cpu: CPU number to execute work on
1693 * @wq: workqueue to use
1694 * @dwork: work to queue
1695 * @delay: number of jiffies to wait before queueing
1696 *
1697 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1698 * modify @dwork's timer so that it expires after @delay. If @delay is
1699 * zero, @work is guaranteed to be scheduled immediately regardless of its
1700 * current state.
1701 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001702 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001703 * pending and its timer was modified.
1704 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001705 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001706 * See try_to_grab_pending() for details.
1707 */
1708bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1709 struct delayed_work *dwork, unsigned long delay)
1710{
1711 unsigned long flags;
1712 int ret;
1713
1714 do {
1715 ret = try_to_grab_pending(&dwork->work, true, &flags);
1716 } while (unlikely(ret == -EAGAIN));
1717
1718 if (likely(ret >= 0)) {
1719 __queue_delayed_work(cpu, wq, dwork, delay);
1720 local_irq_restore(flags);
1721 }
1722
1723 /* -ENOENT from try_to_grab_pending() becomes %true */
1724 return ret;
1725}
1726EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1727
Tejun Heo05f0fe62018-03-14 12:45:13 -07001728static void rcu_work_rcufn(struct rcu_head *rcu)
1729{
1730 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1731
1732 /* read the comment in __queue_work() */
1733 local_irq_disable();
1734 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1735 local_irq_enable();
1736}
1737
1738/**
1739 * queue_rcu_work - queue work after a RCU grace period
1740 * @wq: workqueue to use
1741 * @rwork: work to queue
1742 *
1743 * Return: %false if @rwork was already pending, %true otherwise. Note
1744 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001745 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001746 * execution may happen before a full RCU grace period has passed.
1747 */
1748bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1749{
1750 struct work_struct *work = &rwork->work;
1751
1752 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1753 rwork->wq = wq;
1754 call_rcu(&rwork->rcu, rcu_work_rcufn);
1755 return true;
1756 }
1757
1758 return false;
1759}
1760EXPORT_SYMBOL(queue_rcu_work);
1761
Tejun Heo8376fe22012-08-03 10:30:47 -07001762/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001763 * worker_enter_idle - enter idle state
1764 * @worker: worker which is entering idle state
1765 *
1766 * @worker is entering idle state. Update stats and idle timer if
1767 * necessary.
1768 *
1769 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001770 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001771 */
1772static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001774 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775
Tejun Heo6183c002013-03-12 11:29:57 -07001776 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1777 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1778 (worker->hentry.next || worker->hentry.pprev)))
1779 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
Lai Jiangshan051e1852014-07-22 13:03:02 +08001781 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001782 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001783 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001784 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001785
Tejun Heoc8e55f32010-06-29 10:07:12 +02001786 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001787 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001788
Tejun Heo628c78e2012-07-17 12:39:27 -07001789 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1790 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001791
Tejun Heo544ecf32012-05-14 15:04:50 -07001792 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001793 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001794 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001795 * nr_running, the warning may trigger spuriously. Check iff
1796 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001797 */
Tejun Heo24647572013-01-24 11:01:33 -08001798 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001799 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001800 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801}
1802
Tejun Heoc8e55f32010-06-29 10:07:12 +02001803/**
1804 * worker_leave_idle - leave idle state
1805 * @worker: worker which is leaving idle state
1806 *
1807 * @worker is leaving idle state. Update stats.
1808 *
1809 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001810 * raw_spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001811 */
1812static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001814 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
Tejun Heo6183c002013-03-12 11:29:57 -07001816 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1817 return;
Tejun Heod302f012010-06-29 10:07:13 +02001818 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001819 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001820 list_del_init(&worker->entry);
1821}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001823static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001824{
1825 struct worker *worker;
1826
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001827 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001828 if (worker) {
1829 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001830 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001831 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001832 /* on creation a worker is in !idle && prep state */
1833 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001834 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001835 return worker;
1836}
1837
1838/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001839 * worker_attach_to_pool() - attach a worker to a pool
1840 * @worker: worker to be attached
1841 * @pool: the target pool
1842 *
1843 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1844 * cpu-binding of @worker are kept coordinated with the pool across
1845 * cpu-[un]hotplugs.
1846 */
1847static void worker_attach_to_pool(struct worker *worker,
1848 struct worker_pool *pool)
1849{
Tejun Heo1258fae2018-05-18 08:47:13 -07001850 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001851
1852 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001853 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1854 * stable across this function. See the comments above the flag
1855 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001856 */
1857 if (pool->flags & POOL_DISASSOCIATED)
1858 worker->flags |= WORKER_UNBOUND;
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001859 else
1860 kthread_set_per_cpu(worker->task, pool->cpu);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001861
Peter Zijlstra640f17c2021-01-15 19:08:36 +01001862 if (worker->rescue_wq)
1863 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1864
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001865 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001866 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001867
Tejun Heo1258fae2018-05-18 08:47:13 -07001868 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001869}
1870
1871/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001872 * worker_detach_from_pool() - detach a worker from its pool
1873 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001874 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001875 * Undo the attaching which had been done in worker_attach_to_pool(). The
1876 * caller worker shouldn't access to the pool after detached except it has
1877 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001878 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001879static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001880{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001881 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001882 struct completion *detach_completion = NULL;
1883
Tejun Heo1258fae2018-05-18 08:47:13 -07001884 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001885
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01001886 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshanda028462014-05-20 17:46:31 +08001887 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001888 worker->pool = NULL;
1889
Lai Jiangshanda028462014-05-20 17:46:31 +08001890 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001891 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001892 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001893
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001894 /* clear leftover flags without pool->lock after it is detached */
1895 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1896
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001897 if (detach_completion)
1898 complete(detach_completion);
1899}
1900
1901/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001902 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001903 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001904 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001905 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001906 *
1907 * CONTEXT:
1908 * Might sleep. Does GFP_KERNEL allocations.
1909 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001910 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001911 * Pointer to the newly created worker.
1912 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001913static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001914{
Tejun Heoc34056a2010-06-29 10:07:11 +02001915 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001916 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001917 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001918
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001919 /* ID is needed to determine kthread name */
1920 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001921 if (id < 0)
1922 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001923
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001924 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001925 if (!worker)
1926 goto fail;
1927
Tejun Heoc34056a2010-06-29 10:07:11 +02001928 worker->id = id;
1929
Tejun Heo29c91e92013-03-12 11:30:03 -07001930 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001931 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1932 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001933 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001934 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1935
Tejun Heof3f90ad2013-04-01 11:23:34 -07001936 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001937 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001938 if (IS_ERR(worker->task))
1939 goto fail;
1940
Oleg Nesterov91151222013-11-14 12:56:18 +01001941 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001942 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001943
Lai Jiangshanda028462014-05-20 17:46:31 +08001944 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001945 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001946
Lai Jiangshan051e1852014-07-22 13:03:02 +08001947 /* start the newly created worker */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001948 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001949 worker->pool->nr_workers++;
1950 worker_enter_idle(worker);
1951 wake_up_process(worker->task);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001952 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001953
Tejun Heoc34056a2010-06-29 10:07:11 +02001954 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001955
Tejun Heoc34056a2010-06-29 10:07:11 +02001956fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001957 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001958 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 kfree(worker);
1960 return NULL;
1961}
1962
1963/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001964 * destroy_worker - destroy a workqueue worker
1965 * @worker: worker to be destroyed
1966 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001967 * Destroy @worker and adjust @pool stats accordingly. The worker should
1968 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001969 *
1970 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001971 * raw_spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001972 */
1973static void destroy_worker(struct worker *worker)
1974{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001975 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001976
Tejun Heocd549682013-03-13 19:47:39 -07001977 lockdep_assert_held(&pool->lock);
1978
Tejun Heoc34056a2010-06-29 10:07:11 +02001979 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001980 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001981 WARN_ON(!list_empty(&worker->scheduled)) ||
1982 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001983 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001984
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001985 pool->nr_workers--;
1986 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001987
Tejun Heoc8e55f32010-06-29 10:07:12 +02001988 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001989 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001990 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001991}
1992
Kees Cook32a6c722017-10-16 15:58:25 -07001993static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001994{
Kees Cook32a6c722017-10-16 15:58:25 -07001995 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001996
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02001997 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001998
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001999 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 struct worker *worker;
2001 unsigned long expires;
2002
2003 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07002004 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2006
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002007 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002009 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002010 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002011
2012 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 }
2014
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002015 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002016}
2017
Tejun Heo493a1722013-03-12 11:29:59 -07002018static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002019{
Tejun Heo112202d2013-02-13 19:29:12 -08002020 struct pool_workqueue *pwq = get_work_pwq(work);
2021 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002022
Tejun Heo2e109a22013-03-13 19:47:40 -07002023 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002024
Tejun Heo493008a2013-03-12 11:30:03 -07002025 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002026 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002027
2028 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002029 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002030 /*
2031 * If @pwq is for an unbound wq, its base ref may be put at
2032 * any time due to an attribute change. Pin @pwq until the
2033 * rescuer is done with it.
2034 */
2035 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002036 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002037 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002038 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002039}
2040
Kees Cook32a6c722017-10-16 15:58:25 -07002041static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002042{
Kees Cook32a6c722017-10-16 15:58:25 -07002043 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002044 struct work_struct *work;
2045
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002046 raw_spin_lock_irq(&pool->lock);
2047 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002048
Tejun Heo63d95a92012-07-12 14:46:37 -07002049 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002050 /*
2051 * We've been trying to create a new worker but
2052 * haven't been successful. We might be hitting an
2053 * allocation deadlock. Send distress signals to
2054 * rescuers.
2055 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002056 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002057 send_mayday(work);
2058 }
2059
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002060 raw_spin_unlock(&wq_mayday_lock);
2061 raw_spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002062
Tejun Heo63d95a92012-07-12 14:46:37 -07002063 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002064}
2065
2066/**
2067 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002068 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002069 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002070 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002071 * have at least one idle worker on return from this function. If
2072 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002073 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002074 * possible allocation deadlock.
2075 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002076 * On return, need_to_create_worker() is guaranteed to be %false and
2077 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002078 *
2079 * LOCKING:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002080 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002081 * multiple times. Does GFP_KERNEL allocations. Called only from
2082 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002083 */
Tejun Heo29187a92015-01-16 14:21:16 -05002084static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002085__releases(&pool->lock)
2086__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002087{
Tejun Heoe22bee72010-06-29 10:07:14 +02002088restart:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002089 raw_spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002090
Tejun Heoe22bee72010-06-29 10:07:14 +02002091 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002092 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002093
2094 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002095 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002096 break;
2097
Lai Jiangshane212f362014-06-03 15:32:17 +08002098 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002099
Tejun Heo63d95a92012-07-12 14:46:37 -07002100 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002101 break;
2102 }
2103
Tejun Heo63d95a92012-07-12 14:46:37 -07002104 del_timer_sync(&pool->mayday_timer);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002105 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002106 /*
2107 * This is necessary even after a new worker was just successfully
2108 * created as @pool->lock was dropped and the new worker might have
2109 * already become busy.
2110 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002111 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002112 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002113}
2114
2115/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002116 * manage_workers - manage worker pool
2117 * @worker: self
2118 *
Tejun Heo706026c2013-01-24 11:01:34 -08002119 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002120 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002121 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002122 *
2123 * The caller can safely start processing works on false return. On
2124 * true return, it's guaranteed that need_to_create_worker() is false
2125 * and may_start_working() is true.
2126 *
2127 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002128 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002129 * multiple times. Does GFP_KERNEL allocations.
2130 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002131 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002132 * %false if the pool doesn't need management and the caller can safely
2133 * start processing works, %true if management function was performed and
2134 * the conditions that the caller verified before calling the function may
2135 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002136 */
2137static bool manage_workers(struct worker *worker)
2138{
Tejun Heo63d95a92012-07-12 14:46:37 -07002139 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002140
Tejun Heo692b4822017-10-09 08:04:13 -07002141 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002142 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002143
2144 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002145 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002146
Tejun Heo29187a92015-01-16 14:21:16 -05002147 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002148
Tejun Heo2607d7a2015-03-09 09:22:28 -04002149 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002150 pool->flags &= ~POOL_MANAGER_ACTIVE;
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02002151 rcuwait_wake_up(&manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002152 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002153}
2154
Tejun Heoa62428c2010-06-29 10:07:10 +02002155/**
2156 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002157 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002158 * @work: work to process
2159 *
2160 * Process @work. This function contains all the logics necessary to
2161 * process a single work including synchronization against and
2162 * interaction with other workers on the same cpu, queueing and
2163 * flushing. As long as context requirement is met, any worker can
2164 * call this function to process a work.
2165 *
2166 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002167 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002168 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002169static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002170__releases(&pool->lock)
2171__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002172{
Tejun Heo112202d2013-02-13 19:29:12 -08002173 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002174 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002175 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002176 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002177 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002178#ifdef CONFIG_LOCKDEP
2179 /*
2180 * It is permissible to free the struct work_struct from
2181 * inside the function that is called from it, this we need to
2182 * take into account for lockdep too. To avoid bogus "held
2183 * lock freed" warnings as well as problems when looking into
2184 * work->lockdep_map, make a copy and use that here.
2185 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002186 struct lockdep_map lockdep_map;
2187
2188 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002189#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002190 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002191 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002192 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002193
Tejun Heo7e116292010-06-29 10:07:13 +02002194 /*
2195 * A single work shouldn't be executed concurrently by
2196 * multiple workers on a single cpu. Check whether anyone is
2197 * already processing the work. If so, defer the work to the
2198 * currently executing one.
2199 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002200 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002201 if (unlikely(collision)) {
2202 move_linked_works(work, &collision->scheduled, NULL);
2203 return;
2204 }
2205
Tejun Heo8930cab2012-08-03 10:30:45 -07002206 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002207 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002208 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002209 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002210 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002211 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002212 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002213
Tejun Heo8bf89592018-05-18 08:47:13 -07002214 /*
2215 * Record wq name for cmdline and debug reporting, may get
2216 * overridden through set_worker_desc().
2217 */
2218 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2219
Tejun Heoa62428c2010-06-29 10:07:10 +02002220 list_del_init(&work->entry);
2221
Tejun Heo649027d2010-06-29 10:07:14 +02002222 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002223 * CPU intensive works don't participate in concurrency management.
2224 * They're the scheduler's responsibility. This takes @worker out
2225 * of concurrency management and the next code block will chain
2226 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002227 */
2228 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002229 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002230
Tejun Heo974271c2012-07-12 14:46:37 -07002231 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002232 * Wake up another worker if necessary. The condition is always
2233 * false for normal per-cpu workers since nr_running would always
2234 * be >= 1 at this point. This is used to chain execution of the
2235 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002236 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002237 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002238 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002239 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002240
Tejun Heo8930cab2012-08-03 10:30:45 -07002241 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002242 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002243 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002244 * PENDING and queued state changes happen together while IRQ is
2245 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002246 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002247 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002248
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002249 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002250
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002251 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002252 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002253 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002254 * Strictly speaking we should mark the invariant state without holding
2255 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002256 *
2257 * However, that would result in:
2258 *
2259 * A(W1)
2260 * WFC(C)
2261 * A(W1)
2262 * C(C)
2263 *
2264 * Which would create W1->C->W1 dependencies, even though there is no
2265 * actual deadlock possible. There are two solutions, using a
2266 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002267 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002268 * these locks.
2269 *
2270 * AFAICT there is no possible deadlock scenario between the
2271 * flush_work() and complete() primitives (except for single-threaded
2272 * workqueues), so hiding them isn't a problem.
2273 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002274 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002275 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002276 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002277 /*
2278 * While we must be careful to not use "work" after this, the trace
2279 * point will only record its address.
2280 */
Daniel Jordan1c5da0e2020-01-13 17:52:39 -05002281 trace_workqueue_execute_end(work, worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002282 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002283 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002284
2285 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002286 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002287 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002288 current->comm, preempt_count(), task_pid_nr(current),
2289 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002290 debug_show_held_locks(current);
2291 dump_stack();
2292 }
2293
Tejun Heob22ce272013-08-28 17:33:37 -04002294 /*
Sebastian Andrzej Siewior025f50f2019-10-15 21:18:21 +02002295 * The following prevents a kworker from hogging CPU on !PREEMPTION
Tejun Heob22ce272013-08-28 17:33:37 -04002296 * kernels, where a requeueing work item waiting for something to
2297 * happen could deadlock with stop_machine as such work item could
2298 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002299 * stop_machine. At the same time, report a quiescent RCU state so
2300 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002301 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002302 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002303
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002304 raw_spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002305
Tejun Heofb0e7be2010-06-29 10:07:15 +02002306 /* clear cpu intensive status */
2307 if (unlikely(cpu_intensive))
2308 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2309
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002310 /* tag the worker for identification in schedule() */
2311 worker->last_func = worker->current_func;
2312
Tejun Heoa62428c2010-06-29 10:07:10 +02002313 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002314 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002315 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002316 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002317 worker->current_pwq = NULL;
2318 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002319}
2320
Tejun Heoaffee4b2010-06-29 10:07:12 +02002321/**
2322 * process_scheduled_works - process scheduled works
2323 * @worker: self
2324 *
2325 * Process all scheduled works. Please note that the scheduled list
2326 * may change while processing a work, so this function repeatedly
2327 * fetches a work from the top and executes it.
2328 *
2329 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002330 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002331 * multiple times.
2332 */
2333static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002335 while (!list_empty(&worker->scheduled)) {
2336 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002338 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340}
2341
Tejun Heo197f6ac2018-05-21 08:04:35 -07002342static void set_pf_worker(bool val)
2343{
2344 mutex_lock(&wq_pool_attach_mutex);
2345 if (val)
2346 current->flags |= PF_WQ_WORKER;
2347 else
2348 current->flags &= ~PF_WQ_WORKER;
2349 mutex_unlock(&wq_pool_attach_mutex);
2350}
2351
Tejun Heo4690c4a2010-06-29 10:07:10 +02002352/**
2353 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002354 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002355 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002356 * The worker thread function. All workers belong to a worker_pool -
2357 * either a per-cpu one or dynamic unbound one. These workers process all
2358 * work items regardless of their specific target workqueue. The only
2359 * exception is work items which belong to workqueues with a rescuer which
2360 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002361 *
2362 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002363 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002364static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365{
Tejun Heoc34056a2010-06-29 10:07:11 +02002366 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002367 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368
Tejun Heoe22bee72010-06-29 10:07:14 +02002369 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002370 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002371woke_up:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002372 raw_spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002373
Tejun Heoa9ab7752013-03-19 13:45:21 -07002374 /* am I supposed to die? */
2375 if (unlikely(worker->flags & WORKER_DIE)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002376 raw_spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002377 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002378 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002379
2380 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002381 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002382 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002383 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002384 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002386
Tejun Heoc8e55f32010-06-29 10:07:12 +02002387 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002388recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002389 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002390 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 goto sleep;
2392
2393 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002394 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002395 goto recheck;
2396
Tejun Heoc8e55f32010-06-29 10:07:12 +02002397 /*
2398 * ->scheduled list can only be filled while a worker is
2399 * preparing to process a work or actually processing it.
2400 * Make sure nobody diddled with it while I was sleeping.
2401 */
Tejun Heo6183c002013-03-12 11:29:57 -07002402 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002403
Tejun Heoe22bee72010-06-29 10:07:14 +02002404 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002405 * Finish PREP stage. We're guaranteed to have at least one idle
2406 * worker or that someone else has already assumed the manager
2407 * role. This is where @worker starts participating in concurrency
2408 * management if applicable and concurrency management is restored
2409 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002410 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002411 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002412
2413 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002414 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002415 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002416 struct work_struct, entry);
2417
Tejun Heo82607adc2015-12-08 11:28:04 -05002418 pool->watchdog_ts = jiffies;
2419
Tejun Heoc8e55f32010-06-29 10:07:12 +02002420 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2421 /* optimization path, not strictly necessary */
2422 process_one_work(worker, work);
2423 if (unlikely(!list_empty(&worker->scheduled)))
2424 process_scheduled_works(worker);
2425 } else {
2426 move_linked_works(work, &worker->scheduled, NULL);
2427 process_scheduled_works(worker);
2428 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002429 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002430
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002431 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002432sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002433 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002434 * pool->lock is held and there's no work to process and no need to
2435 * manage, sleep. Workers are woken up only while holding
2436 * pool->lock or from local cpu, so setting the current state
2437 * before releasing pool->lock is enough to prevent losing any
2438 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002439 */
2440 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002441 __set_current_state(TASK_IDLE);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002442 raw_spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002443 schedule();
2444 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445}
2446
Tejun Heoe22bee72010-06-29 10:07:14 +02002447/**
2448 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002449 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002450 *
2451 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002452 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002453 *
Tejun Heo706026c2013-01-24 11:01:34 -08002454 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002455 * worker which uses GFP_KERNEL allocation which has slight chance of
2456 * developing into deadlock if some works currently on the same queue
2457 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2458 * the problem rescuer solves.
2459 *
Tejun Heo706026c2013-01-24 11:01:34 -08002460 * When such condition is possible, the pool summons rescuers of all
2461 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002462 * those works so that forward progress can be guaranteed.
2463 *
2464 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002465 *
2466 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002467 */
Tejun Heo111c2252013-01-17 17:16:24 -08002468static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002469{
Tejun Heo111c2252013-01-17 17:16:24 -08002470 struct worker *rescuer = __rescuer;
2471 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002472 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002473 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002474
2475 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002476
2477 /*
2478 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2479 * doesn't participate in concurrency management.
2480 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002481 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002482repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002483 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002484
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002485 /*
2486 * By the time the rescuer is requested to stop, the workqueue
2487 * shouldn't have any work pending, but @wq->maydays may still have
2488 * pwq(s) queued. This can happen by non-rescuer workers consuming
2489 * all the work items before the rescuer got to them. Go through
2490 * @wq->maydays processing before acting on should_stop so that the
2491 * list is always empty on exit.
2492 */
2493 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002494
Tejun Heo493a1722013-03-12 11:29:59 -07002495 /* see whether any pwq is asking for help */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002496 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002497
2498 while (!list_empty(&wq->maydays)) {
2499 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2500 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002501 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002502 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002503 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002504
2505 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002506 list_del_init(&pwq->mayday_node);
2507
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002508 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002509
Lai Jiangshan51697d392014-05-20 17:46:36 +08002510 worker_attach_to_pool(rescuer, pool);
2511
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002512 raw_spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002513
2514 /*
2515 * Slurp in all works issued via this workqueue and
2516 * process'em.
2517 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002518 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002519 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2520 if (get_work_pwq(work) == pwq) {
2521 if (first)
2522 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002523 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002524 }
2525 first = false;
2526 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002527
NeilBrown008847f2014-12-08 12:39:16 -05002528 if (!list_empty(scheduled)) {
2529 process_scheduled_works(rescuer);
2530
2531 /*
2532 * The above execution of rescued work items could
2533 * have created more to rescue through
2534 * pwq_activate_first_delayed() or chained
2535 * queueing. Let's put @pwq back on mayday list so
2536 * that such back-to-back work items, which may be
2537 * being used to relieve memory pressure, don't
2538 * incur MAYDAY_INTERVAL delay inbetween.
2539 */
Lai Jiangshan4f3f4cf2020-05-29 06:58:59 +00002540 if (pwq->nr_active && need_to_create_worker(pool)) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002541 raw_spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002542 /*
2543 * Queue iff we aren't racing destruction
2544 * and somebody else hasn't queued it already.
2545 */
2546 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2547 get_pwq(pwq);
2548 list_add_tail(&pwq->mayday_node, &wq->maydays);
2549 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002550 raw_spin_unlock(&wq_mayday_lock);
NeilBrown008847f2014-12-08 12:39:16 -05002551 }
2552 }
Tejun Heo75769582011-02-14 14:04:46 +01002553
2554 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002555 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002556 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002557 */
2558 put_pwq(pwq);
2559
2560 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002561 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002562 * regular worker; otherwise, we end up with 0 concurrency
2563 * and stalling the execution.
2564 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002565 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002566 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002567
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002568 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002569
Tejun Heoa2d812a2018-05-18 08:47:13 -07002570 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002571
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002572 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002573 }
2574
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002575 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002576
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002577 if (should_stop) {
2578 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002579 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002580 return 0;
2581 }
2582
Tejun Heo111c2252013-01-17 17:16:24 -08002583 /* rescuers should never participate in concurrency management */
2584 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002585 schedule();
2586 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587}
2588
Tejun Heofca839c2015-12-07 10:58:57 -05002589/**
2590 * check_flush_dependency - check for flush dependency sanity
2591 * @target_wq: workqueue being flushed
2592 * @target_work: work item being flushed (NULL for workqueue flushes)
2593 *
2594 * %current is trying to flush the whole @target_wq or @target_work on it.
2595 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2596 * reclaiming memory or running on a workqueue which doesn't have
2597 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2598 * a deadlock.
2599 */
2600static void check_flush_dependency(struct workqueue_struct *target_wq,
2601 struct work_struct *target_work)
2602{
2603 work_func_t target_func = target_work ? target_work->func : NULL;
2604 struct worker *worker;
2605
2606 if (target_wq->flags & WQ_MEM_RECLAIM)
2607 return;
2608
2609 worker = current_wq_worker();
2610
2611 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002612 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002613 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002614 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2615 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002616 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002617 worker->current_pwq->wq->name, worker->current_func,
2618 target_wq->name, target_func);
2619}
2620
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002621struct wq_barrier {
2622 struct work_struct work;
2623 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002624 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002625};
2626
2627static void wq_barrier_func(struct work_struct *work)
2628{
2629 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2630 complete(&barr->done);
2631}
2632
Tejun Heo4690c4a2010-06-29 10:07:10 +02002633/**
2634 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002635 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002636 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002637 * @target: target work to attach @barr to
2638 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002639 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002640 * @barr is linked to @target such that @barr is completed only after
2641 * @target finishes execution. Please note that the ordering
2642 * guarantee is observed only with respect to @target and on the local
2643 * cpu.
2644 *
2645 * Currently, a queued barrier can't be canceled. This is because
2646 * try_to_grab_pending() can't determine whether the work to be
2647 * grabbed is at the head of the queue and thus can't clear LINKED
2648 * flag of the previous work while there must be a valid next work
2649 * after a work with LINKED flag set.
2650 *
2651 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002652 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002653 *
2654 * CONTEXT:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002655 * raw_spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002656 */
Tejun Heo112202d2013-02-13 19:29:12 -08002657static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002658 struct wq_barrier *barr,
2659 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002660{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002661 struct list_head *head;
2662 unsigned int linked = 0;
2663
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002664 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002665 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002666 * as we know for sure that this will not trigger any of the
2667 * checks and call back into the fixup functions where we
2668 * might deadlock.
2669 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002670 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002671 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002672
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002673 init_completion_map(&barr->done, &target->lockdep_map);
2674
Tejun Heo2607d7a2015-03-09 09:22:28 -04002675 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002676
Tejun Heoaffee4b2010-06-29 10:07:12 +02002677 /*
2678 * If @target is currently being executed, schedule the
2679 * barrier to the worker; otherwise, put it after @target.
2680 */
2681 if (worker)
2682 head = worker->scheduled.next;
2683 else {
2684 unsigned long *bits = work_data_bits(target);
2685
2686 head = target->entry.next;
2687 /* there can already be other linked works, inherit and set */
2688 linked = *bits & WORK_STRUCT_LINKED;
2689 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2690 }
2691
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002692 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002693 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002694 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002695}
2696
Tejun Heo73f53c42010-06-29 10:07:11 +02002697/**
Tejun Heo112202d2013-02-13 19:29:12 -08002698 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002699 * @wq: workqueue being flushed
2700 * @flush_color: new flush color, < 0 for no-op
2701 * @work_color: new work color, < 0 for no-op
2702 *
Tejun Heo112202d2013-02-13 19:29:12 -08002703 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002704 *
Tejun Heo112202d2013-02-13 19:29:12 -08002705 * If @flush_color is non-negative, flush_color on all pwqs should be
2706 * -1. If no pwq has in-flight commands at the specified color, all
2707 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2708 * has in flight commands, its pwq->flush_color is set to
2709 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002710 * wakeup logic is armed and %true is returned.
2711 *
2712 * The caller should have initialized @wq->first_flusher prior to
2713 * calling this function with non-negative @flush_color. If
2714 * @flush_color is negative, no flush color update is done and %false
2715 * is returned.
2716 *
Tejun Heo112202d2013-02-13 19:29:12 -08002717 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002718 * work_color which is previous to @work_color and all will be
2719 * advanced to @work_color.
2720 *
2721 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002722 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002723 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002724 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002725 * %true if @flush_color >= 0 and there's something to flush. %false
2726 * otherwise.
2727 */
Tejun Heo112202d2013-02-13 19:29:12 -08002728static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002729 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730{
Tejun Heo73f53c42010-06-29 10:07:11 +02002731 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002732 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002733
Tejun Heo73f53c42010-06-29 10:07:11 +02002734 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002735 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002736 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002737 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002738
Tejun Heo49e3cf42013-03-12 11:29:58 -07002739 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002740 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002741
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002742 raw_spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002743
2744 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002745 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002746
Tejun Heo112202d2013-02-13 19:29:12 -08002747 if (pwq->nr_in_flight[flush_color]) {
2748 pwq->flush_color = flush_color;
2749 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002750 wait = true;
2751 }
2752 }
2753
2754 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002755 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002756 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002757 }
2758
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002759 raw_spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002760 }
2761
Tejun Heo112202d2013-02-13 19:29:12 -08002762 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002763 complete(&wq->first_flusher->done);
2764
2765 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
2767
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002768/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002770 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002772 * This function sleeps until all work items which were queued on entry
2773 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002775void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776{
Tejun Heo73f53c42010-06-29 10:07:11 +02002777 struct wq_flusher this_flusher = {
2778 .list = LIST_HEAD_INIT(this_flusher.list),
2779 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002780 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002781 };
2782 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002783
Tejun Heo3347fa02016-09-16 15:49:32 -04002784 if (WARN_ON(!wq_online))
2785 return;
2786
Johannes Berg87915ad2018-08-22 11:49:04 +02002787 lock_map_acquire(&wq->lockdep_map);
2788 lock_map_release(&wq->lockdep_map);
2789
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002790 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002791
2792 /*
2793 * Start-to-wait phase
2794 */
2795 next_color = work_next_color(wq->work_color);
2796
2797 if (next_color != wq->flush_color) {
2798 /*
2799 * Color space is not full. The current work_color
2800 * becomes our flush_color and work_color is advanced
2801 * by one.
2802 */
Tejun Heo6183c002013-03-12 11:29:57 -07002803 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002804 this_flusher.flush_color = wq->work_color;
2805 wq->work_color = next_color;
2806
2807 if (!wq->first_flusher) {
2808 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002809 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002810
2811 wq->first_flusher = &this_flusher;
2812
Tejun Heo112202d2013-02-13 19:29:12 -08002813 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002814 wq->work_color)) {
2815 /* nothing to flush, done */
2816 wq->flush_color = next_color;
2817 wq->first_flusher = NULL;
2818 goto out_unlock;
2819 }
2820 } else {
2821 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002822 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002823 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002824 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002825 }
2826 } else {
2827 /*
2828 * Oops, color space is full, wait on overflow queue.
2829 * The next flush completion will assign us
2830 * flush_color and transfer to flusher_queue.
2831 */
2832 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2833 }
2834
Tejun Heofca839c2015-12-07 10:58:57 -05002835 check_flush_dependency(wq, NULL);
2836
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002837 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002838
2839 wait_for_completion(&this_flusher.done);
2840
2841 /*
2842 * Wake-up-and-cascade phase
2843 *
2844 * First flushers are responsible for cascading flushes and
2845 * handling overflow. Non-first flushers can simply return.
2846 */
Chris Wilson00d5d152020-03-10 16:23:19 +00002847 if (READ_ONCE(wq->first_flusher) != &this_flusher)
Tejun Heo73f53c42010-06-29 10:07:11 +02002848 return;
2849
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002850 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002851
Tejun Heo4ce48b32010-07-02 10:03:51 +02002852 /* we might have raced, check again with mutex held */
2853 if (wq->first_flusher != &this_flusher)
2854 goto out_unlock;
2855
Chris Wilson00d5d152020-03-10 16:23:19 +00002856 WRITE_ONCE(wq->first_flusher, NULL);
Tejun Heo73f53c42010-06-29 10:07:11 +02002857
Tejun Heo6183c002013-03-12 11:29:57 -07002858 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2859 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002860
2861 while (true) {
2862 struct wq_flusher *next, *tmp;
2863
2864 /* complete all the flushers sharing the current flush color */
2865 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2866 if (next->flush_color != wq->flush_color)
2867 break;
2868 list_del_init(&next->list);
2869 complete(&next->done);
2870 }
2871
Tejun Heo6183c002013-03-12 11:29:57 -07002872 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2873 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002874
2875 /* this flush_color is finished, advance by one */
2876 wq->flush_color = work_next_color(wq->flush_color);
2877
2878 /* one color has been freed, handle overflow queue */
2879 if (!list_empty(&wq->flusher_overflow)) {
2880 /*
2881 * Assign the same color to all overflowed
2882 * flushers, advance work_color and append to
2883 * flusher_queue. This is the start-to-wait
2884 * phase for these overflowed flushers.
2885 */
2886 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2887 tmp->flush_color = wq->work_color;
2888
2889 wq->work_color = work_next_color(wq->work_color);
2890
2891 list_splice_tail_init(&wq->flusher_overflow,
2892 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002893 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002894 }
2895
2896 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002897 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002898 break;
2899 }
2900
2901 /*
2902 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002903 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002904 */
Tejun Heo6183c002013-03-12 11:29:57 -07002905 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2906 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002907
2908 list_del_init(&next->list);
2909 wq->first_flusher = next;
2910
Tejun Heo112202d2013-02-13 19:29:12 -08002911 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002912 break;
2913
2914 /*
2915 * Meh... this color is already done, clear first
2916 * flusher and repeat cascading.
2917 */
2918 wq->first_flusher = NULL;
2919 }
2920
2921out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002922 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002924EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002926/**
2927 * drain_workqueue - drain a workqueue
2928 * @wq: workqueue to drain
2929 *
2930 * Wait until the workqueue becomes empty. While draining is in progress,
2931 * only chain queueing is allowed. IOW, only currently pending or running
2932 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002933 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002934 * by the depth of chaining and should be relatively short. Whine if it
2935 * takes too long.
2936 */
2937void drain_workqueue(struct workqueue_struct *wq)
2938{
2939 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002940 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002941
2942 /*
2943 * __queue_work() needs to test whether there are drainers, is much
2944 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002945 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002946 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002947 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002948 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002949 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002950 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002951reflush:
2952 flush_workqueue(wq);
2953
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002954 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002955
Tejun Heo49e3cf42013-03-12 11:29:58 -07002956 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002957 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002958
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002959 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002960 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002961 raw_spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002962
2963 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002964 continue;
2965
2966 if (++flush_cnt == 10 ||
2967 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Stephen Zhange9ad2eb2021-01-23 16:04:00 +08002968 pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
2969 wq->name, __func__, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002970
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002971 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002972 goto reflush;
2973 }
2974
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002975 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002976 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002977 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002978}
2979EXPORT_SYMBOL_GPL(drain_workqueue);
2980
Johannes Bergd6e89782018-08-22 11:49:03 +02002981static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2982 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002983{
2984 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002985 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002986 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002987
2988 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002989
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002990 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002991 pool = get_work_pool(work);
2992 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002993 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002994 return false;
2995 }
2996
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02002997 raw_spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002998 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002999 pwq = get_work_pwq(work);
3000 if (pwq) {
3001 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02003002 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07003003 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003004 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003005 if (!worker)
3006 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003007 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003008 }
Tejun Heobaf59022010-09-16 10:42:16 +02003009
Tejun Heofca839c2015-12-07 10:58:57 -05003010 check_flush_dependency(pwq->wq, work);
3011
Tejun Heo112202d2013-02-13 19:29:12 -08003012 insert_wq_barrier(pwq, barr, work, worker);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003013 raw_spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003014
Tejun Heoe159489b2011-01-09 23:32:15 +01003015 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003016 * Force a lock recursion deadlock when using flush_work() inside a
3017 * single-threaded or rescuer equipped workqueue.
3018 *
3019 * For single threaded workqueues the deadlock happens when the work
3020 * is after the work issuing the flush_work(). For rescuer equipped
3021 * workqueues the deadlock happens when the rescuer stalls, blocking
3022 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003023 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003024 if (!from_cancel &&
3025 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003026 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003027 lock_map_release(&pwq->wq->lockdep_map);
3028 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003029 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003030 return true;
3031already_gone:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003032 raw_spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003033 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003034 return false;
3035}
3036
Johannes Bergd6e89782018-08-22 11:49:03 +02003037static bool __flush_work(struct work_struct *work, bool from_cancel)
3038{
3039 struct wq_barrier barr;
3040
3041 if (WARN_ON(!wq_online))
3042 return false;
3043
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003044 if (WARN_ON(!work->func))
3045 return false;
3046
Johannes Berg87915ad2018-08-22 11:49:04 +02003047 if (!from_cancel) {
3048 lock_map_acquire(&work->lockdep_map);
3049 lock_map_release(&work->lockdep_map);
3050 }
3051
Johannes Bergd6e89782018-08-22 11:49:03 +02003052 if (start_flush_work(work, &barr, from_cancel)) {
3053 wait_for_completion(&barr.done);
3054 destroy_work_on_stack(&barr.work);
3055 return true;
3056 } else {
3057 return false;
3058 }
3059}
3060
Oleg Nesterovdb700892008-07-25 01:47:49 -07003061/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003062 * flush_work - wait for a work to finish executing the last queueing instance
3063 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003064 *
Tejun Heo606a5022012-08-20 14:51:23 -07003065 * Wait until @work has finished execution. @work is guaranteed to be idle
3066 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003067 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003068 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003069 * %true if flush_work() waited for the work to finish execution,
3070 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003071 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003072bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003073{
Johannes Bergd6e89782018-08-22 11:49:03 +02003074 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003075}
3076EXPORT_SYMBOL_GPL(flush_work);
3077
Tejun Heo8603e1b32015-03-05 08:04:13 -05003078struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003079 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003080 struct work_struct *work;
3081};
3082
Ingo Molnarac6424b2017-06-20 12:06:13 +02003083static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003084{
3085 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3086
3087 if (cwait->work != key)
3088 return 0;
3089 return autoremove_wake_function(wait, mode, sync, key);
3090}
3091
Tejun Heo36e227d2012-08-03 10:30:46 -07003092static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003093{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003094 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003095 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003096 int ret;
3097
3098 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003099 ret = try_to_grab_pending(work, is_dwork, &flags);
3100 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003101 * If someone else is already canceling, wait for it to
3102 * finish. flush_work() doesn't work for PREEMPT_NONE
3103 * because we may get scheduled between @work's completion
3104 * and the other canceling task resuming and clearing
3105 * CANCELING - flush_work() will return false immediately
3106 * as @work is no longer busy, try_to_grab_pending() will
3107 * return -ENOENT as @work is still being canceled and the
3108 * other canceling task won't be able to clear CANCELING as
3109 * we're hogging the CPU.
3110 *
3111 * Let's wait for completion using a waitqueue. As this
3112 * may lead to the thundering herd problem, use a custom
3113 * wake function which matches @work along with exclusive
3114 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003115 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003116 if (unlikely(ret == -ENOENT)) {
3117 struct cwt_wait cwait;
3118
3119 init_wait(&cwait.wait);
3120 cwait.wait.func = cwt_wakefn;
3121 cwait.work = work;
3122
3123 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3124 TASK_UNINTERRUPTIBLE);
3125 if (work_is_canceling(work))
3126 schedule();
3127 finish_wait(&cancel_waitq, &cwait.wait);
3128 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003129 } while (unlikely(ret < 0));
3130
Tejun Heobbb68df2012-08-03 10:30:46 -07003131 /* tell other tasks trying to grab @work to back off */
3132 mark_work_canceling(work);
3133 local_irq_restore(flags);
3134
Tejun Heo3347fa02016-09-16 15:49:32 -04003135 /*
3136 * This allows canceling during early boot. We know that @work
3137 * isn't executing.
3138 */
3139 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003140 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003141
Tejun Heo7a22ad72010-06-29 10:07:13 +02003142 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003143
3144 /*
3145 * Paired with prepare_to_wait() above so that either
3146 * waitqueue_active() is visible here or !work_is_canceling() is
3147 * visible there.
3148 */
3149 smp_mb();
3150 if (waitqueue_active(&cancel_waitq))
3151 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3152
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003153 return ret;
3154}
3155
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003156/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003157 * cancel_work_sync - cancel a work and wait for it to finish
3158 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003159 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003160 * Cancel @work and wait for its execution to finish. This function
3161 * can be used even if the work re-queues itself or migrates to
3162 * another workqueue. On return from this function, @work is
3163 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003164 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003165 * cancel_work_sync(&delayed_work->work) must not be used for
3166 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003167 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003168 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003169 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003170 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003171 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003172 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003173 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003174bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003175{
Tejun Heo36e227d2012-08-03 10:30:46 -07003176 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003177}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003178EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003179
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003180/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003181 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3182 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003183 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003184 * Delayed timer is cancelled and the pending work is queued for
3185 * immediate execution. Like flush_work(), this function only
3186 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003187 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003188 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003189 * %true if flush_work() waited for the work to finish execution,
3190 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003191 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003192bool flush_delayed_work(struct delayed_work *dwork)
3193{
Tejun Heo8930cab2012-08-03 10:30:45 -07003194 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003195 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003196 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003197 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003198 return flush_work(&dwork->work);
3199}
3200EXPORT_SYMBOL(flush_delayed_work);
3201
Tejun Heo05f0fe62018-03-14 12:45:13 -07003202/**
3203 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3204 * @rwork: the rcu work to flush
3205 *
3206 * Return:
3207 * %true if flush_rcu_work() waited for the work to finish execution,
3208 * %false if it was already idle.
3209 */
3210bool flush_rcu_work(struct rcu_work *rwork)
3211{
3212 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3213 rcu_barrier();
3214 flush_work(&rwork->work);
3215 return true;
3216 } else {
3217 return flush_work(&rwork->work);
3218 }
3219}
3220EXPORT_SYMBOL(flush_rcu_work);
3221
Jens Axboef72b8792016-08-24 15:51:50 -06003222static bool __cancel_work(struct work_struct *work, bool is_dwork)
3223{
3224 unsigned long flags;
3225 int ret;
3226
3227 do {
3228 ret = try_to_grab_pending(work, is_dwork, &flags);
3229 } while (unlikely(ret == -EAGAIN));
3230
3231 if (unlikely(ret < 0))
3232 return false;
3233
3234 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3235 local_irq_restore(flags);
3236 return ret;
3237}
3238
Tejun Heo401a8d02010-09-16 10:36:00 +02003239/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003240 * cancel_delayed_work - cancel a delayed work
3241 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003242 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003243 * Kill off a pending delayed_work.
3244 *
3245 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3246 * pending.
3247 *
3248 * Note:
3249 * The work callback function may still be running on return, unless
3250 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3251 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003252 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003253 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003254 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003255bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003256{
Jens Axboef72b8792016-08-24 15:51:50 -06003257 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003258}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003259EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003260
3261/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003262 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3263 * @dwork: the delayed work cancel
3264 *
3265 * This is cancel_work_sync() for delayed works.
3266 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003267 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003268 * %true if @dwork was pending, %false otherwise.
3269 */
3270bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003271{
Tejun Heo36e227d2012-08-03 10:30:46 -07003272 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003273}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003274EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003276/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003277 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003278 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003279 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003280 * schedule_on_each_cpu() executes @func on each online CPU using the
3281 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003282 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003283 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003284 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003285 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003286 */
David Howells65f27f32006-11-22 14:55:48 +00003287int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003288{
3289 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003290 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003291
Andrew Mortonb6136772006-06-25 05:47:49 -07003292 works = alloc_percpu(struct work_struct);
3293 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003294 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003295
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003296 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003297
Christoph Lameter15316ba2006-01-08 01:00:43 -08003298 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003299 struct work_struct *work = per_cpu_ptr(works, cpu);
3300
3301 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003302 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003303 }
Tejun Heo93981802009-11-17 14:06:20 -08003304
3305 for_each_online_cpu(cpu)
3306 flush_work(per_cpu_ptr(works, cpu));
3307
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003308 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003309 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003310 return 0;
3311}
3312
Alan Sterneef6a7d2010-02-12 17:39:21 +09003313/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003314 * execute_in_process_context - reliably execute the routine with user context
3315 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003316 * @ew: guaranteed storage for the execute work structure (must
3317 * be available when the work executes)
3318 *
3319 * Executes the function immediately if process context is available,
3320 * otherwise schedules the function for delayed execution.
3321 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003322 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003323 * 1 - function was scheduled for execution
3324 */
David Howells65f27f32006-11-22 14:55:48 +00003325int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003326{
3327 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003328 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003329 return 0;
3330 }
3331
David Howells65f27f32006-11-22 14:55:48 +00003332 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003333 schedule_work(&ew->work);
3334
3335 return 1;
3336}
3337EXPORT_SYMBOL_GPL(execute_in_process_context);
3338
Tejun Heo7a4e3442013-03-12 11:30:00 -07003339/**
3340 * free_workqueue_attrs - free a workqueue_attrs
3341 * @attrs: workqueue_attrs to free
3342 *
3343 * Undo alloc_workqueue_attrs().
3344 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003345void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003346{
3347 if (attrs) {
3348 free_cpumask_var(attrs->cpumask);
3349 kfree(attrs);
3350 }
3351}
3352
3353/**
3354 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003355 *
3356 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003357 * return it.
3358 *
3359 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003360 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003361struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003362{
3363 struct workqueue_attrs *attrs;
3364
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003365 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003366 if (!attrs)
3367 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003368 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003369 goto fail;
3370
Tejun Heo13e2e552013-04-01 11:23:31 -07003371 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003372 return attrs;
3373fail:
3374 free_workqueue_attrs(attrs);
3375 return NULL;
3376}
3377
Tejun Heo29c91e92013-03-12 11:30:03 -07003378static void copy_workqueue_attrs(struct workqueue_attrs *to,
3379 const struct workqueue_attrs *from)
3380{
3381 to->nice = from->nice;
3382 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003383 /*
3384 * Unlike hash and equality test, this function doesn't ignore
3385 * ->no_numa as it is used for both pool and wq attrs. Instead,
3386 * get_unbound_pool() explicitly clears ->no_numa after copying.
3387 */
3388 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003389}
3390
Tejun Heo29c91e92013-03-12 11:30:03 -07003391/* hash value of the content of @attr */
3392static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3393{
3394 u32 hash = 0;
3395
3396 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003397 hash = jhash(cpumask_bits(attrs->cpumask),
3398 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003399 return hash;
3400}
3401
3402/* content equality test */
3403static bool wqattrs_equal(const struct workqueue_attrs *a,
3404 const struct workqueue_attrs *b)
3405{
3406 if (a->nice != b->nice)
3407 return false;
3408 if (!cpumask_equal(a->cpumask, b->cpumask))
3409 return false;
3410 return true;
3411}
3412
Tejun Heo7a4e3442013-03-12 11:30:00 -07003413/**
3414 * init_worker_pool - initialize a newly zalloc'd worker_pool
3415 * @pool: worker_pool to initialize
3416 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303417 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003418 *
3419 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003420 * inside @pool proper are initialized and put_unbound_pool() can be called
3421 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003422 */
3423static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003424{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003425 raw_spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003426 pool->id = -1;
3427 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003428 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003429 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003430 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003431 INIT_LIST_HEAD(&pool->worklist);
3432 INIT_LIST_HEAD(&pool->idle_list);
3433 hash_init(pool->busy_hash);
3434
Kees Cook32a6c722017-10-16 15:58:25 -07003435 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003436
Kees Cook32a6c722017-10-16 15:58:25 -07003437 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003438
Lai Jiangshanda028462014-05-20 17:46:31 +08003439 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003440
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003441 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003442 INIT_HLIST_NODE(&pool->hash_node);
3443 pool->refcnt = 1;
3444
3445 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003446 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003447 if (!pool->attrs)
3448 return -ENOMEM;
3449 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003450}
3451
Bart Van Assche669de8b2019-02-14 15:00:54 -08003452#ifdef CONFIG_LOCKDEP
3453static void wq_init_lockdep(struct workqueue_struct *wq)
3454{
3455 char *lock_name;
3456
3457 lockdep_register_key(&wq->key);
3458 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3459 if (!lock_name)
3460 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003461
3462 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003463 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3464}
3465
3466static void wq_unregister_lockdep(struct workqueue_struct *wq)
3467{
3468 lockdep_unregister_key(&wq->key);
3469}
3470
3471static void wq_free_lockdep(struct workqueue_struct *wq)
3472{
3473 if (wq->lock_name != wq->name)
3474 kfree(wq->lock_name);
3475}
3476#else
3477static void wq_init_lockdep(struct workqueue_struct *wq)
3478{
3479}
3480
3481static void wq_unregister_lockdep(struct workqueue_struct *wq)
3482{
3483}
3484
3485static void wq_free_lockdep(struct workqueue_struct *wq)
3486{
3487}
3488#endif
3489
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003490static void rcu_free_wq(struct rcu_head *rcu)
3491{
3492 struct workqueue_struct *wq =
3493 container_of(rcu, struct workqueue_struct, rcu);
3494
Bart Van Assche669de8b2019-02-14 15:00:54 -08003495 wq_free_lockdep(wq);
3496
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003497 if (!(wq->flags & WQ_UNBOUND))
3498 free_percpu(wq->cpu_pwqs);
3499 else
3500 free_workqueue_attrs(wq->unbound_attrs);
3501
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003502 kfree(wq);
3503}
3504
Tejun Heo29c91e92013-03-12 11:30:03 -07003505static void rcu_free_pool(struct rcu_head *rcu)
3506{
3507 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3508
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003509 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003510 free_workqueue_attrs(pool->attrs);
3511 kfree(pool);
3512}
3513
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003514/* This returns with the lock held on success (pool manager is inactive). */
3515static bool wq_manager_inactive(struct worker_pool *pool)
3516{
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003517 raw_spin_lock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003518
3519 if (pool->flags & POOL_MANAGER_ACTIVE) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003520 raw_spin_unlock_irq(&pool->lock);
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003521 return false;
3522 }
3523 return true;
3524}
3525
Tejun Heo29c91e92013-03-12 11:30:03 -07003526/**
3527 * put_unbound_pool - put a worker_pool
3528 * @pool: worker_pool to put
3529 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003530 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003531 * safe manner. get_unbound_pool() calls this function on its failure path
3532 * and this function should be able to release pools which went through,
3533 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003534 *
3535 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003536 */
3537static void put_unbound_pool(struct worker_pool *pool)
3538{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003539 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003540 struct worker *worker;
3541
Tejun Heoa892cac2013-04-01 11:23:32 -07003542 lockdep_assert_held(&wq_pool_mutex);
3543
3544 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003545 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003546
3547 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003548 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003549 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003550 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003551
3552 /* release id and unhash */
3553 if (pool->id >= 0)
3554 idr_remove(&worker_pool_idr, pool->id);
3555 hash_del(&pool->hash_node);
3556
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003557 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003558 * Become the manager and destroy all workers. This prevents
3559 * @pool's workers from blocking on attach_mutex. We're the last
3560 * manager and @pool gets freed with the flag set.
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003561 * Because of how wq_manager_inactive() works, we will hold the
3562 * spinlock after a successful wait.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003563 */
Sebastian Andrzej Siewiord8bb65a2020-05-27 21:46:32 +02003564 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3565 TASK_UNINTERRUPTIBLE);
Tejun Heo692b4822017-10-09 08:04:13 -07003566 pool->flags |= POOL_MANAGER_ACTIVE;
3567
Lai Jiangshan1037de32014-05-22 16:44:07 +08003568 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003569 destroy_worker(worker);
3570 WARN_ON(pool->nr_workers || pool->nr_idle);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003571 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003572
Tejun Heo1258fae2018-05-18 08:47:13 -07003573 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003574 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003575 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003576 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003577
3578 if (pool->detach_completion)
3579 wait_for_completion(pool->detach_completion);
3580
Tejun Heo29c91e92013-03-12 11:30:03 -07003581 /* shut down the timers */
3582 del_timer_sync(&pool->idle_timer);
3583 del_timer_sync(&pool->mayday_timer);
3584
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003585 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003586 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003587}
3588
3589/**
3590 * get_unbound_pool - get a worker_pool with the specified attributes
3591 * @attrs: the attributes of the worker_pool to get
3592 *
3593 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3594 * reference count and return it. If there already is a matching
3595 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003596 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003597 *
3598 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003599 *
3600 * Return: On success, a worker_pool with the same attributes as @attrs.
3601 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003602 */
3603static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3604{
Tejun Heo29c91e92013-03-12 11:30:03 -07003605 u32 hash = wqattrs_hash(attrs);
3606 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003607 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003608 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003609
Tejun Heoa892cac2013-04-01 11:23:32 -07003610 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003611
3612 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003613 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3614 if (wqattrs_equal(pool->attrs, attrs)) {
3615 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003616 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003617 }
3618 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003619
Xunlei Pange22735842015-10-09 11:53:12 +08003620 /* if cpumask is contained inside a NUMA node, we belong to that node */
3621 if (wq_numa_enabled) {
3622 for_each_node(node) {
3623 if (cpumask_subset(attrs->cpumask,
3624 wq_numa_possible_cpumask[node])) {
3625 target_node = node;
3626 break;
3627 }
3628 }
3629 }
3630
Tejun Heo29c91e92013-03-12 11:30:03 -07003631 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003632 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003633 if (!pool || init_worker_pool(pool) < 0)
3634 goto fail;
3635
Tejun Heo8864b4e2013-03-12 11:30:04 -07003636 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003637 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003638 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003639
Shaohua Li2865a8f2013-08-01 09:56:36 +08003640 /*
3641 * no_numa isn't a worker_pool attribute, always clear it. See
3642 * 'struct workqueue_attrs' comments for detail.
3643 */
3644 pool->attrs->no_numa = false;
3645
Tejun Heo29c91e92013-03-12 11:30:03 -07003646 if (worker_pool_assign_id(pool) < 0)
3647 goto fail;
3648
3649 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003650 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003651 goto fail;
3652
Tejun Heo29c91e92013-03-12 11:30:03 -07003653 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003654 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003655
Tejun Heo29c91e92013-03-12 11:30:03 -07003656 return pool;
3657fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003658 if (pool)
3659 put_unbound_pool(pool);
3660 return NULL;
3661}
3662
Tejun Heo8864b4e2013-03-12 11:30:04 -07003663static void rcu_free_pwq(struct rcu_head *rcu)
3664{
3665 kmem_cache_free(pwq_cache,
3666 container_of(rcu, struct pool_workqueue, rcu));
3667}
3668
3669/*
3670 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3671 * and needs to be destroyed.
3672 */
3673static void pwq_unbound_release_workfn(struct work_struct *work)
3674{
3675 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3676 unbound_release_work);
3677 struct workqueue_struct *wq = pwq->wq;
3678 struct worker_pool *pool = pwq->pool;
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003679 bool is_last = false;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003680
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003681 /*
3682 * when @pwq is not linked, it doesn't hold any reference to the
3683 * @wq, and @wq is invalid to access.
3684 */
3685 if (!list_empty(&pwq->pwqs_node)) {
3686 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3687 return;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003688
Yang Yingliangb42b0bd2021-07-14 17:19:33 +08003689 mutex_lock(&wq->mutex);
3690 list_del_rcu(&pwq->pwqs_node);
3691 is_last = list_empty(&wq->pwqs);
3692 mutex_unlock(&wq->mutex);
3693 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003694
Tejun Heoa892cac2013-04-01 11:23:32 -07003695 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003696 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003697 mutex_unlock(&wq_pool_mutex);
3698
Paul E. McKenney25b00772018-11-06 19:18:45 -08003699 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003700
3701 /*
3702 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003703 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003704 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003705 if (is_last) {
3706 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003707 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003708 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003709}
3710
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003711/**
Tejun Heo699ce092013-03-13 16:51:35 -07003712 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003713 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003714 *
Tejun Heo699ce092013-03-13 16:51:35 -07003715 * If @pwq isn't freezing, set @pwq->max_active to the associated
3716 * workqueue's saved_max_active and activate delayed work items
3717 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003718 */
Tejun Heo699ce092013-03-13 16:51:35 -07003719static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003720{
Tejun Heo699ce092013-03-13 16:51:35 -07003721 struct workqueue_struct *wq = pwq->wq;
3722 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003723 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003724
Tejun Heo699ce092013-03-13 16:51:35 -07003725 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003726 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003727
3728 /* fast exit for non-freezable wqs */
3729 if (!freezable && pwq->max_active == wq->saved_max_active)
3730 return;
3731
Tejun Heo3347fa02016-09-16 15:49:32 -04003732 /* this function can be called during early boot w/ irq disabled */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003733 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003734
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003735 /*
3736 * During [un]freezing, the caller is responsible for ensuring that
3737 * this function is called at least once after @workqueue_freezing
3738 * is updated and visible.
3739 */
3740 if (!freezable || !workqueue_freezing) {
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003741 bool kick = false;
3742
Tejun Heo699ce092013-03-13 16:51:35 -07003743 pwq->max_active = wq->saved_max_active;
3744
3745 while (!list_empty(&pwq->delayed_works) &&
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003746 pwq->nr_active < pwq->max_active) {
Tejun Heo699ce092013-03-13 16:51:35 -07003747 pwq_activate_first_delayed(pwq);
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003748 kick = true;
3749 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003750
3751 /*
3752 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003753 * max_active is bumped. In realtime scenarios, always kicking a
3754 * worker will cause interference on the isolated cpu cores, so
3755 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003756 */
Yunfeng Ye01341fbd2020-11-19 14:21:25 +08003757 if (kick)
3758 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003759 } else {
3760 pwq->max_active = 0;
3761 }
3762
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02003763 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003764}
3765
Cai Huoqing67dc8322021-07-31 08:01:29 +08003766/* initialize newly allocated @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003767static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3768 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003769{
3770 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3771
Tejun Heoe50aba92013-04-01 11:23:35 -07003772 memset(pwq, 0, sizeof(*pwq));
3773
Tejun Heod2c1d402013-03-12 11:30:04 -07003774 pwq->pool = pool;
3775 pwq->wq = wq;
3776 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003777 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003778 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003779 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003780 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003781 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003782}
Tejun Heod2c1d402013-03-12 11:30:04 -07003783
Tejun Heof147f292013-04-01 11:23:35 -07003784/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003785static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003786{
3787 struct workqueue_struct *wq = pwq->wq;
3788
3789 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003790
Tejun Heo1befcf32013-04-01 11:23:35 -07003791 /* may be called multiple times, ignore if already linked */
3792 if (!list_empty(&pwq->pwqs_node))
3793 return;
3794
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003795 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003796 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003797
3798 /* sync max_active to the current setting */
3799 pwq_adjust_max_active(pwq);
3800
3801 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003802 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003803}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003804
Tejun Heof147f292013-04-01 11:23:35 -07003805/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3806static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3807 const struct workqueue_attrs *attrs)
3808{
3809 struct worker_pool *pool;
3810 struct pool_workqueue *pwq;
3811
3812 lockdep_assert_held(&wq_pool_mutex);
3813
3814 pool = get_unbound_pool(attrs);
3815 if (!pool)
3816 return NULL;
3817
Tejun Heoe50aba92013-04-01 11:23:35 -07003818 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003819 if (!pwq) {
3820 put_unbound_pool(pool);
3821 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003822 }
Tejun Heo6029a912013-04-01 11:23:34 -07003823
Tejun Heof147f292013-04-01 11:23:35 -07003824 init_pwq(pwq, wq, pool);
3825 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003826}
3827
Tejun Heo4c16bd32013-04-01 11:23:36 -07003828/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003829 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003830 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003831 * @node: the target NUMA node
3832 * @cpu_going_down: if >= 0, the CPU to consider as offline
3833 * @cpumask: outarg, the resulting cpumask
3834 *
3835 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3836 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003837 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003838 *
3839 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3840 * enabled and @node has online CPUs requested by @attrs, the returned
3841 * cpumask is the intersection of the possible CPUs of @node and
3842 * @attrs->cpumask.
3843 *
3844 * The caller is responsible for ensuring that the cpumask of @node stays
3845 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003846 *
3847 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3848 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003849 */
3850static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3851 int cpu_going_down, cpumask_t *cpumask)
3852{
Tejun Heod55262c2013-04-01 11:23:38 -07003853 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003854 goto use_dfl;
3855
3856 /* does @node have any online CPUs @attrs wants? */
3857 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3858 if (cpu_going_down >= 0)
3859 cpumask_clear_cpu(cpu_going_down, cpumask);
3860
3861 if (cpumask_empty(cpumask))
3862 goto use_dfl;
3863
3864 /* yeap, return possible CPUs in @node that @attrs wants */
3865 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003866
3867 if (cpumask_empty(cpumask)) {
3868 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3869 "possible intersect\n");
3870 return false;
3871 }
3872
Tejun Heo4c16bd32013-04-01 11:23:36 -07003873 return !cpumask_equal(cpumask, attrs->cpumask);
3874
3875use_dfl:
3876 cpumask_copy(cpumask, attrs->cpumask);
3877 return false;
3878}
3879
Tejun Heo1befcf32013-04-01 11:23:35 -07003880/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3881static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3882 int node,
3883 struct pool_workqueue *pwq)
3884{
3885 struct pool_workqueue *old_pwq;
3886
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003887 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003888 lockdep_assert_held(&wq->mutex);
3889
3890 /* link_pwq() can handle duplicate calls */
3891 link_pwq(pwq);
3892
3893 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3894 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3895 return old_pwq;
3896}
3897
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003898/* context to store the prepared attrs & pwqs before applying */
3899struct apply_wqattrs_ctx {
3900 struct workqueue_struct *wq; /* target workqueue */
3901 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003902 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003903 struct pool_workqueue *dfl_pwq;
3904 struct pool_workqueue *pwq_tbl[];
3905};
3906
3907/* free the resources after success or abort */
3908static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3909{
3910 if (ctx) {
3911 int node;
3912
3913 for_each_node(node)
3914 put_pwq_unlocked(ctx->pwq_tbl[node]);
3915 put_pwq_unlocked(ctx->dfl_pwq);
3916
3917 free_workqueue_attrs(ctx->attrs);
3918
3919 kfree(ctx);
3920 }
3921}
3922
3923/* allocate the attrs and pwqs for later installation */
3924static struct apply_wqattrs_ctx *
3925apply_wqattrs_prepare(struct workqueue_struct *wq,
3926 const struct workqueue_attrs *attrs)
3927{
3928 struct apply_wqattrs_ctx *ctx;
3929 struct workqueue_attrs *new_attrs, *tmp_attrs;
3930 int node;
3931
3932 lockdep_assert_held(&wq_pool_mutex);
3933
Kees Cookacafe7e2018-05-08 13:45:50 -07003934 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003935
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003936 new_attrs = alloc_workqueue_attrs();
3937 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003938 if (!ctx || !new_attrs || !tmp_attrs)
3939 goto out_free;
3940
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003941 /*
3942 * Calculate the attrs of the default pwq.
3943 * If the user configured cpumask doesn't overlap with the
3944 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3945 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003946 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003947 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003948 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3949 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003950
3951 /*
3952 * We may create multiple pwqs with differing cpumasks. Make a
3953 * copy of @new_attrs which will be modified and used to obtain
3954 * pools.
3955 */
3956 copy_workqueue_attrs(tmp_attrs, new_attrs);
3957
3958 /*
3959 * If something goes wrong during CPU up/down, we'll fall back to
3960 * the default pwq covering whole @attrs->cpumask. Always create
3961 * it even if we don't use it immediately.
3962 */
3963 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3964 if (!ctx->dfl_pwq)
3965 goto out_free;
3966
3967 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003968 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003969 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3970 if (!ctx->pwq_tbl[node])
3971 goto out_free;
3972 } else {
3973 ctx->dfl_pwq->refcnt++;
3974 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3975 }
3976 }
3977
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003978 /* save the user configured attrs and sanitize it. */
3979 copy_workqueue_attrs(new_attrs, attrs);
3980 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003981 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003982
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003983 ctx->wq = wq;
3984 free_workqueue_attrs(tmp_attrs);
3985 return ctx;
3986
3987out_free:
3988 free_workqueue_attrs(tmp_attrs);
3989 free_workqueue_attrs(new_attrs);
3990 apply_wqattrs_cleanup(ctx);
3991 return NULL;
3992}
3993
3994/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3995static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3996{
3997 int node;
3998
3999 /* all pwqs have been created successfully, let's install'em */
4000 mutex_lock(&ctx->wq->mutex);
4001
4002 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
4003
4004 /* save the previous pwq and install the new one */
4005 for_each_node(node)
4006 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4007 ctx->pwq_tbl[node]);
4008
4009 /* @dfl_pwq might not have been used, ensure it's linked */
4010 link_pwq(ctx->dfl_pwq);
4011 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
4012
4013 mutex_unlock(&ctx->wq->mutex);
4014}
4015
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004016static void apply_wqattrs_lock(void)
4017{
4018 /* CPUs should stay stable across pwq creations and installations */
4019 get_online_cpus();
4020 mutex_lock(&wq_pool_mutex);
4021}
4022
4023static void apply_wqattrs_unlock(void)
4024{
4025 mutex_unlock(&wq_pool_mutex);
4026 put_online_cpus();
4027}
4028
4029static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4030 const struct workqueue_attrs *attrs)
4031{
4032 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004033
4034 /* only unbound workqueues can change attributes */
4035 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4036 return -EINVAL;
4037
4038 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004039 if (!list_empty(&wq->pwqs)) {
4040 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4041 return -EINVAL;
4042
4043 wq->flags &= ~__WQ_ORDERED;
4044 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004045
4046 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004047 if (!ctx)
4048 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004049
4050 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004051 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004052 apply_wqattrs_cleanup(ctx);
4053
wanghaibin62011712016-01-07 20:38:59 +08004054 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004055}
4056
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004057/**
4058 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4059 * @wq: the target workqueue
4060 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4061 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004062 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4063 * machines, this function maps a separate pwq to each NUMA node with
4064 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4065 * NUMA node it was issued on. Older pwqs are released as in-flight work
4066 * items finish. Note that a work item which repeatedly requeues itself
4067 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004068 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004069 * Performs GFP_KERNEL allocations.
4070 *
Daniel Jordan509b3202019-09-05 21:40:23 -04004071 * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus().
4072 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004073 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004074 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004075int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004076 const struct workqueue_attrs *attrs)
4077{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004078 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004079
Daniel Jordan509b3202019-09-05 21:40:23 -04004080 lockdep_assert_cpus_held();
4081
4082 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004083 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004084 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004085
Tejun Heo48621252013-04-01 11:23:31 -07004086 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004087}
4088
Tejun Heo4c16bd32013-04-01 11:23:36 -07004089/**
4090 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4091 * @wq: the target workqueue
4092 * @cpu: the CPU coming up or going down
4093 * @online: whether @cpu is coming up or going down
4094 *
4095 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4096 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4097 * @wq accordingly.
4098 *
4099 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4100 * falls back to @wq->dfl_pwq which may not be optimal but is always
4101 * correct.
4102 *
4103 * Note that when the last allowed CPU of a NUMA node goes offline for a
4104 * workqueue with a cpumask spanning multiple nodes, the workers which were
4105 * already executing the work items for the workqueue will lose their CPU
4106 * affinity and may execute on any CPU. This is similar to how per-cpu
4107 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4108 * affinity, it's the user's responsibility to flush the work item from
4109 * CPU_DOWN_PREPARE.
4110 */
4111static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4112 bool online)
4113{
4114 int node = cpu_to_node(cpu);
4115 int cpu_off = online ? -1 : cpu;
4116 struct pool_workqueue *old_pwq = NULL, *pwq;
4117 struct workqueue_attrs *target_attrs;
4118 cpumask_t *cpumask;
4119
4120 lockdep_assert_held(&wq_pool_mutex);
4121
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004122 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4123 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004124 return;
4125
4126 /*
4127 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4128 * Let's use a preallocated one. The following buf is protected by
4129 * CPU hotplug exclusion.
4130 */
4131 target_attrs = wq_update_unbound_numa_attrs_buf;
4132 cpumask = target_attrs->cpumask;
4133
Tejun Heo4c16bd32013-04-01 11:23:36 -07004134 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4135 pwq = unbound_pwq_by_node(wq, node);
4136
4137 /*
4138 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004139 * different from the default pwq's, we need to compare it to @pwq's
4140 * and create a new one if they don't match. If the target cpumask
4141 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004142 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004143 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004144 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004145 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004146 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004147 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004148 }
4149
Tejun Heo4c16bd32013-04-01 11:23:36 -07004150 /* create a new pwq */
4151 pwq = alloc_unbound_pwq(wq, target_attrs);
4152 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004153 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4154 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004155 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004156 }
4157
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004158 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004159 mutex_lock(&wq->mutex);
4160 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4161 goto out_unlock;
4162
4163use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004164 mutex_lock(&wq->mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004165 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004166 get_pwq(wq->dfl_pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004167 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004168 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4169out_unlock:
4170 mutex_unlock(&wq->mutex);
4171 put_pwq_unlocked(old_pwq);
4172}
4173
Tejun Heo30cdf2492013-03-12 11:29:57 -07004174static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004175{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004176 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004177 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004178
Tejun Heo30cdf2492013-03-12 11:29:57 -07004179 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004180 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4181 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004182 return -ENOMEM;
4183
4184 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004185 struct pool_workqueue *pwq =
4186 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004187 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004188 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004189
Tejun Heof147f292013-04-01 11:23:35 -07004190 init_pwq(pwq, wq, &cpu_pools[highpri]);
4191
4192 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004193 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004194 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004195 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004196 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004197 }
4198
4199 get_online_cpus();
4200 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004201 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4202 /* there should only be single pwq for ordering guarantee */
4203 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4204 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4205 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004206 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004207 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004208 }
Daniel Jordan509b3202019-09-05 21:40:23 -04004209 put_online_cpus();
4210
4211 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004212}
4213
Tejun Heof3421792010-07-02 10:03:51 +02004214static int wq_clamp_max_active(int max_active, unsigned int flags,
4215 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004216{
Tejun Heof3421792010-07-02 10:03:51 +02004217 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4218
4219 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004220 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4221 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004222
Tejun Heof3421792010-07-02 10:03:51 +02004223 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004224}
4225
Tejun Heo983c7512018-01-08 05:38:32 -08004226/*
4227 * Workqueues which may be used during memory reclaim should have a rescuer
4228 * to guarantee forward progress.
4229 */
4230static int init_rescuer(struct workqueue_struct *wq)
4231{
4232 struct worker *rescuer;
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004233 int ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004234
4235 if (!(wq->flags & WQ_MEM_RECLAIM))
4236 return 0;
4237
4238 rescuer = alloc_worker(NUMA_NO_NODE);
4239 if (!rescuer)
4240 return -ENOMEM;
4241
4242 rescuer->rescue_wq = wq;
4243 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
Sean Fuf187b692020-04-29 12:04:13 +08004244 if (IS_ERR(rescuer->task)) {
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004245 ret = PTR_ERR(rescuer->task);
Tejun Heo983c7512018-01-08 05:38:32 -08004246 kfree(rescuer);
Dan Carpenterb92b36e2020-05-08 18:07:40 +03004247 return ret;
Tejun Heo983c7512018-01-08 05:38:32 -08004248 }
4249
4250 wq->rescuer = rescuer;
4251 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4252 wake_up_process(rescuer->task);
4253
4254 return 0;
4255}
4256
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004257__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004258struct workqueue_struct *alloc_workqueue(const char *fmt,
4259 unsigned int flags,
4260 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004261{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004262 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004263 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004264 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004265 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004266
Tejun Heo5c0338c2017-07-18 18:41:52 -04004267 /*
4268 * Unbound && max_active == 1 used to imply ordered, which is no
4269 * longer the case on NUMA machines due to per-node pools. While
4270 * alloc_ordered_workqueue() is the right way to create an ordered
4271 * workqueue, keep the previous behavior to avoid subtle breakages
4272 * on NUMA.
4273 */
4274 if ((flags & WQ_UNBOUND) && max_active == 1)
4275 flags |= __WQ_ORDERED;
4276
Viresh Kumarcee22a12013-04-08 16:45:40 +05304277 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4278 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4279 flags |= WQ_UNBOUND;
4280
Tejun Heoecf68812013-04-01 11:23:34 -07004281 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004282 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004283 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004284
4285 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004286 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004287 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004288
Tejun Heo6029a912013-04-01 11:23:34 -07004289 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004290 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004291 if (!wq->unbound_attrs)
4292 goto err_free_wq;
4293 }
4294
Bart Van Assche669de8b2019-02-14 15:00:54 -08004295 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004296 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004297 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004298
Tejun Heod320c032010-06-29 10:07:14 +02004299 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004300 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004301
Tejun Heob196be82012-01-10 15:11:35 -08004302 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004303 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004304 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004305 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004306 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004307 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004308 INIT_LIST_HEAD(&wq->flusher_queue);
4309 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004310 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004311
Bart Van Assche669de8b2019-02-14 15:00:54 -08004312 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004313 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004314
Tejun Heo30cdf2492013-03-12 11:29:57 -07004315 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004316 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004317
Tejun Heo40c17f72018-01-08 05:38:37 -08004318 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004319 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004320
Tejun Heo226223a2013-03-12 11:30:05 -07004321 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4322 goto err_destroy;
4323
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004324 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004325 * wq_pool_mutex protects global freeze state and workqueues list.
4326 * Grab it, adjust max_active and add the new @wq to workqueues
4327 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004328 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004329 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004330
Lai Jiangshana357fc02013-03-25 16:57:19 -07004331 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004332 for_each_pwq(pwq, wq)
4333 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004334 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004335
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004336 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004337
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004338 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004339
Oleg Nesterov3af244332007-05-09 02:34:09 -07004340 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004341
Bart Van Assche82efcab2019-03-11 16:02:55 -07004342err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004343 wq_unregister_lockdep(wq);
4344 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004345err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004346 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004347 kfree(wq);
4348 return NULL;
4349err_destroy:
4350 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004351 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004352}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004353EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004354
Tejun Heoc29eb852019-09-23 11:08:58 -07004355static bool pwq_busy(struct pool_workqueue *pwq)
4356{
4357 int i;
4358
4359 for (i = 0; i < WORK_NR_COLORS; i++)
4360 if (pwq->nr_in_flight[i])
4361 return true;
4362
4363 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4364 return true;
4365 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4366 return true;
4367
4368 return false;
4369}
4370
Oleg Nesterov3af244332007-05-09 02:34:09 -07004371/**
4372 * destroy_workqueue - safely terminate a workqueue
4373 * @wq: target workqueue
4374 *
4375 * Safely destroy a workqueue. All work currently pending will be done first.
4376 */
4377void destroy_workqueue(struct workqueue_struct *wq)
4378{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004379 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004380 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004381
Tejun Heodef98c82019-09-18 18:43:40 -07004382 /*
4383 * Remove it from sysfs first so that sanity check failure doesn't
4384 * lead to sysfs name conflicts.
4385 */
4386 workqueue_sysfs_unregister(wq);
4387
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004388 /* drain it before proceeding with destruction */
4389 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004390
Tejun Heodef98c82019-09-18 18:43:40 -07004391 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4392 if (wq->rescuer) {
4393 struct worker *rescuer = wq->rescuer;
4394
4395 /* this prevents new queueing */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004396 raw_spin_lock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004397 wq->rescuer = NULL;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004398 raw_spin_unlock_irq(&wq_mayday_lock);
Tejun Heodef98c82019-09-18 18:43:40 -07004399
4400 /* rescuer will empty maydays list before exiting */
4401 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004402 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004403 }
4404
Tejun Heoc29eb852019-09-23 11:08:58 -07004405 /*
4406 * Sanity checks - grab all the locks so that we wait for all
4407 * in-flight operations which may do put_pwq().
4408 */
4409 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004410 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004411 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004412 raw_spin_lock_irq(&pwq->pool->lock);
Tejun Heoc29eb852019-09-23 11:08:58 -07004413 if (WARN_ON(pwq_busy(pwq))) {
Kefeng Wang1d9a6152019-11-28 08:47:49 +08004414 pr_warn("%s: %s has the following busy pwq\n",
4415 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004416 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004417 raw_spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004418 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004419 mutex_unlock(&wq_pool_mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004420 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004421 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004422 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004423 raw_spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004424 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004425 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004426
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004427 /*
4428 * wq list is used to freeze wq, remove from list after
4429 * flushing is complete in case freeze races us.
4430 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004431 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004432 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004433
Tejun Heo8864b4e2013-03-12 11:30:04 -07004434 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004435 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004436 /*
4437 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004438 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004439 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004440 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004441 } else {
4442 /*
4443 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004444 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4445 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004446 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004447 for_each_node(node) {
4448 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4449 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4450 put_pwq_unlocked(pwq);
4451 }
4452
4453 /*
4454 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4455 * put. Don't access it afterwards.
4456 */
4457 pwq = wq->dfl_pwq;
4458 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004459 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004460 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004461}
4462EXPORT_SYMBOL_GPL(destroy_workqueue);
4463
Tejun Heodcd989c2010-06-29 10:07:14 +02004464/**
4465 * workqueue_set_max_active - adjust max_active of a workqueue
4466 * @wq: target workqueue
4467 * @max_active: new max_active value.
4468 *
4469 * Set max_active of @wq to @max_active.
4470 *
4471 * CONTEXT:
4472 * Don't call from IRQ context.
4473 */
4474void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4475{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004476 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004477
Tejun Heo8719dce2013-03-12 11:30:04 -07004478 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004479 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004480 return;
4481
Tejun Heof3421792010-07-02 10:03:51 +02004482 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004483
Lai Jiangshana357fc02013-03-25 16:57:19 -07004484 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004485
Tejun Heo0a94efb2017-07-23 08:36:15 -04004486 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004487 wq->saved_max_active = max_active;
4488
Tejun Heo699ce092013-03-13 16:51:35 -07004489 for_each_pwq(pwq, wq)
4490 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004491
Lai Jiangshana357fc02013-03-25 16:57:19 -07004492 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004493}
4494EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4495
4496/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004497 * current_work - retrieve %current task's work struct
4498 *
4499 * Determine if %current task is a workqueue worker and what it's working on.
4500 * Useful to find out the context that the %current task is running in.
4501 *
4502 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4503 */
4504struct work_struct *current_work(void)
4505{
4506 struct worker *worker = current_wq_worker();
4507
4508 return worker ? worker->current_work : NULL;
4509}
4510EXPORT_SYMBOL(current_work);
4511
4512/**
Tejun Heoe62676162013-03-12 17:41:37 -07004513 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4514 *
4515 * Determine whether %current is a workqueue rescuer. Can be used from
4516 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004517 *
4518 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004519 */
4520bool current_is_workqueue_rescuer(void)
4521{
4522 struct worker *worker = current_wq_worker();
4523
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004524 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004525}
4526
4527/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004528 * workqueue_congested - test whether a workqueue is congested
4529 * @cpu: CPU in question
4530 * @wq: target workqueue
4531 *
4532 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4533 * no synchronization around this function and the test result is
4534 * unreliable and only useful as advisory hints or for debugging.
4535 *
Tejun Heod3251852013-05-10 11:10:17 -07004536 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4537 * Note that both per-cpu and unbound workqueues may be associated with
4538 * multiple pool_workqueues which have separate congested states. A
4539 * workqueue being congested on one CPU doesn't mean the workqueue is also
4540 * contested on other CPUs / NUMA nodes.
4541 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004542 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004543 * %true if congested, %false otherwise.
4544 */
Tejun Heod84ff052013-03-12 11:29:59 -07004545bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004546{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004547 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004548 bool ret;
4549
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004550 rcu_read_lock();
4551 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004552
Tejun Heod3251852013-05-10 11:10:17 -07004553 if (cpu == WORK_CPU_UNBOUND)
4554 cpu = smp_processor_id();
4555
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004556 if (!(wq->flags & WQ_UNBOUND))
4557 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4558 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004559 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004560
Tejun Heo76af4d92013-03-12 11:30:00 -07004561 ret = !list_empty(&pwq->delayed_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004562 preempt_enable();
4563 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004564
4565 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004566}
4567EXPORT_SYMBOL_GPL(workqueue_congested);
4568
4569/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004570 * work_busy - test whether a work is currently pending or running
4571 * @work: the work to be tested
4572 *
4573 * Test whether @work is currently pending or running. There is no
4574 * synchronization around this function and the test result is
4575 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004576 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004577 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004578 * OR'd bitmask of WORK_BUSY_* bits.
4579 */
4580unsigned int work_busy(struct work_struct *work)
4581{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004582 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004583 unsigned long flags;
4584 unsigned int ret = 0;
4585
Tejun Heodcd989c2010-06-29 10:07:14 +02004586 if (work_pending(work))
4587 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004588
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004589 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004590 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004591 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004592 raw_spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004593 if (find_worker_executing_work(pool, work))
4594 ret |= WORK_BUSY_RUNNING;
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004595 raw_spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004596 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004597 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004598
4599 return ret;
4600}
4601EXPORT_SYMBOL_GPL(work_busy);
4602
Tejun Heo3d1cb202013-04-30 15:27:22 -07004603/**
4604 * set_worker_desc - set description for the current work item
4605 * @fmt: printf-style format string
4606 * @...: arguments for the format string
4607 *
4608 * This function can be called by a running work function to describe what
4609 * the work item is about. If the worker task gets dumped, this
4610 * information will be printed out together to help debugging. The
4611 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4612 */
4613void set_worker_desc(const char *fmt, ...)
4614{
4615 struct worker *worker = current_wq_worker();
4616 va_list args;
4617
4618 if (worker) {
4619 va_start(args, fmt);
4620 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4621 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004622 }
4623}
Steffen Maier5c750d52018-05-17 19:14:57 +02004624EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004625
4626/**
4627 * print_worker_info - print out worker information and description
4628 * @log_lvl: the log level to use when printing
4629 * @task: target task
4630 *
4631 * If @task is a worker and currently executing a work item, print out the
4632 * name of the workqueue being serviced and worker description set with
4633 * set_worker_desc() by the currently executing work item.
4634 *
4635 * This function can be safely called on any task as long as the
4636 * task_struct itself is accessible. While safe, this function isn't
4637 * synchronized and may print out mixups or garbages of limited length.
4638 */
4639void print_worker_info(const char *log_lvl, struct task_struct *task)
4640{
4641 work_func_t *fn = NULL;
4642 char name[WQ_NAME_LEN] = { };
4643 char desc[WORKER_DESC_LEN] = { };
4644 struct pool_workqueue *pwq = NULL;
4645 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004646 struct worker *worker;
4647
4648 if (!(task->flags & PF_WQ_WORKER))
4649 return;
4650
4651 /*
4652 * This function is called without any synchronization and @task
4653 * could be in any state. Be careful with dereferences.
4654 */
Petr Mladeke7005912016-10-11 13:55:17 -07004655 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004656
4657 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004658 * Carefully copy the associated workqueue's workfn, name and desc.
4659 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004660 */
Christoph Hellwigfe557312020-06-17 09:37:53 +02004661 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4662 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4663 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4664 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4665 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004666
4667 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004668 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004669 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004670 pr_cont(" (%s)", desc);
4671 pr_cont("\n");
4672 }
4673}
4674
Tejun Heo3494fc32015-03-09 09:22:28 -04004675static void pr_cont_pool_info(struct worker_pool *pool)
4676{
4677 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4678 if (pool->node != NUMA_NO_NODE)
4679 pr_cont(" node=%d", pool->node);
4680 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4681}
4682
4683static void pr_cont_work(bool comma, struct work_struct *work)
4684{
4685 if (work->func == wq_barrier_func) {
4686 struct wq_barrier *barr;
4687
4688 barr = container_of(work, struct wq_barrier, work);
4689
4690 pr_cont("%s BAR(%d)", comma ? "," : "",
4691 task_pid_nr(barr->task));
4692 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004693 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004694 }
4695}
4696
4697static void show_pwq(struct pool_workqueue *pwq)
4698{
4699 struct worker_pool *pool = pwq->pool;
4700 struct work_struct *work;
4701 struct worker *worker;
4702 bool has_in_flight = false, has_pending = false;
4703 int bkt;
4704
4705 pr_info(" pwq %d:", pool->id);
4706 pr_cont_pool_info(pool);
4707
Tejun Heoe66b39a2019-09-25 06:59:15 -07004708 pr_cont(" active=%d/%d refcnt=%d%s\n",
4709 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004710 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4711
4712 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4713 if (worker->current_pwq == pwq) {
4714 has_in_flight = true;
4715 break;
4716 }
4717 }
4718 if (has_in_flight) {
4719 bool comma = false;
4720
4721 pr_info(" in-flight:");
4722 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4723 if (worker->current_pwq != pwq)
4724 continue;
4725
Sakari Ailusd75f7732019-03-25 21:32:28 +02004726 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004727 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004728 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004729 worker->current_func);
4730 list_for_each_entry(work, &worker->scheduled, entry)
4731 pr_cont_work(false, work);
4732 comma = true;
4733 }
4734 pr_cont("\n");
4735 }
4736
4737 list_for_each_entry(work, &pool->worklist, entry) {
4738 if (get_work_pwq(work) == pwq) {
4739 has_pending = true;
4740 break;
4741 }
4742 }
4743 if (has_pending) {
4744 bool comma = false;
4745
4746 pr_info(" pending:");
4747 list_for_each_entry(work, &pool->worklist, entry) {
4748 if (get_work_pwq(work) != pwq)
4749 continue;
4750
4751 pr_cont_work(comma, work);
4752 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4753 }
4754 pr_cont("\n");
4755 }
4756
4757 if (!list_empty(&pwq->delayed_works)) {
4758 bool comma = false;
4759
4760 pr_info(" delayed:");
4761 list_for_each_entry(work, &pwq->delayed_works, entry) {
4762 pr_cont_work(comma, work);
4763 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4764 }
4765 pr_cont("\n");
4766 }
4767}
4768
4769/**
4770 * show_workqueue_state - dump workqueue state
4771 *
Roger Lu7b776af2016-07-01 11:05:02 +08004772 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4773 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004774 */
4775void show_workqueue_state(void)
4776{
4777 struct workqueue_struct *wq;
4778 struct worker_pool *pool;
4779 unsigned long flags;
4780 int pi;
4781
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004782 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004783
4784 pr_info("Showing busy workqueues and worker pools:\n");
4785
4786 list_for_each_entry_rcu(wq, &workqueues, list) {
4787 struct pool_workqueue *pwq;
4788 bool idle = true;
4789
4790 for_each_pwq(pwq, wq) {
4791 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4792 idle = false;
4793 break;
4794 }
4795 }
4796 if (idle)
4797 continue;
4798
4799 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4800
4801 for_each_pwq(pwq, wq) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004802 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004803 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4804 show_pwq(pwq);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004805 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004806 /*
4807 * We could be printing a lot from atomic context, e.g.
4808 * sysrq-t -> show_workqueue_state(). Avoid triggering
4809 * hard lockup.
4810 */
4811 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004812 }
4813 }
4814
4815 for_each_pool(pool, pi) {
4816 struct worker *worker;
4817 bool first = true;
4818
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004819 raw_spin_lock_irqsave(&pool->lock, flags);
Tejun Heo3494fc32015-03-09 09:22:28 -04004820 if (pool->nr_workers == pool->nr_idle)
4821 goto next_pool;
4822
4823 pr_info("pool %d:", pool->id);
4824 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004825 pr_cont(" hung=%us workers=%d",
4826 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4827 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004828 if (pool->manager)
4829 pr_cont(" manager: %d",
4830 task_pid_nr(pool->manager->task));
4831 list_for_each_entry(worker, &pool->idle_list, entry) {
4832 pr_cont(" %s%d", first ? "idle: " : "",
4833 task_pid_nr(worker->task));
4834 first = false;
4835 }
4836 pr_cont("\n");
4837 next_pool:
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004838 raw_spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004839 /*
4840 * We could be printing a lot from atomic context, e.g.
4841 * sysrq-t -> show_workqueue_state(). Avoid triggering
4842 * hard lockup.
4843 */
4844 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004845 }
4846
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004847 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004848}
4849
Tejun Heo6b598082018-05-18 08:47:13 -07004850/* used to show worker information through /proc/PID/{comm,stat,status} */
4851void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4852{
Tejun Heo6b598082018-05-18 08:47:13 -07004853 int off;
4854
4855 /* always show the actual comm */
4856 off = strscpy(buf, task->comm, size);
4857 if (off < 0)
4858 return;
4859
Tejun Heo197f6ac2018-05-21 08:04:35 -07004860 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004861 mutex_lock(&wq_pool_attach_mutex);
4862
Tejun Heo197f6ac2018-05-21 08:04:35 -07004863 if (task->flags & PF_WQ_WORKER) {
4864 struct worker *worker = kthread_data(task);
4865 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004866
Tejun Heo197f6ac2018-05-21 08:04:35 -07004867 if (pool) {
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004868 raw_spin_lock_irq(&pool->lock);
Tejun Heo197f6ac2018-05-21 08:04:35 -07004869 /*
4870 * ->desc tracks information (wq name or
4871 * set_worker_desc()) for the latest execution. If
4872 * current, prepend '+', otherwise '-'.
4873 */
4874 if (worker->desc[0] != '\0') {
4875 if (worker->current_work)
4876 scnprintf(buf + off, size - off, "+%s",
4877 worker->desc);
4878 else
4879 scnprintf(buf + off, size - off, "-%s",
4880 worker->desc);
4881 }
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004882 raw_spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004883 }
Tejun Heo6b598082018-05-18 08:47:13 -07004884 }
4885
4886 mutex_unlock(&wq_pool_attach_mutex);
4887}
4888
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004889#ifdef CONFIG_SMP
4890
Tejun Heodb7bccf2010-06-29 10:07:12 +02004891/*
4892 * CPU hotplug.
4893 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004894 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004895 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004896 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004897 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004898 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004899 * blocked draining impractical.
4900 *
Tejun Heo24647572013-01-24 11:01:33 -08004901 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004902 * running as an unbound one and allowing it to be reattached later if the
4903 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004904 */
4905
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004906static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004907{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004908 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004909 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004910
Tejun Heof02ae732013-03-12 11:30:03 -07004911 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004912 mutex_lock(&wq_pool_attach_mutex);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004913 raw_spin_lock_irq(&pool->lock);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004914
4915 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004916 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004917 * unbound and set DISASSOCIATED. Before this, all workers
4918 * except for the ones which are still executing works from
4919 * before the last CPU down must be on the cpu. After
4920 * this, they may become diasporas.
4921 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004922 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004923 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004924
Tejun Heo24647572013-01-24 11:01:33 -08004925 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004926
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004927 raw_spin_unlock_irq(&pool->lock);
Peter Zijlstra06249732020-09-25 15:45:11 +02004928
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004929 for_each_pool_worker(worker, pool) {
4930 kthread_set_per_cpu(worker->task, -1);
Lai Jiangshan547a77d2021-01-11 23:26:33 +08004931 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004932 }
Peter Zijlstra06249732020-09-25 15:45:11 +02004933
Tejun Heo1258fae2018-05-18 08:47:13 -07004934 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004935
Lai Jiangshaneb283422013-03-08 15:18:28 -08004936 /*
4937 * Call schedule() so that we cross rq->lock and thus can
4938 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4939 * This is necessary as scheduler callbacks may be invoked
4940 * from other cpus.
4941 */
4942 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004943
Lai Jiangshaneb283422013-03-08 15:18:28 -08004944 /*
4945 * Sched callbacks are disabled now. Zap nr_running.
4946 * After this, nr_running stays zero and need_more_worker()
4947 * and keep_working() are always true as long as the
4948 * worklist is not empty. This pool now behaves as an
4949 * unbound (in terms of concurrency management) pool which
4950 * are served by workers tied to the pool.
4951 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004952 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004953
4954 /*
4955 * With concurrency management just turned off, a busy
4956 * worker blocking could lead to lengthy stalls. Kick off
4957 * unbound chain execution of currently pending work items.
4958 */
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004959 raw_spin_lock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004960 wake_up_worker(pool);
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004961 raw_spin_unlock_irq(&pool->lock);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004962 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004963}
4964
Tejun Heobd7c0892013-03-19 13:45:21 -07004965/**
4966 * rebind_workers - rebind all workers of a pool to the associated CPU
4967 * @pool: pool of interest
4968 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004969 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004970 */
4971static void rebind_workers(struct worker_pool *pool)
4972{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004973 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004974
Tejun Heo1258fae2018-05-18 08:47:13 -07004975 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004976
Tejun Heoa9ab7752013-03-19 13:45:21 -07004977 /*
4978 * Restore CPU affinity of all workers. As all idle workers should
4979 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304980 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004981 * of all workers first and then clear UNBOUND. As we're called
4982 * from CPU_ONLINE, the following shouldn't fail.
4983 */
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004984 for_each_pool_worker(worker, pool) {
4985 kthread_set_per_cpu(worker->task, pool->cpu);
Tejun Heoa9ab7752013-03-19 13:45:21 -07004986 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4987 pool->attrs->cpumask) < 0);
Peter Zijlstra5c25b5f2021-01-12 11:26:49 +01004988 }
Tejun Heoa9ab7752013-03-19 13:45:21 -07004989
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02004990 raw_spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004991
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004992 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004993
Lai Jiangshanda028462014-05-20 17:46:31 +08004994 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004995 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004996
4997 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004998 * A bound idle worker should actually be on the runqueue
4999 * of the associated CPU for local wake-ups targeting it to
5000 * work. Kick all idle workers so that they migrate to the
5001 * associated CPU. Doing this in the same loop as
5002 * replacing UNBOUND with REBOUND is safe as no worker will
5003 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07005004 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07005005 if (worker_flags & WORKER_IDLE)
5006 wake_up_process(worker->task);
5007
5008 /*
5009 * We want to clear UNBOUND but can't directly call
5010 * worker_clr_flags() or adjust nr_running. Atomically
5011 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5012 * @worker will clear REBOUND using worker_clr_flags() when
5013 * it initiates the next execution cycle thus restoring
5014 * concurrency management. Note that when or whether
5015 * @worker clears REBOUND doesn't affect correctness.
5016 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07005017 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07005018 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01005019 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07005020 * fail incorrectly leading to premature concurrency
5021 * management operations.
5022 */
5023 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5024 worker_flags |= WORKER_REBOUND;
5025 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07005026 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07005027 }
5028
Sebastian Andrzej Siewiora9b8a982020-05-27 21:46:33 +02005029 raw_spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07005030}
5031
Tejun Heo7dbc7252013-03-19 13:45:21 -07005032/**
5033 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5034 * @pool: unbound pool of interest
5035 * @cpu: the CPU which is coming up
5036 *
5037 * An unbound pool may end up with a cpumask which doesn't have any online
5038 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5039 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5040 * online CPU before, cpus_allowed of all its workers should be restored.
5041 */
5042static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5043{
5044 static cpumask_t cpumask;
5045 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005046
Tejun Heo1258fae2018-05-18 08:47:13 -07005047 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005048
5049 /* is @cpu allowed for @pool? */
5050 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5051 return;
5052
Tejun Heo7dbc7252013-03-19 13:45:21 -07005053 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005054
5055 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005056 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005057 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005058}
5059
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005060int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005061{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005062 struct worker_pool *pool;
5063
5064 for_each_cpu_worker_pool(pool, cpu) {
5065 if (pool->nr_workers)
5066 continue;
5067 if (!create_worker(pool))
5068 return -ENOMEM;
5069 }
5070 return 0;
5071}
5072
5073int workqueue_online_cpu(unsigned int cpu)
5074{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005075 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005076 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005077 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005078
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005079 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005080
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005081 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005082 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005083
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005084 if (pool->cpu == cpu)
5085 rebind_workers(pool);
5086 else if (pool->cpu < 0)
5087 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005088
Tejun Heo1258fae2018-05-18 08:47:13 -07005089 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005090 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005091
5092 /* update NUMA affinity of unbound workqueues */
5093 list_for_each_entry(wq, &workqueues, list)
5094 wq_update_unbound_numa(wq, cpu, true);
5095
5096 mutex_unlock(&wq_pool_mutex);
5097 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005098}
5099
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005100int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005101{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005102 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005103
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005104 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005105 if (WARN_ON(cpu != smp_processor_id()))
5106 return -1;
5107
5108 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005109
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005110 /* update NUMA affinity of unbound workqueues */
5111 mutex_lock(&wq_pool_mutex);
5112 list_for_each_entry(wq, &workqueues, list)
5113 wq_update_unbound_numa(wq, cpu, false);
5114 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005115
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005116 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005117}
5118
Rusty Russell2d3854a2008-11-05 13:39:10 +11005119struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005120 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005121 long (*fn)(void *);
5122 void *arg;
5123 long ret;
5124};
5125
Tejun Heoed48ece2012-09-18 12:48:43 -07005126static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005127{
Tejun Heoed48ece2012-09-18 12:48:43 -07005128 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5129
Rusty Russell2d3854a2008-11-05 13:39:10 +11005130 wfc->ret = wfc->fn(wfc->arg);
5131}
5132
5133/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005134 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005135 * @cpu: the cpu to run on
5136 * @fn: the function to run
5137 * @arg: the function arg
5138 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005139 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005140 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005141 *
5142 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005143 */
Tejun Heod84ff052013-03-12 11:29:59 -07005144long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005145{
Tejun Heoed48ece2012-09-18 12:48:43 -07005146 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005147
Tejun Heoed48ece2012-09-18 12:48:43 -07005148 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5149 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005150 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005151 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005152 return wfc.ret;
5153}
5154EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005155
5156/**
5157 * work_on_cpu_safe - run a function in thread context on a particular cpu
5158 * @cpu: the cpu to run on
5159 * @fn: the function to run
5160 * @arg: the function argument
5161 *
5162 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5163 * any locks which would prevent @fn from completing.
5164 *
5165 * Return: The value @fn returns.
5166 */
5167long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5168{
5169 long ret = -ENODEV;
5170
5171 get_online_cpus();
5172 if (cpu_online(cpu))
5173 ret = work_on_cpu(cpu, fn, arg);
5174 put_online_cpus();
5175 return ret;
5176}
5177EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005178#endif /* CONFIG_SMP */
5179
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005180#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305181
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005182/**
5183 * freeze_workqueues_begin - begin freezing workqueues
5184 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005185 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005186 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005187 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005188 *
5189 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005190 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005191 */
5192void freeze_workqueues_begin(void)
5193{
Tejun Heo24b8a842013-03-12 11:29:58 -07005194 struct workqueue_struct *wq;
5195 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005196
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005197 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005198
Tejun Heo6183c002013-03-12 11:29:57 -07005199 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005200 workqueue_freezing = true;
5201
Tejun Heo24b8a842013-03-12 11:29:58 -07005202 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005203 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005204 for_each_pwq(pwq, wq)
5205 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005206 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005207 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005208
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005209 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005210}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005211
5212/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005213 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005214 *
5215 * Check whether freezing is complete. This function must be called
5216 * between freeze_workqueues_begin() and thaw_workqueues().
5217 *
5218 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005219 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005220 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005221 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005222 * %true if some freezable workqueues are still busy. %false if freezing
5223 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005224 */
5225bool freeze_workqueues_busy(void)
5226{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005227 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005228 struct workqueue_struct *wq;
5229 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005230
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005231 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005232
Tejun Heo6183c002013-03-12 11:29:57 -07005233 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005234
Tejun Heo24b8a842013-03-12 11:29:58 -07005235 list_for_each_entry(wq, &workqueues, list) {
5236 if (!(wq->flags & WQ_FREEZABLE))
5237 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005238 /*
5239 * nr_active is monotonically decreasing. It's safe
5240 * to peek without lock.
5241 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005242 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005243 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005244 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005245 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005246 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005247 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005248 goto out_unlock;
5249 }
5250 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005251 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005252 }
5253out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005254 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005255 return busy;
5256}
5257
5258/**
5259 * thaw_workqueues - thaw workqueues
5260 *
5261 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005262 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005263 *
5264 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005265 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005266 */
5267void thaw_workqueues(void)
5268{
Tejun Heo24b8a842013-03-12 11:29:58 -07005269 struct workqueue_struct *wq;
5270 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005271
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005272 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005273
5274 if (!workqueue_freezing)
5275 goto out_unlock;
5276
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005277 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005278
Tejun Heo24b8a842013-03-12 11:29:58 -07005279 /* restore max_active and repopulate worklist */
5280 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005281 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005282 for_each_pwq(pwq, wq)
5283 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005284 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005285 }
5286
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005287out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005288 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005289}
5290#endif /* CONFIG_FREEZER */
5291
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005292static int workqueue_apply_unbound_cpumask(void)
5293{
5294 LIST_HEAD(ctxs);
5295 int ret = 0;
5296 struct workqueue_struct *wq;
5297 struct apply_wqattrs_ctx *ctx, *n;
5298
5299 lockdep_assert_held(&wq_pool_mutex);
5300
5301 list_for_each_entry(wq, &workqueues, list) {
5302 if (!(wq->flags & WQ_UNBOUND))
5303 continue;
5304 /* creating multiple pwqs breaks ordering guarantee */
5305 if (wq->flags & __WQ_ORDERED)
5306 continue;
5307
5308 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5309 if (!ctx) {
5310 ret = -ENOMEM;
5311 break;
5312 }
5313
5314 list_add_tail(&ctx->list, &ctxs);
5315 }
5316
5317 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5318 if (!ret)
5319 apply_wqattrs_commit(ctx);
5320 apply_wqattrs_cleanup(ctx);
5321 }
5322
5323 return ret;
5324}
5325
5326/**
5327 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5328 * @cpumask: the cpumask to set
5329 *
5330 * The low-level workqueues cpumask is a global cpumask that limits
5331 * the affinity of all unbound workqueues. This function check the @cpumask
5332 * and apply it to all unbound workqueues and updates all pwqs of them.
5333 *
Cai Huoqing67dc8322021-07-31 08:01:29 +08005334 * Return: 0 - Success
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005335 * -EINVAL - Invalid @cpumask
5336 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5337 */
5338int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5339{
5340 int ret = -EINVAL;
5341 cpumask_var_t saved_cpumask;
5342
5343 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5344 return -ENOMEM;
5345
Tal Shorerc98a9802017-11-03 17:27:50 +02005346 /*
5347 * Not excluding isolated cpus on purpose.
5348 * If the user wishes to include them, we allow that.
5349 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005350 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5351 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005352 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005353
5354 /* save the old wq_unbound_cpumask. */
5355 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5356
5357 /* update wq_unbound_cpumask at first and apply it to wqs. */
5358 cpumask_copy(wq_unbound_cpumask, cpumask);
5359 ret = workqueue_apply_unbound_cpumask();
5360
5361 /* restore the wq_unbound_cpumask when failed. */
5362 if (ret < 0)
5363 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5364
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005365 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005366 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005367
5368 free_cpumask_var(saved_cpumask);
5369 return ret;
5370}
5371
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005372#ifdef CONFIG_SYSFS
5373/*
5374 * Workqueues with WQ_SYSFS flag set is visible to userland via
5375 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5376 * following attributes.
5377 *
5378 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5379 * max_active RW int : maximum number of in-flight work items
5380 *
5381 * Unbound workqueues have the following extra attributes.
5382 *
Wang Long9a19b462017-11-02 23:05:12 -04005383 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005384 * nice RW int : nice value of the workers
5385 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005386 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005387 */
5388struct wq_device {
5389 struct workqueue_struct *wq;
5390 struct device dev;
5391};
5392
5393static struct workqueue_struct *dev_to_wq(struct device *dev)
5394{
5395 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5396
5397 return wq_dev->wq;
5398}
5399
5400static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5401 char *buf)
5402{
5403 struct workqueue_struct *wq = dev_to_wq(dev);
5404
5405 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5406}
5407static DEVICE_ATTR_RO(per_cpu);
5408
5409static ssize_t max_active_show(struct device *dev,
5410 struct device_attribute *attr, char *buf)
5411{
5412 struct workqueue_struct *wq = dev_to_wq(dev);
5413
5414 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5415}
5416
5417static ssize_t max_active_store(struct device *dev,
5418 struct device_attribute *attr, const char *buf,
5419 size_t count)
5420{
5421 struct workqueue_struct *wq = dev_to_wq(dev);
5422 int val;
5423
5424 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5425 return -EINVAL;
5426
5427 workqueue_set_max_active(wq, val);
5428 return count;
5429}
5430static DEVICE_ATTR_RW(max_active);
5431
5432static struct attribute *wq_sysfs_attrs[] = {
5433 &dev_attr_per_cpu.attr,
5434 &dev_attr_max_active.attr,
5435 NULL,
5436};
5437ATTRIBUTE_GROUPS(wq_sysfs);
5438
5439static ssize_t wq_pool_ids_show(struct device *dev,
5440 struct device_attribute *attr, char *buf)
5441{
5442 struct workqueue_struct *wq = dev_to_wq(dev);
5443 const char *delim = "";
5444 int node, written = 0;
5445
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005446 get_online_cpus();
5447 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005448 for_each_node(node) {
5449 written += scnprintf(buf + written, PAGE_SIZE - written,
5450 "%s%d:%d", delim, node,
5451 unbound_pwq_by_node(wq, node)->pool->id);
5452 delim = " ";
5453 }
5454 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005455 rcu_read_unlock();
5456 put_online_cpus();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005457
5458 return written;
5459}
5460
5461static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5462 char *buf)
5463{
5464 struct workqueue_struct *wq = dev_to_wq(dev);
5465 int written;
5466
5467 mutex_lock(&wq->mutex);
5468 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5469 mutex_unlock(&wq->mutex);
5470
5471 return written;
5472}
5473
5474/* prepare workqueue_attrs for sysfs store operations */
5475static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5476{
5477 struct workqueue_attrs *attrs;
5478
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005479 lockdep_assert_held(&wq_pool_mutex);
5480
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005481 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005482 if (!attrs)
5483 return NULL;
5484
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005485 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005486 return attrs;
5487}
5488
5489static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5490 const char *buf, size_t count)
5491{
5492 struct workqueue_struct *wq = dev_to_wq(dev);
5493 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005494 int ret = -ENOMEM;
5495
5496 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005497
5498 attrs = wq_sysfs_prep_attrs(wq);
5499 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005500 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005501
5502 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5503 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005504 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005505 else
5506 ret = -EINVAL;
5507
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005508out_unlock:
5509 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005510 free_workqueue_attrs(attrs);
5511 return ret ?: count;
5512}
5513
5514static ssize_t wq_cpumask_show(struct device *dev,
5515 struct device_attribute *attr, char *buf)
5516{
5517 struct workqueue_struct *wq = dev_to_wq(dev);
5518 int written;
5519
5520 mutex_lock(&wq->mutex);
5521 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5522 cpumask_pr_args(wq->unbound_attrs->cpumask));
5523 mutex_unlock(&wq->mutex);
5524 return written;
5525}
5526
5527static ssize_t wq_cpumask_store(struct device *dev,
5528 struct device_attribute *attr,
5529 const char *buf, size_t count)
5530{
5531 struct workqueue_struct *wq = dev_to_wq(dev);
5532 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005533 int ret = -ENOMEM;
5534
5535 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005536
5537 attrs = wq_sysfs_prep_attrs(wq);
5538 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005539 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005540
5541 ret = cpumask_parse(buf, attrs->cpumask);
5542 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005543 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005544
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005545out_unlock:
5546 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005547 free_workqueue_attrs(attrs);
5548 return ret ?: count;
5549}
5550
5551static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5552 char *buf)
5553{
5554 struct workqueue_struct *wq = dev_to_wq(dev);
5555 int written;
5556
5557 mutex_lock(&wq->mutex);
5558 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5559 !wq->unbound_attrs->no_numa);
5560 mutex_unlock(&wq->mutex);
5561
5562 return written;
5563}
5564
5565static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5566 const char *buf, size_t count)
5567{
5568 struct workqueue_struct *wq = dev_to_wq(dev);
5569 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005570 int v, ret = -ENOMEM;
5571
5572 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005573
5574 attrs = wq_sysfs_prep_attrs(wq);
5575 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005576 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005577
5578 ret = -EINVAL;
5579 if (sscanf(buf, "%d", &v) == 1) {
5580 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005581 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005582 }
5583
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005584out_unlock:
5585 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005586 free_workqueue_attrs(attrs);
5587 return ret ?: count;
5588}
5589
5590static struct device_attribute wq_sysfs_unbound_attrs[] = {
5591 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5592 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5593 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5594 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5595 __ATTR_NULL,
5596};
5597
5598static struct bus_type wq_subsys = {
5599 .name = "workqueue",
5600 .dev_groups = wq_sysfs_groups,
5601};
5602
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005603static ssize_t wq_unbound_cpumask_show(struct device *dev,
5604 struct device_attribute *attr, char *buf)
5605{
5606 int written;
5607
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005608 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005609 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5610 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005611 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005612
5613 return written;
5614}
5615
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005616static ssize_t wq_unbound_cpumask_store(struct device *dev,
5617 struct device_attribute *attr, const char *buf, size_t count)
5618{
5619 cpumask_var_t cpumask;
5620 int ret;
5621
5622 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5623 return -ENOMEM;
5624
5625 ret = cpumask_parse(buf, cpumask);
5626 if (!ret)
5627 ret = workqueue_set_unbound_cpumask(cpumask);
5628
5629 free_cpumask_var(cpumask);
5630 return ret ? ret : count;
5631}
5632
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005633static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005634 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5635 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005636
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005637static int __init wq_sysfs_init(void)
5638{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005639 int err;
5640
5641 err = subsys_virtual_register(&wq_subsys, NULL);
5642 if (err)
5643 return err;
5644
5645 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005646}
5647core_initcall(wq_sysfs_init);
5648
5649static void wq_device_release(struct device *dev)
5650{
5651 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5652
5653 kfree(wq_dev);
5654}
5655
5656/**
5657 * workqueue_sysfs_register - make a workqueue visible in sysfs
5658 * @wq: the workqueue to register
5659 *
5660 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5661 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5662 * which is the preferred method.
5663 *
5664 * Workqueue user should use this function directly iff it wants to apply
5665 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5666 * apply_workqueue_attrs() may race against userland updating the
5667 * attributes.
5668 *
5669 * Return: 0 on success, -errno on failure.
5670 */
5671int workqueue_sysfs_register(struct workqueue_struct *wq)
5672{
5673 struct wq_device *wq_dev;
5674 int ret;
5675
5676 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305677 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005678 * attributes breaks ordering guarantee. Disallow exposing ordered
5679 * workqueues.
5680 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005681 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005682 return -EINVAL;
5683
5684 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5685 if (!wq_dev)
5686 return -ENOMEM;
5687
5688 wq_dev->wq = wq;
5689 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005690 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005691 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005692
5693 /*
5694 * unbound_attrs are created separately. Suppress uevent until
5695 * everything is ready.
5696 */
5697 dev_set_uevent_suppress(&wq_dev->dev, true);
5698
5699 ret = device_register(&wq_dev->dev);
5700 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305701 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005702 wq->wq_dev = NULL;
5703 return ret;
5704 }
5705
5706 if (wq->flags & WQ_UNBOUND) {
5707 struct device_attribute *attr;
5708
5709 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5710 ret = device_create_file(&wq_dev->dev, attr);
5711 if (ret) {
5712 device_unregister(&wq_dev->dev);
5713 wq->wq_dev = NULL;
5714 return ret;
5715 }
5716 }
5717 }
5718
5719 dev_set_uevent_suppress(&wq_dev->dev, false);
5720 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5721 return 0;
5722}
5723
5724/**
5725 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5726 * @wq: the workqueue to unregister
5727 *
5728 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5729 */
5730static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5731{
5732 struct wq_device *wq_dev = wq->wq_dev;
5733
5734 if (!wq->wq_dev)
5735 return;
5736
5737 wq->wq_dev = NULL;
5738 device_unregister(&wq_dev->dev);
5739}
5740#else /* CONFIG_SYSFS */
5741static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5742#endif /* CONFIG_SYSFS */
5743
Tejun Heo82607adc2015-12-08 11:28:04 -05005744/*
5745 * Workqueue watchdog.
5746 *
5747 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5748 * flush dependency, a concurrency managed work item which stays RUNNING
5749 * indefinitely. Workqueue stalls can be very difficult to debug as the
5750 * usual warning mechanisms don't trigger and internal workqueue state is
5751 * largely opaque.
5752 *
5753 * Workqueue watchdog monitors all worker pools periodically and dumps
5754 * state if some pools failed to make forward progress for a while where
5755 * forward progress is defined as the first item on ->worklist changing.
5756 *
5757 * This mechanism is controlled through the kernel parameter
5758 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5759 * corresponding sysfs parameter file.
5760 */
5761#ifdef CONFIG_WQ_WATCHDOG
5762
Tejun Heo82607adc2015-12-08 11:28:04 -05005763static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005764static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005765
5766static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5767static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5768
5769static void wq_watchdog_reset_touched(void)
5770{
5771 int cpu;
5772
5773 wq_watchdog_touched = jiffies;
5774 for_each_possible_cpu(cpu)
5775 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5776}
5777
Kees Cook5cd79d62017-10-04 16:27:00 -07005778static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005779{
5780 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5781 bool lockup_detected = false;
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005782 unsigned long now = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005783 struct worker_pool *pool;
5784 int pi;
5785
5786 if (!thresh)
5787 return;
5788
5789 rcu_read_lock();
5790
5791 for_each_pool(pool, pi) {
5792 unsigned long pool_ts, touched, ts;
5793
5794 if (list_empty(&pool->worklist))
5795 continue;
5796
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005797 /*
5798 * If a virtual machine is stopped by the host it can look to
5799 * the watchdog like a stall.
5800 */
5801 kvm_check_and_clear_guest_paused();
5802
Tejun Heo82607adc2015-12-08 11:28:04 -05005803 /* get the latest of pool and touched timestamps */
Wang Qing89e28ce2021-03-24 19:40:29 +08005804 if (pool->cpu >= 0)
5805 touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
5806 else
5807 touched = READ_ONCE(wq_watchdog_touched);
Tejun Heo82607adc2015-12-08 11:28:04 -05005808 pool_ts = READ_ONCE(pool->watchdog_ts);
Tejun Heo82607adc2015-12-08 11:28:04 -05005809
5810 if (time_after(pool_ts, touched))
5811 ts = pool_ts;
5812 else
5813 ts = touched;
5814
Tejun Heo82607adc2015-12-08 11:28:04 -05005815 /* did we stall? */
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005816 if (time_after(now, ts + thresh)) {
Tejun Heo82607adc2015-12-08 11:28:04 -05005817 lockup_detected = true;
5818 pr_emerg("BUG: workqueue lockup - pool");
5819 pr_cont_pool_info(pool);
5820 pr_cont(" stuck for %us!\n",
Sergey Senozhatsky940d71c2021-05-20 19:14:22 +09005821 jiffies_to_msecs(now - pool_ts) / 1000);
Tejun Heo82607adc2015-12-08 11:28:04 -05005822 }
5823 }
5824
5825 rcu_read_unlock();
5826
5827 if (lockup_detected)
5828 show_workqueue_state();
5829
5830 wq_watchdog_reset_touched();
5831 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5832}
5833
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005834notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005835{
5836 if (cpu >= 0)
5837 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
Wang Qing89e28ce2021-03-24 19:40:29 +08005838
5839 wq_watchdog_touched = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005840}
5841
5842static void wq_watchdog_set_thresh(unsigned long thresh)
5843{
5844 wq_watchdog_thresh = 0;
5845 del_timer_sync(&wq_watchdog_timer);
5846
5847 if (thresh) {
5848 wq_watchdog_thresh = thresh;
5849 wq_watchdog_reset_touched();
5850 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5851 }
5852}
5853
5854static int wq_watchdog_param_set_thresh(const char *val,
5855 const struct kernel_param *kp)
5856{
5857 unsigned long thresh;
5858 int ret;
5859
5860 ret = kstrtoul(val, 0, &thresh);
5861 if (ret)
5862 return ret;
5863
5864 if (system_wq)
5865 wq_watchdog_set_thresh(thresh);
5866 else
5867 wq_watchdog_thresh = thresh;
5868
5869 return 0;
5870}
5871
5872static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5873 .set = wq_watchdog_param_set_thresh,
5874 .get = param_get_ulong,
5875};
5876
5877module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5878 0644);
5879
5880static void wq_watchdog_init(void)
5881{
Kees Cook5cd79d62017-10-04 16:27:00 -07005882 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005883 wq_watchdog_set_thresh(wq_watchdog_thresh);
5884}
5885
5886#else /* CONFIG_WQ_WATCHDOG */
5887
5888static inline void wq_watchdog_init(void) { }
5889
5890#endif /* CONFIG_WQ_WATCHDOG */
5891
Tejun Heobce90382013-04-01 11:23:32 -07005892static void __init wq_numa_init(void)
5893{
5894 cpumask_var_t *tbl;
5895 int node, cpu;
5896
Tejun Heobce90382013-04-01 11:23:32 -07005897 if (num_possible_nodes() <= 1)
5898 return;
5899
Tejun Heod55262c2013-04-01 11:23:38 -07005900 if (wq_disable_numa) {
5901 pr_info("workqueue: NUMA affinity support disabled\n");
5902 return;
5903 }
5904
Zhen Leif728c4a92021-07-22 11:03:52 +08005905 for_each_possible_cpu(cpu) {
5906 if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) {
5907 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5908 return;
5909 }
5910 }
5911
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005912 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005913 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5914
Tejun Heobce90382013-04-01 11:23:32 -07005915 /*
5916 * We want masks of possible CPUs of each node which isn't readily
5917 * available. Build one from cpu_to_node() which should have been
5918 * fully initialized by now.
5919 */
Kees Cook6396bb22018-06-12 14:03:40 -07005920 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005921 BUG_ON(!tbl);
5922
5923 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005924 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005925 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005926
5927 for_each_possible_cpu(cpu) {
5928 node = cpu_to_node(cpu);
Tejun Heobce90382013-04-01 11:23:32 -07005929 cpumask_set_cpu(cpu, tbl[node]);
5930 }
5931
5932 wq_numa_possible_cpumask = tbl;
5933 wq_numa_enabled = true;
5934}
5935
Tejun Heo3347fa02016-09-16 15:49:32 -04005936/**
5937 * workqueue_init_early - early init for workqueue subsystem
5938 *
5939 * This is the first half of two-staged workqueue subsystem initialization
5940 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5941 * idr are up. It sets up all the data structures and system workqueues
5942 * and allows early boot code to create workqueues and queue/cancel work
5943 * items. Actual work item execution starts only after kthreads can be
5944 * created and scheduled right before early initcalls.
5945 */
Yu Chen2333e822020-02-23 15:28:52 +08005946void __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005947{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005948 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005949 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005950 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005951
Lai Jiangshan10cdb152020-06-01 08:44:40 +00005952 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
Tejun Heoe904e6c2013-03-12 11:29:57 -07005953
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005954 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005955 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005956
Tejun Heoe904e6c2013-03-12 11:29:57 -07005957 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5958
Tejun Heo706026c2013-01-24 11:01:34 -08005959 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005960 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005961 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005962
Tejun Heo7a4e3442013-03-12 11:30:00 -07005963 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005964 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005965 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005966 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005967 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005968 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005969 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005970
Tejun Heo9daf9e62013-01-24 11:01:33 -08005971 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005972 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005973 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005974 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005975 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005976 }
5977
Tejun Heo8a2b7532013-09-05 12:30:04 -04005978 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005979 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5980 struct workqueue_attrs *attrs;
5981
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005982 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07005983 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005984 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005985
5986 /*
5987 * An ordered wq should have only one pwq as ordering is
5988 * guaranteed by max_active which is enforced by pwqs.
5989 * Turn off NUMA so that dfl_pwq is used for all nodes.
5990 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005991 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04005992 attrs->nice = std_nice[i];
5993 attrs->no_numa = true;
5994 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005995 }
5996
Tejun Heod320c032010-06-29 10:07:14 +02005997 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005998 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005999 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02006000 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
6001 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01006002 system_freezable_wq = alloc_workqueue("events_freezable",
6003 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05306004 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
6005 WQ_POWER_EFFICIENT, 0);
6006 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
6007 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
6008 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09006009 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05306010 !system_unbound_wq || !system_freezable_wq ||
6011 !system_power_efficient_wq ||
6012 !system_freezable_power_efficient_wq);
Tejun Heo3347fa02016-09-16 15:49:32 -04006013}
6014
6015/**
6016 * workqueue_init - bring workqueue subsystem fully online
6017 *
6018 * This is the latter half of two-staged workqueue subsystem initialization
6019 * and invoked as soon as kthreads can be created and scheduled.
6020 * Workqueues have been created and work items queued on them, but there
6021 * are no kworkers executing the work items yet. Populate the worker pools
6022 * with the initial workers and enable future kworker creations.
6023 */
Yu Chen2333e822020-02-23 15:28:52 +08006024void __init workqueue_init(void)
Tejun Heo3347fa02016-09-16 15:49:32 -04006025{
Tejun Heo2186d9f2016-10-19 12:01:27 -04006026 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04006027 struct worker_pool *pool;
6028 int cpu, bkt;
6029
Tejun Heo2186d9f2016-10-19 12:01:27 -04006030 /*
6031 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6032 * CPU to node mapping may not be available that early on some
6033 * archs such as power and arm64. As per-cpu pools created
6034 * previously could be missing node hint and unbound pools NUMA
6035 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08006036 *
6037 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006038 */
6039 wq_numa_init();
6040
6041 mutex_lock(&wq_pool_mutex);
6042
6043 for_each_possible_cpu(cpu) {
6044 for_each_cpu_worker_pool(pool, cpu) {
6045 pool->node = cpu_to_node(cpu);
6046 }
6047 }
6048
Tejun Heo40c17f72018-01-08 05:38:37 -08006049 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006050 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006051 WARN(init_rescuer(wq),
6052 "workqueue: failed to create early rescuer for %s",
6053 wq->name);
6054 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006055
6056 mutex_unlock(&wq_pool_mutex);
6057
Tejun Heo3347fa02016-09-16 15:49:32 -04006058 /* create the initial workers */
6059 for_each_online_cpu(cpu) {
6060 for_each_cpu_worker_pool(pool, cpu) {
6061 pool->flags &= ~POOL_DISASSOCIATED;
6062 BUG_ON(!create_worker(pool));
6063 }
6064 }
6065
6066 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6067 BUG_ON(!create_worker(pool));
6068
6069 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006070 wq_watchdog_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07006071}