blob: 914b845ad4ff10e2d89ba34db43ed68d1d2367d2 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Tejun Heoc54fce62010-09-10 16:51:36 +02003 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Tejun Heoc54fce62010-09-10 16:51:36 +02005 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
Tejun Heoc54fce62010-09-10 16:51:36 +02007 * Derived from the taskqueue/keventd code by:
8 * David Woodhouse <dwmw2@infradead.org>
9 * Andrew Morton
10 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
11 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080012 *
Christoph Lametercde53532008-07-04 09:59:22 -070013 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020014 *
15 * Copyright (C) 2010 SUSE Linux Products GmbH
16 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
17 *
18 * This is the generic async execution mechanism. Work items as are
19 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080020 * automatically managed. There are two worker pools for each CPU (one for
21 * normal work items and the other for high priority ones) and some extra
22 * pools for workqueues which are not bound to any specific CPU - the
23 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020024 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070025 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 */
27
Paul Gortmaker9984de12011-05-23 14:51:41 -040028#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/kernel.h>
30#include <linux/sched.h>
31#include <linux/init.h>
32#include <linux/signal.h>
33#include <linux/completion.h>
34#include <linux/workqueue.h>
35#include <linux/slab.h>
36#include <linux/cpu.h>
37#include <linux/notifier.h>
38#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060039#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070040#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080041#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080042#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020051#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090052#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020053
Tejun Heoea138442013-01-18 14:05:55 -080054#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Tejun Heoc8e55f32010-06-29 10:07:12 +020056enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 /*
Tejun Heo24647572013-01-24 11:01:33 -080058 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 *
Tejun Heo24647572013-01-24 11:01:33 -080060 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070061 * While associated (!DISASSOCIATED), all workers are bound to the
62 * CPU and none has %WORKER_UNBOUND set and concurrency management
63 * is in effect.
64 *
65 * While DISASSOCIATED, the cpu may be offline and all workers have
66 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080067 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070068 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070069 * Note that DISASSOCIATED should be flipped only while holding
Tejun Heo1258fae2018-05-18 08:47:13 -070070 * wq_pool_attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080071 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070072 */
Tejun Heo692b4822017-10-09 08:04:13 -070073 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080074 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020075
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020077 WORKER_DIE = 1 << 1, /* die die die */
78 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020079 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020080 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020081 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070082 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020083
Tejun Heoa9ab7752013-03-19 13:45:21 -070084 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
85 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020086
Tejun Heoe34cdddb2013-01-24 11:01:33 -080087 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070088
Tejun Heo29c91e92013-03-12 11:30:03 -070089 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020090 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020091
Tejun Heoe22bee72010-06-29 10:07:14 +020092 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
93 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
94
Tejun Heo3233cdb2011-02-16 18:10:19 +010095 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
96 /* call for help after 10ms
97 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020098 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
99 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +0200100
101 /*
102 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800103 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200104 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800105 RESCUER_NICE_LEVEL = MIN_NICE,
106 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700107
108 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200109};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200112 * Structure fields follow one of the following exclusion rules.
113 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200114 * I: Modifiable by initialization/destruction paths and read-only for
115 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200116 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200117 * P: Preemption protected. Disabling preemption is enough and should
118 * only be modified and accessed from the local cpu.
119 *
Tejun Heod565ed62013-01-24 11:01:33 -0800120 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200121 *
Tejun Heod565ed62013-01-24 11:01:33 -0800122 * X: During normal operation, modification requires pool->lock and should
123 * be done only from local cpu. Either disabling preemption on local
124 * cpu or grabbing pool->lock is enough for read access. If
125 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200126 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700127 * A: wq_pool_attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700128 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700129 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700130 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100131 * PR: wq_pool_mutex protected for writes. RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700132 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800133 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
134 *
135 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100136 * RCU for reads.
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800137 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700138 * WQ: wq->mutex protected.
139 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100140 * WR: wq->mutex protected for writes. RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700141 *
142 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200143 */
144
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800145/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200146
Tejun Heobd7bdd42012-07-12 14:46:37 -0700147struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800148 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700149 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700150 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800151 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700152 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700153
Tejun Heo82607adc2015-12-08 11:28:04 -0500154 unsigned long watchdog_ts; /* L: watchdog timestamp */
155
Tejun Heobd7bdd42012-07-12 14:46:37 -0700156 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700157
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800158 int nr_workers; /* L: total number of workers */
159 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700160
161 struct list_head idle_list; /* X: list of idle workers */
162 struct timer_list idle_timer; /* L: worker idle timeout */
163 struct timer_list mayday_timer; /* L: SOS timer for workers */
164
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700165 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800166 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
167 /* L: hash of busy workers */
168
Tejun Heo2607d7a2015-03-09 09:22:28 -0400169 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800170 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800171 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800172
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800173 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800174
Tejun Heo7a4e3442013-03-12 11:30:00 -0700175 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700176 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
177 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700178
Tejun Heoe19e3972013-01-24 11:39:44 -0800179 /*
180 * The current concurrency level. As it's likely to be accessed
181 * from other CPUs during try_to_wake_up(), put it in a separate
182 * cacheline.
183 */
184 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700185
186 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100187 * Destruction of pool is RCU protected to allow dereferences
Tejun Heo29c91e92013-03-12 11:30:03 -0700188 * from get_work_pool().
189 */
190 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200191} ____cacheline_aligned_in_smp;
192
193/*
Tejun Heo112202d2013-02-13 19:29:12 -0800194 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
195 * of work_struct->data are used for flags and the remaining high bits
196 * point to the pwq; thus, pwqs need to be aligned at two's power of the
197 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 */
Tejun Heo112202d2013-02-13 19:29:12 -0800199struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700200 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200201 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200202 int work_color; /* L: current color */
203 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700204 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200205 int nr_in_flight[WORK_NR_COLORS];
206 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200207 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200208 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200209 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700210 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700211 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700212
213 /*
214 * Release of unbound pwq is punted to system_wq. See put_pwq()
215 * and pwq_unbound_release_workfn() for details. pool_workqueue
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100216 * itself is also RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700217 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700218 */
219 struct work_struct unbound_release_work;
220 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700221} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200224 * Structure used to wait for workqueue flush.
225 */
226struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700227 struct list_head list; /* WQ: list of flushers */
228 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200229 struct completion done; /* flush completion */
230};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Tejun Heo226223a2013-03-12 11:30:05 -0700232struct wq_device;
233
Tejun Heo73f53c42010-06-29 10:07:11 +0200234/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700235 * The externally visible workqueue. It relays the issued work items to
236 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
238struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700239 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400240 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200241
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700242 struct mutex mutex; /* protects this wq */
243 int work_color; /* WQ: current work color */
244 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800245 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700246 struct wq_flusher *first_flusher; /* WQ: first flusher */
247 struct list_head flusher_queue; /* WQ: flush waiters */
248 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200249
Tejun Heo2e109a22013-03-13 19:47:40 -0700250 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heo30ae2fc2019-09-20 14:09:14 -0700251 struct worker *rescuer; /* MD: rescue worker */
Tejun Heoe22bee72010-06-29 10:07:14 +0200252
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700253 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700254 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700255
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800256 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
257 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700258
Tejun Heo226223a2013-03-12 11:30:05 -0700259#ifdef CONFIG_SYSFS
260 struct wq_device *wq_dev; /* I: for sysfs interface */
261#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700262#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800263 char *lock_name;
264 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200265 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700266#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700267 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700268
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400269 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100270 * Destruction of workqueue_struct is RCU protected to allow walking
271 * the workqueues list without grabbing wq_pool_mutex.
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400272 * This is used to dump all workqueues from sysrq.
273 */
274 struct rcu_head rcu;
275
Tejun Heo2728fd22013-04-01 11:23:35 -0700276 /* hot fields used during command issue, aligned to cacheline */
277 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
278 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800279 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280};
281
Tejun Heoe904e6c2013-03-12 11:29:57 -0700282static struct kmem_cache *pwq_cache;
283
Tejun Heobce90382013-04-01 11:23:32 -0700284static cpumask_var_t *wq_numa_possible_cpumask;
285 /* possible CPUs of each node */
286
Tejun Heod55262c2013-04-01 11:23:38 -0700287static bool wq_disable_numa;
288module_param_named(disable_numa, wq_disable_numa, bool, 0444);
289
Viresh Kumarcee22a12013-04-08 16:45:40 +0530290/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930291static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530292module_param_named(power_efficient, wq_power_efficient, bool, 0444);
293
Tejun Heo863b7102016-09-16 15:49:34 -0400294static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400295
Tejun Heobce90382013-04-01 11:23:32 -0700296static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
297
Tejun Heo4c16bd32013-04-01 11:23:36 -0700298/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
299static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
300
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700301static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700302static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Tejun Heo2e109a22013-03-13 19:47:40 -0700303static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo692b4822017-10-09 08:04:13 -0700304static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700305
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400306static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700307static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700308
Mike Galbraithef5571802016-02-09 17:59:38 -0500309/* PL: allowable cpus for unbound wqs and work items */
310static cpumask_var_t wq_unbound_cpumask;
311
312/* CPU where unbound work was last round robin scheduled from this CPU */
313static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800314
Tejun Heof303fccb2016-02-09 17:59:38 -0500315/*
316 * Local execution of unbound work items is no longer guaranteed. The
317 * following always forces round-robin CPU selection on unbound work items
318 * to uncover usages which depend on it.
319 */
320#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
321static bool wq_debug_force_rr_cpu = true;
322#else
323static bool wq_debug_force_rr_cpu = false;
324#endif
325module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
326
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700327/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700328static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700329
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700330static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700331
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700332/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700333static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
334
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700335/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700336static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
337
Tejun Heo8a2b7532013-09-05 12:30:04 -0400338/* I: attributes used when instantiating ordered pools on demand */
339static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
340
Tejun Heod320c032010-06-29 10:07:14 +0200341struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400342EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300343struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900344EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300345struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200346EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300347struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200348EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300349struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100350EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530351struct workqueue_struct *system_power_efficient_wq __read_mostly;
352EXPORT_SYMBOL_GPL(system_power_efficient_wq);
353struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
354EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200355
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700356static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800357static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heoc29eb852019-09-23 11:08:58 -0700358static void show_pwq(struct pool_workqueue *pwq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700359
Tejun Heo97bd2342010-10-05 10:41:14 +0200360#define CREATE_TRACE_POINTS
361#include <trace/events/workqueue.h>
362
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700363#define assert_rcu_or_pool_mutex() \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100364 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700365 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100366 "RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700367
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700368#define assert_rcu_or_wq_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100369 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700370 !lockdep_is_held(&wq->mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100371 "RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700372
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800373#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100374 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700375 !lockdep_is_held(&wq->mutex) && \
376 !lockdep_is_held(&wq_pool_mutex), \
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100377 "RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800378
Tejun Heof02ae732013-03-12 11:30:03 -0700379#define for_each_cpu_worker_pool(pool, cpu) \
380 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
381 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700382 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700383
Tejun Heo49e3cf42013-03-12 11:29:58 -0700384/**
Tejun Heo17116962013-03-12 11:29:58 -0700385 * for_each_pool - iterate through all worker_pools in the system
386 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700387 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700388 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100389 * This must be called either with wq_pool_mutex held or RCU read
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700390 * locked. If the pool needs to be used beyond the locking in effect, the
391 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700392 *
393 * The if/else clause exists only for the lockdep assertion and can be
394 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700395 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700396#define for_each_pool(pool, pi) \
397 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700398 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700399 else
Tejun Heo17116962013-03-12 11:29:58 -0700400
401/**
Tejun Heo822d8402013-03-19 13:45:21 -0700402 * for_each_pool_worker - iterate through all workers of a worker_pool
403 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700404 * @pool: worker_pool to iterate workers of
405 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700406 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700407 *
408 * The if/else clause exists only for the lockdep assertion and can be
409 * ignored.
410 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800411#define for_each_pool_worker(worker, pool) \
412 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700413 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700414 else
415
416/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700417 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
418 * @pwq: iteration cursor
419 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700420 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100421 * This must be called either with wq->mutex held or RCU read locked.
Tejun Heo794b18bc2013-03-13 19:47:40 -0700422 * If the pwq needs to be used beyond the locking in effect, the caller is
423 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700424 *
425 * The if/else clause exists only for the lockdep assertion and can be
426 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700427 */
428#define for_each_pwq(pwq, wq) \
Sebastian Andrzej Siewior49e9d1a2019-11-15 19:01:25 +0100429 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
430 lockdep_is_held(&wq->mutex)) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700431 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700432 else
Tejun Heof3421792010-07-02 10:03:51 +0200433
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900434#ifdef CONFIG_DEBUG_OBJECTS_WORK
435
436static struct debug_obj_descr work_debug_descr;
437
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100438static void *work_debug_hint(void *addr)
439{
440 return ((struct work_struct *) addr)->func;
441}
442
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700443static bool work_is_static_object(void *addr)
444{
445 struct work_struct *work = addr;
446
447 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
448}
449
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900450/*
451 * fixup_init is called when:
452 * - an active object is initialized
453 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700454static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900455{
456 struct work_struct *work = addr;
457
458 switch (state) {
459 case ODEBUG_STATE_ACTIVE:
460 cancel_work_sync(work);
461 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700462 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900463 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700464 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900465 }
466}
467
468/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900469 * fixup_free is called when:
470 * - an active object is freed
471 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700472static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900473{
474 struct work_struct *work = addr;
475
476 switch (state) {
477 case ODEBUG_STATE_ACTIVE:
478 cancel_work_sync(work);
479 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700480 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900481 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700482 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900483 }
484}
485
486static struct debug_obj_descr work_debug_descr = {
487 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100488 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700489 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900490 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900491 .fixup_free = work_fixup_free,
492};
493
494static inline void debug_work_activate(struct work_struct *work)
495{
496 debug_object_activate(work, &work_debug_descr);
497}
498
499static inline void debug_work_deactivate(struct work_struct *work)
500{
501 debug_object_deactivate(work, &work_debug_descr);
502}
503
504void __init_work(struct work_struct *work, int onstack)
505{
506 if (onstack)
507 debug_object_init_on_stack(work, &work_debug_descr);
508 else
509 debug_object_init(work, &work_debug_descr);
510}
511EXPORT_SYMBOL_GPL(__init_work);
512
513void destroy_work_on_stack(struct work_struct *work)
514{
515 debug_object_free(work, &work_debug_descr);
516}
517EXPORT_SYMBOL_GPL(destroy_work_on_stack);
518
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000519void destroy_delayed_work_on_stack(struct delayed_work *work)
520{
521 destroy_timer_on_stack(&work->timer);
522 debug_object_free(&work->work, &work_debug_descr);
523}
524EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
525
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900526#else
527static inline void debug_work_activate(struct work_struct *work) { }
528static inline void debug_work_deactivate(struct work_struct *work) { }
529#endif
530
Li Bin4e8b22b2013-09-10 09:52:35 +0800531/**
532 * worker_pool_assign_id - allocate ID and assing it to @pool
533 * @pool: the pool pointer of interest
534 *
535 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
536 * successfully, -errno on failure.
537 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800538static int worker_pool_assign_id(struct worker_pool *pool)
539{
540 int ret;
541
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700542 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700543
Li Bin4e8b22b2013-09-10 09:52:35 +0800544 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
545 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700546 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700547 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700548 return 0;
549 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800550 return ret;
551}
552
Tejun Heo76af4d92013-03-12 11:30:00 -0700553/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700554 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
555 * @wq: the target workqueue
556 * @node: the node ID
557 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100558 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800559 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700560 * If the pwq needs to be used beyond the locking in effect, the caller is
561 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700562 *
563 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700564 */
565static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
566 int node)
567{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800568 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500569
570 /*
571 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
572 * delayed item is pending. The plan is to keep CPU -> NODE
573 * mapping valid and stable across CPU on/offlines. Once that
574 * happens, this workaround can be removed.
575 */
576 if (unlikely(node == NUMA_NO_NODE))
577 return wq->dfl_pwq;
578
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700579 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
580}
581
Tejun Heo73f53c42010-06-29 10:07:11 +0200582static unsigned int work_color_to_flags(int color)
583{
584 return color << WORK_STRUCT_COLOR_SHIFT;
585}
586
587static int get_work_color(struct work_struct *work)
588{
589 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
590 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
591}
592
593static int work_next_color(int color)
594{
595 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700596}
597
David Howells4594bf12006-12-07 11:33:26 +0000598/*
Tejun Heo112202d2013-02-13 19:29:12 -0800599 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
600 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800601 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 *
Tejun Heo112202d2013-02-13 19:29:12 -0800603 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
604 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700605 * work->data. These functions should only be called while the work is
606 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607 *
Tejun Heo112202d2013-02-13 19:29:12 -0800608 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800609 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800610 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800611 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700612 *
613 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
614 * canceled. While being canceled, a work item may have its PENDING set
615 * but stay off timer and worklist for arbitrarily long and nobody should
616 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000617 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200618static inline void set_work_data(struct work_struct *work, unsigned long data,
619 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000620{
Tejun Heo6183c002013-03-12 11:29:57 -0700621 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200622 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000623}
David Howells365970a2006-11-22 14:54:49 +0000624
Tejun Heo112202d2013-02-13 19:29:12 -0800625static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200626 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200627{
Tejun Heo112202d2013-02-13 19:29:12 -0800628 set_work_data(work, (unsigned long)pwq,
629 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200630}
631
Lai Jiangshan4468a002013-02-06 18:04:53 -0800632static void set_work_pool_and_keep_pending(struct work_struct *work,
633 int pool_id)
634{
635 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
636 WORK_STRUCT_PENDING);
637}
638
Tejun Heo7c3eed52013-01-24 11:01:33 -0800639static void set_work_pool_and_clear_pending(struct work_struct *work,
640 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000641{
Tejun Heo23657bb2012-08-13 17:08:19 -0700642 /*
643 * The following wmb is paired with the implied mb in
644 * test_and_set_bit(PENDING) and ensures all updates to @work made
645 * here are visible to and precede any updates by the next PENDING
646 * owner.
647 */
648 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800649 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200650 /*
651 * The following mb guarantees that previous clear of a PENDING bit
652 * will not be reordered with any speculative LOADS or STORES from
653 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800654 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200655 * the same @work. E.g. consider this case:
656 *
657 * CPU#0 CPU#1
658 * ---------------------------- --------------------------------
659 *
660 * 1 STORE event_indicated
661 * 2 queue_work_on() {
662 * 3 test_and_set_bit(PENDING)
663 * 4 } set_..._and_clear_pending() {
664 * 5 set_work_data() # clear bit
665 * 6 smp_mb()
666 * 7 work->current_func() {
667 * 8 LOAD event_indicated
668 * }
669 *
670 * Without an explicit full barrier speculative LOAD on line 8 can
671 * be executed before CPU#0 does STORE on line 1. If that happens,
672 * CPU#0 observes the PENDING bit is still set and new execution of
673 * a @work is not queued in a hope, that CPU#1 will eventually
674 * finish the queued @work. Meanwhile CPU#1 does not see
675 * event_indicated is set, because speculative LOAD was executed
676 * before actual STORE.
677 */
678 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200679}
680
681static void clear_work_data(struct work_struct *work)
682{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800683 smp_wmb(); /* see set_work_pool_and_clear_pending() */
684 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685}
686
Tejun Heo112202d2013-02-13 19:29:12 -0800687static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200688{
Tejun Heoe1201532010-07-22 14:14:25 +0200689 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200690
Tejun Heo112202d2013-02-13 19:29:12 -0800691 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200692 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
693 else
694 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200695}
696
Tejun Heo7c3eed52013-01-24 11:01:33 -0800697/**
698 * get_work_pool - return the worker_pool a given work was associated with
699 * @work: the work item of interest
700 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700701 * Pools are created and destroyed under wq_pool_mutex, and allows read
Thomas Gleixner24acfb72019-03-13 17:55:47 +0100702 * access under RCU read lock. As such, this function should be
703 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700704 *
705 * All fields of the returned pool are accessible as long as the above
706 * mentioned locking is in effect. If the returned pool needs to be used
707 * beyond the critical section, the caller is responsible for ensuring the
708 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700709 *
710 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800711 */
712static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200713{
Tejun Heoe1201532010-07-22 14:14:25 +0200714 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800715 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200716
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700717 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700718
Tejun Heo112202d2013-02-13 19:29:12 -0800719 if (data & WORK_STRUCT_PWQ)
720 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800721 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200722
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
724 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200725 return NULL;
726
Tejun Heofa1b54e2013-03-12 11:30:00 -0700727 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800728}
729
730/**
731 * get_work_pool_id - return the worker pool ID a given work is associated with
732 * @work: the work item of interest
733 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700734 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800735 * %WORK_OFFQ_POOL_NONE if none.
736 */
737static int get_work_pool_id(struct work_struct *work)
738{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800739 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800740
Tejun Heo112202d2013-02-13 19:29:12 -0800741 if (data & WORK_STRUCT_PWQ)
742 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800743 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
744
745 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800746}
747
Tejun Heobbb68df2012-08-03 10:30:46 -0700748static void mark_work_canceling(struct work_struct *work)
749{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800750 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700751
Tejun Heo7c3eed52013-01-24 11:01:33 -0800752 pool_id <<= WORK_OFFQ_POOL_SHIFT;
753 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700754}
755
756static bool work_is_canceling(struct work_struct *work)
757{
758 unsigned long data = atomic_long_read(&work->data);
759
Tejun Heo112202d2013-02-13 19:29:12 -0800760 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700761}
762
David Howells365970a2006-11-22 14:54:49 +0000763/*
Tejun Heo32704762012-07-13 22:16:45 -0700764 * Policy functions. These define the policies on how the global worker
765 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800766 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000767 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200768
Tejun Heo63d95a92012-07-12 14:46:37 -0700769static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000770{
Tejun Heoe19e3972013-01-24 11:39:44 -0800771 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000772}
773
Tejun Heoe22bee72010-06-29 10:07:14 +0200774/*
775 * Need to wake up a worker? Called from anything but currently
776 * running workers.
Tejun Heo974271c42012-07-12 14:46:37 -0700777 *
778 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800779 * function will always return %true for unbound pools as long as the
Tejun Heo974271c42012-07-12 14:46:37 -0700780 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200781 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700782static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000783{
Tejun Heo63d95a92012-07-12 14:46:37 -0700784 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000785}
786
Tejun Heoe22bee72010-06-29 10:07:14 +0200787/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700788static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200789{
Tejun Heo63d95a92012-07-12 14:46:37 -0700790 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200791}
792
793/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700794static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200795{
Tejun Heoe19e3972013-01-24 11:39:44 -0800796 return !list_empty(&pool->worklist) &&
797 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200798}
799
800/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700801static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200802{
Tejun Heo63d95a92012-07-12 14:46:37 -0700803 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200804}
805
Tejun Heoe22bee72010-06-29 10:07:14 +0200806/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700807static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200808{
Tejun Heo692b4822017-10-09 08:04:13 -0700809 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700810 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
811 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200812
813 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
814}
815
816/*
817 * Wake up functions.
818 */
819
Lai Jiangshan1037de32014-05-22 16:44:07 +0800820/* Return the first idle worker. Safe with preemption disabled */
821static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200822{
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200824 return NULL;
825
Tejun Heo63d95a92012-07-12 14:46:37 -0700826 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200827}
828
829/**
830 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700831 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200832 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700833 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200834 *
835 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800836 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200837 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700838static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200839{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800840 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200841
842 if (likely(worker))
843 wake_up_process(worker->task);
844}
845
Tejun Heo4690c4a2010-06-29 10:07:10 +0200846/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100847 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200848 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200849 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100850 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200851 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100852void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200853{
854 struct worker *worker = kthread_data(task);
855
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100856 if (!worker->sleeping)
857 return;
858 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800859 atomic_inc(&worker->pool->nr_running);
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100860 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200861}
862
863/**
864 * wq_worker_sleeping - a worker is going to sleep
865 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100867 * This function is called from schedule() when a busy worker is
868 * going to sleep.
Tejun Heoe22bee72010-06-29 10:07:14 +0200869 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100870void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200871{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100872 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800873 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200874
Tejun Heo111c2252013-01-17 17:16:24 -0800875 /*
876 * Rescuers, which may not have all the fields set up like normal
877 * workers, also reach here, let's not access anything before
878 * checking NOT_RUNNING.
879 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500880 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100881 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200882
Tejun Heo111c2252013-01-17 17:16:24 -0800883 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800884
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100885 if (WARN_ON_ONCE(worker->sleeping))
886 return;
887
888 worker->sleeping = 1;
889 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200890
891 /*
892 * The counterpart of the following dec_and_test, implied mb,
893 * worklist not empty test sequence is in insert_work().
894 * Please read comment there.
895 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700896 * NOT_RUNNING is clear. This means that we're bound to and
897 * running on the local cpu w/ rq lock held and preemption
898 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800899 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700900 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200901 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800902 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100903 !list_empty(&pool->worklist)) {
904 next = first_idle_worker(pool);
905 if (next)
906 wake_up_process(next->task);
907 }
908 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200909}
910
911/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800912 * wq_worker_last_func - retrieve worker's last work function
Bart Van Assche8194fe92019-03-19 10:45:09 -0700913 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800914 *
915 * Determine the last function a worker executed. This is called from
916 * the scheduler to get a worker's last known identity.
917 *
918 * CONTEXT:
919 * spin_lock_irq(rq->lock)
920 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800921 * This function is called during schedule() when a kworker is going
922 * to sleep. It's used by psi to identify aggregation workers during
923 * dequeuing, to allow periodic aggregation to shut-off when that
924 * worker is the last task in the system or cgroup to go to sleep.
925 *
926 * As this function doesn't involve any workqueue-related locking, it
927 * only returns stable values when called from inside the scheduler's
928 * queuing and dequeuing paths, when @task, which must be a kworker,
929 * is guaranteed to not be processing any works.
930 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800931 * Return:
932 * The last work function %current executed as a worker, NULL if it
933 * hasn't executed any work yet.
934 */
935work_func_t wq_worker_last_func(struct task_struct *task)
936{
937 struct worker *worker = kthread_data(task);
938
939 return worker->last_func;
940}
941
942/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200943 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200944 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200945 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200946 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800947 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200948 *
Tejun Heocb444762010-07-02 10:03:50 +0200949 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800950 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200951 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800952static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200953{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700954 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200955
Tejun Heocb444762010-07-02 10:03:50 +0200956 WARN_ON_ONCE(worker->task != current);
957
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800958 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200959 if ((flags & WORKER_NOT_RUNNING) &&
960 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800961 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200962 }
963
Tejun Heod302f012010-06-29 10:07:13 +0200964 worker->flags |= flags;
965}
966
967/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200968 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200969 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200970 * @flags: flags to clear
971 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200972 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200973 *
Tejun Heocb444762010-07-02 10:03:50 +0200974 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800975 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200976 */
977static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
978{
Tejun Heo63d95a92012-07-12 14:46:37 -0700979 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200980 unsigned int oflags = worker->flags;
981
Tejun Heocb444762010-07-02 10:03:50 +0200982 WARN_ON_ONCE(worker->task != current);
983
Tejun Heod302f012010-06-29 10:07:13 +0200984 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200985
Tejun Heo42c025f2011-01-11 15:58:49 +0100986 /*
987 * If transitioning out of NOT_RUNNING, increment nr_running. Note
988 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
989 * of multiple flags, not a single flag.
990 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200991 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
992 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800993 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200994}
995
996/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200997 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800998 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200999 * @work: work to find worker for
1000 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001001 * Find a worker which is executing @work on @pool by searching
1002 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001003 * to match, its current execution should match the address of @work and
1004 * its work function. This is to avoid unwanted dependency between
1005 * unrelated work executions through a work item being recycled while still
1006 * being executed.
1007 *
1008 * This is a bit tricky. A work item may be freed once its execution
1009 * starts and nothing prevents the freed area from being recycled for
1010 * another work item. If the same work item address ends up being reused
1011 * before the original execution finishes, workqueue will identify the
1012 * recycled work item as currently executing and make it wait until the
1013 * current execution finishes, introducing an unwanted dependency.
1014 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001015 * This function checks the work item address and work function to avoid
1016 * false positives. Note that this isn't complete as one may construct a
1017 * work function which can introduce dependency onto itself through a
1018 * recycled work item. Well, if somebody wants to shoot oneself in the
1019 * foot that badly, there's only so much we can do, and if such deadlock
1020 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001021 *
1022 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001023 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001024 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001025 * Return:
1026 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001027 * otherwise.
1028 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001029static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001030 struct work_struct *work)
1031{
Sasha Levin42f85702012-12-17 10:01:23 -05001032 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001033
Sasha Levinb67bfe02013-02-27 17:06:00 -08001034 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001035 (unsigned long)work)
1036 if (worker->current_work == work &&
1037 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001038 return worker;
1039
1040 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001041}
1042
1043/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001044 * move_linked_works - move linked works to a list
1045 * @work: start of series of works to be scheduled
1046 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301047 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001048 *
1049 * Schedule linked works starting from @work to @head. Work series to
1050 * be scheduled starts at @work and includes any consecutive work with
1051 * WORK_STRUCT_LINKED set in its predecessor.
1052 *
1053 * If @nextp is not NULL, it's updated to point to the next work of
1054 * the last scheduled work. This allows move_linked_works() to be
1055 * nested inside outer list_for_each_entry_safe().
1056 *
1057 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001058 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001059 */
1060static void move_linked_works(struct work_struct *work, struct list_head *head,
1061 struct work_struct **nextp)
1062{
1063 struct work_struct *n;
1064
1065 /*
1066 * Linked worklist will always end before the end of the list,
1067 * use NULL for list head.
1068 */
1069 list_for_each_entry_safe_from(work, n, NULL, entry) {
1070 list_move_tail(&work->entry, head);
1071 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1072 break;
1073 }
1074
1075 /*
1076 * If we're already inside safe list traversal and have moved
1077 * multiple works to the scheduled queue, the next position
1078 * needs to be updated.
1079 */
1080 if (nextp)
1081 *nextp = n;
1082}
1083
Tejun Heo8864b4e2013-03-12 11:30:04 -07001084/**
1085 * get_pwq - get an extra reference on the specified pool_workqueue
1086 * @pwq: pool_workqueue to get
1087 *
1088 * Obtain an extra reference on @pwq. The caller should guarantee that
1089 * @pwq has positive refcnt and be holding the matching pool->lock.
1090 */
1091static void get_pwq(struct pool_workqueue *pwq)
1092{
1093 lockdep_assert_held(&pwq->pool->lock);
1094 WARN_ON_ONCE(pwq->refcnt <= 0);
1095 pwq->refcnt++;
1096}
1097
1098/**
1099 * put_pwq - put a pool_workqueue reference
1100 * @pwq: pool_workqueue to put
1101 *
1102 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1103 * destruction. The caller should be holding the matching pool->lock.
1104 */
1105static void put_pwq(struct pool_workqueue *pwq)
1106{
1107 lockdep_assert_held(&pwq->pool->lock);
1108 if (likely(--pwq->refcnt))
1109 return;
1110 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1111 return;
1112 /*
1113 * @pwq can't be released under pool->lock, bounce to
1114 * pwq_unbound_release_workfn(). This never recurses on the same
1115 * pool->lock as this path is taken only for unbound workqueues and
1116 * the release work item is scheduled on a per-cpu workqueue. To
1117 * avoid lockdep warning, unbound pool->locks are given lockdep
1118 * subclass of 1 in get_unbound_pool().
1119 */
1120 schedule_work(&pwq->unbound_release_work);
1121}
1122
Tejun Heodce90d42013-04-01 11:23:35 -07001123/**
1124 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1125 * @pwq: pool_workqueue to put (can be %NULL)
1126 *
1127 * put_pwq() with locking. This function also allows %NULL @pwq.
1128 */
1129static void put_pwq_unlocked(struct pool_workqueue *pwq)
1130{
1131 if (pwq) {
1132 /*
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001133 * As both pwqs and pools are RCU protected, the
Tejun Heodce90d42013-04-01 11:23:35 -07001134 * following lock operations are safe.
1135 */
1136 spin_lock_irq(&pwq->pool->lock);
1137 put_pwq(pwq);
1138 spin_unlock_irq(&pwq->pool->lock);
1139 }
1140}
1141
Tejun Heo112202d2013-02-13 19:29:12 -08001142static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001143{
Tejun Heo112202d2013-02-13 19:29:12 -08001144 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001145
1146 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001147 if (list_empty(&pwq->pool->worklist))
1148 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001149 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001150 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001152}
1153
Tejun Heo112202d2013-02-13 19:29:12 -08001154static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001155{
Tejun Heo112202d2013-02-13 19:29:12 -08001156 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001157 struct work_struct, entry);
1158
Tejun Heo112202d2013-02-13 19:29:12 -08001159 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001160}
1161
Tejun Heobf4ede02012-08-03 10:30:46 -07001162/**
Tejun Heo112202d2013-02-13 19:29:12 -08001163 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1164 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001165 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001166 *
1167 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001168 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001169 *
1170 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001171 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001172 */
Tejun Heo112202d2013-02-13 19:29:12 -08001173static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001174{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001175 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001176 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001177 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001178
Tejun Heo112202d2013-02-13 19:29:12 -08001179 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001180
Tejun Heo112202d2013-02-13 19:29:12 -08001181 pwq->nr_active--;
1182 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001183 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001184 if (pwq->nr_active < pwq->max_active)
1185 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001186 }
1187
1188 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001189 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001190 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001191
1192 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001193 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001194 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001195
Tejun Heo112202d2013-02-13 19:29:12 -08001196 /* this pwq is done, clear flush_color */
1197 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001198
1199 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001200 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001201 * will handle the rest.
1202 */
Tejun Heo112202d2013-02-13 19:29:12 -08001203 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1204 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001205out_put:
1206 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001207}
1208
Tejun Heo36e227d2012-08-03 10:30:46 -07001209/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001210 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001211 * @work: work item to steal
1212 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001213 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 *
1215 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001216 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001217 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001218 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001219 * 1 if @work was pending and we successfully stole PENDING
1220 * 0 if @work was idle and we claimed PENDING
1221 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001222 * -ENOENT if someone else is canceling @work, this state may persist
1223 * for arbitrarily long
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
Tejun Heod565ed62013-01-24 11:01:33 -08001270 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
Tejun Heo16062832013-02-06 18:04:53 -08001299 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 }
Tejun Heod565ed62013-01-24 11:01:33 -08001303 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:
Tejun Heod565ed62013-01-24 11:01:33 -08001324 * 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
Tejun Heo4690c4a2010-06-29 10:07:10 +02001331 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001332 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001333 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001334 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001335
1336 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001337 * Ensure either wq_worker_sleeping() sees the above
1338 * list_add_tail() or we see zero nr_running to avoid workers lying
1339 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001340 */
1341 smp_mb();
1342
Tejun Heo63d95a92012-07-12 14:46:37 -07001343 if (__need_more_worker(pool))
1344 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001345}
1346
Tejun Heoc8efcc22010-12-20 19:32:04 +01001347/*
1348 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001349 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001350 */
1351static bool is_chained_work(struct workqueue_struct *wq)
1352{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001353 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001354
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001355 worker = current_wq_worker();
1356 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001357 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001358 * I'm @worker, it's safe to dereference it without locking.
1359 */
Tejun Heo112202d2013-02-13 19:29:12 -08001360 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001361}
1362
Mike Galbraithef5571802016-02-09 17:59:38 -05001363/*
1364 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1365 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1366 * avoid perturbing sensitive tasks.
1367 */
1368static int wq_select_unbound_cpu(int cpu)
1369{
Tejun Heof303fccb2016-02-09 17:59:38 -05001370 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001371 int new_cpu;
1372
Tejun Heof303fccb2016-02-09 17:59:38 -05001373 if (likely(!wq_debug_force_rr_cpu)) {
1374 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1375 return cpu;
1376 } else if (!printed_dbg_warning) {
1377 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1378 printed_dbg_warning = true;
1379 }
1380
Mike Galbraithef5571802016-02-09 17:59:38 -05001381 if (cpumask_empty(wq_unbound_cpumask))
1382 return cpu;
1383
1384 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1385 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1386 if (unlikely(new_cpu >= nr_cpu_ids)) {
1387 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1388 if (unlikely(new_cpu >= nr_cpu_ids))
1389 return cpu;
1390 }
1391 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1392
1393 return new_cpu;
1394}
1395
Tejun Heod84ff052013-03-12 11:29:59 -07001396static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 struct work_struct *work)
1398{
Tejun Heo112202d2013-02-13 19:29:12 -08001399 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001400 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001401 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001402 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001403 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001404
1405 /*
1406 * While a work item is PENDING && off queue, a task trying to
1407 * steal the PENDING will busy-loop waiting for it to either get
1408 * queued or lose PENDING. Grabbing PENDING and queueing should
1409 * happen with IRQ disabled.
1410 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001411 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001413 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001414
Li Bin9ef28a72013-09-09 13:13:58 +08001415 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001416 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001417 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001418 return;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001419 rcu_read_lock();
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001420retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001421 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001422 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001423
Tejun Heoc9178082013-03-12 11:30:04 -07001424 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001425 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001426 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001427 else
1428 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001429
Tejun Heoc9178082013-03-12 11:30:04 -07001430 /*
1431 * If @work was previously on a different pool, it might still be
1432 * running there, in which case the work needs to be queued on that
1433 * pool to guarantee non-reentrancy.
1434 */
1435 last_pool = get_work_pool(work);
1436 if (last_pool && last_pool != pwq->pool) {
1437 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001438
Tejun Heoc9178082013-03-12 11:30:04 -07001439 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001440
Tejun Heoc9178082013-03-12 11:30:04 -07001441 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001442
Tejun Heoc9178082013-03-12 11:30:04 -07001443 if (worker && worker->current_pwq->wq == wq) {
1444 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001445 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001446 /* meh... not running there, queue here */
1447 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001448 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001449 }
Tejun Heof3421792010-07-02 10:03:51 +02001450 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001451 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001452 }
1453
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001454 /*
1455 * pwq is determined and locked. For unbound pools, we could have
1456 * raced with pwq release and it could already be dead. If its
1457 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001458 * without another pwq replacing it in the numa_pwq_tbl or while
1459 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001460 * make forward-progress.
1461 */
1462 if (unlikely(!pwq->refcnt)) {
1463 if (wq->flags & WQ_UNBOUND) {
1464 spin_unlock(&pwq->pool->lock);
1465 cpu_relax();
1466 goto retry;
1467 }
1468 /* oops */
1469 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1470 wq->name, cpu);
1471 }
1472
Tejun Heo112202d2013-02-13 19:29:12 -08001473 /* pwq determined, queue */
1474 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001475
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001476 if (WARN_ON(!list_empty(&work->entry)))
1477 goto out;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001478
Tejun Heo112202d2013-02-13 19:29:12 -08001479 pwq->nr_in_flight[pwq->work_color]++;
1480 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001481
Tejun Heo112202d2013-02-13 19:29:12 -08001482 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001483 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001484 pwq->nr_active++;
1485 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001486 if (list_empty(worklist))
1487 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001488 } else {
1489 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001490 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001491 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001492
Tejun Heo112202d2013-02-13 19:29:12 -08001493 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001494
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001495out:
Tejun Heo112202d2013-02-13 19:29:12 -08001496 spin_unlock(&pwq->pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01001497 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498}
1499
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001500/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001501 * queue_work_on - queue work on specific cpu
1502 * @cpu: CPU number to execute work on
1503 * @wq: workqueue to use
1504 * @work: work to queue
1505 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001506 * We queue the work to a specific CPU, the caller must ensure it
1507 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001508 *
1509 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001510 */
Tejun Heod4283e92012-08-03 10:30:44 -07001511bool queue_work_on(int cpu, struct workqueue_struct *wq,
1512 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001513{
Tejun Heod4283e92012-08-03 10:30:44 -07001514 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001515 unsigned long flags;
1516
1517 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001518
Tejun Heo22df02b2010-06-29 10:07:10 +02001519 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001520 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001521 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001522 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001523
1524 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001525 return ret;
1526}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001527EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001528
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001529/**
1530 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1531 * @node: NUMA node ID that we want to select a CPU from
1532 *
1533 * This function will attempt to find a "random" cpu available on a given
1534 * node. If there are no CPUs available on the given node it will return
1535 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1536 * available CPU if we need to schedule this work.
1537 */
1538static int workqueue_select_cpu_near(int node)
1539{
1540 int cpu;
1541
1542 /* No point in doing this if NUMA isn't enabled for workqueues */
1543 if (!wq_numa_enabled)
1544 return WORK_CPU_UNBOUND;
1545
1546 /* Delay binding to CPU if node is not valid or online */
1547 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1548 return WORK_CPU_UNBOUND;
1549
1550 /* Use local node/cpu if we are already there */
1551 cpu = raw_smp_processor_id();
1552 if (node == cpu_to_node(cpu))
1553 return cpu;
1554
1555 /* Use "random" otherwise know as "first" online CPU of node */
1556 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1557
1558 /* If CPU is valid return that, otherwise just defer */
1559 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1560}
1561
1562/**
1563 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1564 * @node: NUMA node that we are targeting the work for
1565 * @wq: workqueue to use
1566 * @work: work to queue
1567 *
1568 * We queue the work to a "random" CPU within a given NUMA node. The basic
1569 * idea here is to provide a way to somehow associate work with a given
1570 * NUMA node.
1571 *
1572 * This function will only make a best effort attempt at getting this onto
1573 * the right NUMA node. If no node is requested or the requested node is
1574 * offline then we just fall back to standard queue_work behavior.
1575 *
1576 * Currently the "random" CPU ends up being the first available CPU in the
1577 * intersection of cpu_online_mask and the cpumask of the node, unless we
1578 * are running on the node. In that case we just use the current CPU.
1579 *
1580 * Return: %false if @work was already on a queue, %true otherwise.
1581 */
1582bool queue_work_node(int node, struct workqueue_struct *wq,
1583 struct work_struct *work)
1584{
1585 unsigned long flags;
1586 bool ret = false;
1587
1588 /*
1589 * This current implementation is specific to unbound workqueues.
1590 * Specifically we only return the first available CPU for a given
1591 * node instead of cycling through individual CPUs within the node.
1592 *
1593 * If this is used with a per-cpu workqueue then the logic in
1594 * workqueue_select_cpu_near would need to be updated to allow for
1595 * some round robin type logic.
1596 */
1597 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1598
1599 local_irq_save(flags);
1600
1601 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1602 int cpu = workqueue_select_cpu_near(node);
1603
1604 __queue_work(cpu, wq, work);
1605 ret = true;
1606 }
1607
1608 local_irq_restore(flags);
1609 return ret;
1610}
1611EXPORT_SYMBOL_GPL(queue_work_node);
1612
Kees Cook8c20feb2017-10-04 16:27:07 -07001613void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614{
Kees Cook8c20feb2017-10-04 16:27:07 -07001615 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001617 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001618 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001620EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001622static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1623 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001625 struct timer_list *timer = &dwork->timer;
1626 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
Tejun Heo637fdba2017-03-06 15:33:42 -05001628 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001629 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001630 WARN_ON_ONCE(timer_pending(timer));
1631 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001632
Tejun Heo8852aac2012-12-01 16:23:42 -08001633 /*
1634 * If @delay is 0, queue @dwork->work immediately. This is for
1635 * both optimization and correctness. The earliest @timer can
1636 * expire is on the closest next tick and delayed_work users depend
1637 * on that there's no such delay when @delay is 0.
1638 */
1639 if (!delay) {
1640 __queue_work(cpu, wq, &dwork->work);
1641 return;
1642 }
1643
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001644 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001645 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001646 timer->expires = jiffies + delay;
1647
Tejun Heo041bd122016-02-09 16:11:26 -05001648 if (unlikely(cpu != WORK_CPU_UNBOUND))
1649 add_timer_on(timer, cpu);
1650 else
1651 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652}
1653
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001654/**
1655 * queue_delayed_work_on - queue work on specific CPU after delay
1656 * @cpu: CPU number to execute work on
1657 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001658 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001659 * @delay: number of jiffies to wait before queueing
1660 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001661 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001662 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1663 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001664 */
Tejun Heod4283e92012-08-03 10:30:44 -07001665bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1666 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001667{
David Howells52bad642006-11-22 14:54:01 +00001668 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001669 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001670 unsigned long flags;
1671
1672 /* read the comment in __queue_work() */
1673 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001674
Tejun Heo22df02b2010-06-29 10:07:10 +02001675 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001676 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001677 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001678 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001679
1680 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001681 return ret;
1682}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001683EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
Tejun Heoc8e55f32010-06-29 10:07:12 +02001685/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001686 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1687 * @cpu: CPU number to execute work on
1688 * @wq: workqueue to use
1689 * @dwork: work to queue
1690 * @delay: number of jiffies to wait before queueing
1691 *
1692 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1693 * modify @dwork's timer so that it expires after @delay. If @delay is
1694 * zero, @work is guaranteed to be scheduled immediately regardless of its
1695 * current state.
1696 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001697 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001698 * pending and its timer was modified.
1699 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001700 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001701 * See try_to_grab_pending() for details.
1702 */
1703bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1704 struct delayed_work *dwork, unsigned long delay)
1705{
1706 unsigned long flags;
1707 int ret;
1708
1709 do {
1710 ret = try_to_grab_pending(&dwork->work, true, &flags);
1711 } while (unlikely(ret == -EAGAIN));
1712
1713 if (likely(ret >= 0)) {
1714 __queue_delayed_work(cpu, wq, dwork, delay);
1715 local_irq_restore(flags);
1716 }
1717
1718 /* -ENOENT from try_to_grab_pending() becomes %true */
1719 return ret;
1720}
1721EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1722
Tejun Heo05f0fe62018-03-14 12:45:13 -07001723static void rcu_work_rcufn(struct rcu_head *rcu)
1724{
1725 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1726
1727 /* read the comment in __queue_work() */
1728 local_irq_disable();
1729 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1730 local_irq_enable();
1731}
1732
1733/**
1734 * queue_rcu_work - queue work after a RCU grace period
1735 * @wq: workqueue to use
1736 * @rwork: work to queue
1737 *
1738 * Return: %false if @rwork was already pending, %true otherwise. Note
1739 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001740 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001741 * execution may happen before a full RCU grace period has passed.
1742 */
1743bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1744{
1745 struct work_struct *work = &rwork->work;
1746
1747 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1748 rwork->wq = wq;
1749 call_rcu(&rwork->rcu, rcu_work_rcufn);
1750 return true;
1751 }
1752
1753 return false;
1754}
1755EXPORT_SYMBOL(queue_rcu_work);
1756
Tejun Heo8376fe22012-08-03 10:30:47 -07001757/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001758 * worker_enter_idle - enter idle state
1759 * @worker: worker which is entering idle state
1760 *
1761 * @worker is entering idle state. Update stats and idle timer if
1762 * necessary.
1763 *
1764 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001765 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001766 */
1767static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001769 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770
Tejun Heo6183c002013-03-12 11:29:57 -07001771 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1772 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1773 (worker->hentry.next || worker->hentry.pprev)))
1774 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775
Lai Jiangshan051e1852014-07-22 13:03:02 +08001776 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001777 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001778 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001779 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001780
Tejun Heoc8e55f32010-06-29 10:07:12 +02001781 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001782 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001783
Tejun Heo628c78e2012-07-17 12:39:27 -07001784 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1785 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001786
Tejun Heo544ecf32012-05-14 15:04:50 -07001787 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001788 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001789 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001790 * nr_running, the warning may trigger spuriously. Check iff
1791 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001792 */
Tejun Heo24647572013-01-24 11:01:33 -08001793 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001794 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001795 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796}
1797
Tejun Heoc8e55f32010-06-29 10:07:12 +02001798/**
1799 * worker_leave_idle - leave idle state
1800 * @worker: worker which is leaving idle state
1801 *
1802 * @worker is leaving idle state. Update stats.
1803 *
1804 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001805 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001806 */
1807static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001809 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
Tejun Heo6183c002013-03-12 11:29:57 -07001811 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1812 return;
Tejun Heod302f012010-06-29 10:07:13 +02001813 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001814 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001815 list_del_init(&worker->entry);
1816}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001818static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001819{
1820 struct worker *worker;
1821
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001822 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001823 if (worker) {
1824 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001825 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001826 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001827 /* on creation a worker is in !idle && prep state */
1828 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001829 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001830 return worker;
1831}
1832
1833/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001834 * worker_attach_to_pool() - attach a worker to a pool
1835 * @worker: worker to be attached
1836 * @pool: the target pool
1837 *
1838 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1839 * cpu-binding of @worker are kept coordinated with the pool across
1840 * cpu-[un]hotplugs.
1841 */
1842static void worker_attach_to_pool(struct worker *worker,
1843 struct worker_pool *pool)
1844{
Tejun Heo1258fae2018-05-18 08:47:13 -07001845 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001846
1847 /*
1848 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1849 * online CPUs. It'll be re-applied when any of the CPUs come up.
1850 */
1851 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1852
1853 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001854 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1855 * stable across this function. See the comments above the flag
1856 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001857 */
1858 if (pool->flags & POOL_DISASSOCIATED)
1859 worker->flags |= WORKER_UNBOUND;
1860
1861 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001862 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001863
Tejun Heo1258fae2018-05-18 08:47:13 -07001864 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001865}
1866
1867/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001868 * worker_detach_from_pool() - detach a worker from its pool
1869 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001870 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001871 * Undo the attaching which had been done in worker_attach_to_pool(). The
1872 * caller worker shouldn't access to the pool after detached except it has
1873 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001874 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001875static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001876{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001877 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001878 struct completion *detach_completion = NULL;
1879
Tejun Heo1258fae2018-05-18 08:47:13 -07001880 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001881
Lai Jiangshanda028462014-05-20 17:46:31 +08001882 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001883 worker->pool = NULL;
1884
Lai Jiangshanda028462014-05-20 17:46:31 +08001885 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001886 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001887 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001888
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001889 /* clear leftover flags without pool->lock after it is detached */
1890 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1891
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001892 if (detach_completion)
1893 complete(detach_completion);
1894}
1895
1896/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001897 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001898 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001899 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001900 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001901 *
1902 * CONTEXT:
1903 * Might sleep. Does GFP_KERNEL allocations.
1904 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001905 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001906 * Pointer to the newly created worker.
1907 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001908static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001909{
Tejun Heoc34056a2010-06-29 10:07:11 +02001910 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001911 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001912 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001913
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001914 /* ID is needed to determine kthread name */
1915 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001916 if (id < 0)
1917 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001918
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001919 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001920 if (!worker)
1921 goto fail;
1922
Tejun Heoc34056a2010-06-29 10:07:11 +02001923 worker->id = id;
1924
Tejun Heo29c91e92013-03-12 11:30:03 -07001925 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001926 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1927 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001928 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001929 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1930
Tejun Heof3f90ad2013-04-01 11:23:34 -07001931 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001932 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001933 if (IS_ERR(worker->task))
1934 goto fail;
1935
Oleg Nesterov91151222013-11-14 12:56:18 +01001936 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001937 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001938
Lai Jiangshanda028462014-05-20 17:46:31 +08001939 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001940 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001941
Lai Jiangshan051e1852014-07-22 13:03:02 +08001942 /* start the newly created worker */
1943 spin_lock_irq(&pool->lock);
1944 worker->pool->nr_workers++;
1945 worker_enter_idle(worker);
1946 wake_up_process(worker->task);
1947 spin_unlock_irq(&pool->lock);
1948
Tejun Heoc34056a2010-06-29 10:07:11 +02001949 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001950
Tejun Heoc34056a2010-06-29 10:07:11 +02001951fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001952 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001953 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001954 kfree(worker);
1955 return NULL;
1956}
1957
1958/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 * destroy_worker - destroy a workqueue worker
1960 * @worker: worker to be destroyed
1961 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001962 * Destroy @worker and adjust @pool stats accordingly. The worker should
1963 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001964 *
1965 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001966 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001967 */
1968static void destroy_worker(struct worker *worker)
1969{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001970 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001971
Tejun Heocd549682013-03-13 19:47:39 -07001972 lockdep_assert_held(&pool->lock);
1973
Tejun Heoc34056a2010-06-29 10:07:11 +02001974 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001975 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001976 WARN_ON(!list_empty(&worker->scheduled)) ||
1977 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001978 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001979
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001980 pool->nr_workers--;
1981 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001982
Tejun Heoc8e55f32010-06-29 10:07:12 +02001983 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001984 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001985 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001986}
1987
Kees Cook32a6c722017-10-16 15:58:25 -07001988static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001989{
Kees Cook32a6c722017-10-16 15:58:25 -07001990 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001991
Tejun Heod565ed62013-01-24 11:01:33 -08001992 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001993
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001994 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001995 struct worker *worker;
1996 unsigned long expires;
1997
1998 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001999 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2001
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002002 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002003 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002004 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002006
2007 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002008 }
2009
Tejun Heod565ed62013-01-24 11:01:33 -08002010 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002011}
2012
Tejun Heo493a1722013-03-12 11:29:59 -07002013static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002014{
Tejun Heo112202d2013-02-13 19:29:12 -08002015 struct pool_workqueue *pwq = get_work_pwq(work);
2016 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002017
Tejun Heo2e109a22013-03-13 19:47:40 -07002018 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002019
Tejun Heo493008a2013-03-12 11:30:03 -07002020 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002021 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002022
2023 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002024 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002025 /*
2026 * If @pwq is for an unbound wq, its base ref may be put at
2027 * any time due to an attribute change. Pin @pwq until the
2028 * rescuer is done with it.
2029 */
2030 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002031 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002032 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002033 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002034}
2035
Kees Cook32a6c722017-10-16 15:58:25 -07002036static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002037{
Kees Cook32a6c722017-10-16 15:58:25 -07002038 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002039 struct work_struct *work;
2040
Tejun Heob2d82902014-12-08 12:39:16 -05002041 spin_lock_irq(&pool->lock);
2042 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002043
Tejun Heo63d95a92012-07-12 14:46:37 -07002044 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002045 /*
2046 * We've been trying to create a new worker but
2047 * haven't been successful. We might be hitting an
2048 * allocation deadlock. Send distress signals to
2049 * rescuers.
2050 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002051 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002052 send_mayday(work);
2053 }
2054
Tejun Heob2d82902014-12-08 12:39:16 -05002055 spin_unlock(&wq_mayday_lock);
2056 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002057
Tejun Heo63d95a92012-07-12 14:46:37 -07002058 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002059}
2060
2061/**
2062 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002063 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002064 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002065 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002066 * have at least one idle worker on return from this function. If
2067 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002068 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002069 * possible allocation deadlock.
2070 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002071 * On return, need_to_create_worker() is guaranteed to be %false and
2072 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002073 *
2074 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08002075 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002076 * multiple times. Does GFP_KERNEL allocations. Called only from
2077 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002078 */
Tejun Heo29187a92015-01-16 14:21:16 -05002079static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002080__releases(&pool->lock)
2081__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002082{
Tejun Heoe22bee72010-06-29 10:07:14 +02002083restart:
Tejun Heod565ed62013-01-24 11:01:33 -08002084 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002085
Tejun Heoe22bee72010-06-29 10:07:14 +02002086 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002087 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002088
2089 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002090 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002091 break;
2092
Lai Jiangshane212f362014-06-03 15:32:17 +08002093 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002094
Tejun Heo63d95a92012-07-12 14:46:37 -07002095 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002096 break;
2097 }
2098
Tejun Heo63d95a92012-07-12 14:46:37 -07002099 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08002100 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002101 /*
2102 * This is necessary even after a new worker was just successfully
2103 * created as @pool->lock was dropped and the new worker might have
2104 * already become busy.
2105 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002106 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002107 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002108}
2109
2110/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002111 * manage_workers - manage worker pool
2112 * @worker: self
2113 *
Tejun Heo706026c2013-01-24 11:01:34 -08002114 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002115 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002116 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002117 *
2118 * The caller can safely start processing works on false return. On
2119 * true return, it's guaranteed that need_to_create_worker() is false
2120 * and may_start_working() is true.
2121 *
2122 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002123 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002124 * multiple times. Does GFP_KERNEL allocations.
2125 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002126 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002127 * %false if the pool doesn't need management and the caller can safely
2128 * start processing works, %true if management function was performed and
2129 * the conditions that the caller verified before calling the function may
2130 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002131 */
2132static bool manage_workers(struct worker *worker)
2133{
Tejun Heo63d95a92012-07-12 14:46:37 -07002134 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002135
Tejun Heo692b4822017-10-09 08:04:13 -07002136 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002137 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002138
2139 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002140 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002141
Tejun Heo29187a92015-01-16 14:21:16 -05002142 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002143
Tejun Heo2607d7a2015-03-09 09:22:28 -04002144 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002145 pool->flags &= ~POOL_MANAGER_ACTIVE;
2146 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002147 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002148}
2149
Tejun Heoa62428c2010-06-29 10:07:10 +02002150/**
2151 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002152 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002153 * @work: work to process
2154 *
2155 * Process @work. This function contains all the logics necessary to
2156 * process a single work including synchronization against and
2157 * interaction with other workers on the same cpu, queueing and
2158 * flushing. As long as context requirement is met, any worker can
2159 * call this function to process a work.
2160 *
2161 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002162 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002163 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002164static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002165__releases(&pool->lock)
2166__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002167{
Tejun Heo112202d2013-02-13 19:29:12 -08002168 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002169 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002170 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002171 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002172 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002173#ifdef CONFIG_LOCKDEP
2174 /*
2175 * It is permissible to free the struct work_struct from
2176 * inside the function that is called from it, this we need to
2177 * take into account for lockdep too. To avoid bogus "held
2178 * lock freed" warnings as well as problems when looking into
2179 * work->lockdep_map, make a copy and use that here.
2180 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002181 struct lockdep_map lockdep_map;
2182
2183 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002184#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002185 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002186 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002187 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002188
Tejun Heo7e116292010-06-29 10:07:13 +02002189 /*
2190 * A single work shouldn't be executed concurrently by
2191 * multiple workers on a single cpu. Check whether anyone is
2192 * already processing the work. If so, defer the work to the
2193 * currently executing one.
2194 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002195 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002196 if (unlikely(collision)) {
2197 move_linked_works(work, &collision->scheduled, NULL);
2198 return;
2199 }
2200
Tejun Heo8930cab2012-08-03 10:30:45 -07002201 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002202 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002203 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002204 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002205 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002206 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002207 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002208
Tejun Heo8bf89592018-05-18 08:47:13 -07002209 /*
2210 * Record wq name for cmdline and debug reporting, may get
2211 * overridden through set_worker_desc().
2212 */
2213 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2214
Tejun Heoa62428c2010-06-29 10:07:10 +02002215 list_del_init(&work->entry);
2216
Tejun Heo649027d2010-06-29 10:07:14 +02002217 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002218 * CPU intensive works don't participate in concurrency management.
2219 * They're the scheduler's responsibility. This takes @worker out
2220 * of concurrency management and the next code block will chain
2221 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002222 */
2223 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002224 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002225
Tejun Heo974271c42012-07-12 14:46:37 -07002226 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002227 * Wake up another worker if necessary. The condition is always
2228 * false for normal per-cpu workers since nr_running would always
2229 * be >= 1 at this point. This is used to chain execution of the
2230 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002231 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002232 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002233 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002234 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002235
Tejun Heo8930cab2012-08-03 10:30:45 -07002236 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002237 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002238 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002239 * PENDING and queued state changes happen together while IRQ is
2240 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002241 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002242 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002243
Tejun Heod565ed62013-01-24 11:01:33 -08002244 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002245
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002246 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002247 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002248 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002249 * Strictly speaking we should mark the invariant state without holding
2250 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002251 *
2252 * However, that would result in:
2253 *
2254 * A(W1)
2255 * WFC(C)
2256 * A(W1)
2257 * C(C)
2258 *
2259 * Which would create W1->C->W1 dependencies, even though there is no
2260 * actual deadlock possible. There are two solutions, using a
2261 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002262 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002263 * these locks.
2264 *
2265 * AFAICT there is no possible deadlock scenario between the
2266 * flush_work() and complete() primitives (except for single-threaded
2267 * workqueues), so hiding them isn't a problem.
2268 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002269 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002270 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002271 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002272 /*
2273 * While we must be careful to not use "work" after this, the trace
2274 * point will only record its address.
2275 */
2276 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002277 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002278 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002279
2280 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002281 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
Sakari Ailusd75f7732019-03-25 21:32:28 +02002282 " last function: %ps\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002283 current->comm, preempt_count(), task_pid_nr(current),
2284 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002285 debug_show_held_locks(current);
2286 dump_stack();
2287 }
2288
Tejun Heob22ce272013-08-28 17:33:37 -04002289 /*
2290 * The following prevents a kworker from hogging CPU on !PREEMPT
2291 * kernels, where a requeueing work item waiting for something to
2292 * happen could deadlock with stop_machine as such work item could
2293 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002294 * stop_machine. At the same time, report a quiescent RCU state so
2295 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002296 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002297 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002298
Tejun Heod565ed62013-01-24 11:01:33 -08002299 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002300
Tejun Heofb0e7be2010-06-29 10:07:15 +02002301 /* clear cpu intensive status */
2302 if (unlikely(cpu_intensive))
2303 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2304
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002305 /* tag the worker for identification in schedule() */
2306 worker->last_func = worker->current_func;
2307
Tejun Heoa62428c2010-06-29 10:07:10 +02002308 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002309 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002310 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002311 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002312 worker->current_pwq = NULL;
2313 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002314}
2315
Tejun Heoaffee4b2010-06-29 10:07:12 +02002316/**
2317 * process_scheduled_works - process scheduled works
2318 * @worker: self
2319 *
2320 * Process all scheduled works. Please note that the scheduled list
2321 * may change while processing a work, so this function repeatedly
2322 * fetches a work from the top and executes it.
2323 *
2324 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002325 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002326 * multiple times.
2327 */
2328static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002330 while (!list_empty(&worker->scheduled)) {
2331 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002333 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335}
2336
Tejun Heo197f6ac2018-05-21 08:04:35 -07002337static void set_pf_worker(bool val)
2338{
2339 mutex_lock(&wq_pool_attach_mutex);
2340 if (val)
2341 current->flags |= PF_WQ_WORKER;
2342 else
2343 current->flags &= ~PF_WQ_WORKER;
2344 mutex_unlock(&wq_pool_attach_mutex);
2345}
2346
Tejun Heo4690c4a2010-06-29 10:07:10 +02002347/**
2348 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002349 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002350 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002351 * The worker thread function. All workers belong to a worker_pool -
2352 * either a per-cpu one or dynamic unbound one. These workers process all
2353 * work items regardless of their specific target workqueue. The only
2354 * exception is work items which belong to workqueues with a rescuer which
2355 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002356 *
2357 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002358 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002359static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360{
Tejun Heoc34056a2010-06-29 10:07:11 +02002361 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002362 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363
Tejun Heoe22bee72010-06-29 10:07:14 +02002364 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002365 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002366woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002367 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002368
Tejun Heoa9ab7752013-03-19 13:45:21 -07002369 /* am I supposed to die? */
2370 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002371 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002372 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002373 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002374
2375 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002376 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002377 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002378 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002379 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002381
Tejun Heoc8e55f32010-06-29 10:07:12 +02002382 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002383recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002384 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002385 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002386 goto sleep;
2387
2388 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002389 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002390 goto recheck;
2391
Tejun Heoc8e55f32010-06-29 10:07:12 +02002392 /*
2393 * ->scheduled list can only be filled while a worker is
2394 * preparing to process a work or actually processing it.
2395 * Make sure nobody diddled with it while I was sleeping.
2396 */
Tejun Heo6183c002013-03-12 11:29:57 -07002397 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002398
Tejun Heoe22bee72010-06-29 10:07:14 +02002399 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002400 * Finish PREP stage. We're guaranteed to have at least one idle
2401 * worker or that someone else has already assumed the manager
2402 * role. This is where @worker starts participating in concurrency
2403 * management if applicable and concurrency management is restored
2404 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002405 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002406 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002407
2408 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002409 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002410 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002411 struct work_struct, entry);
2412
Tejun Heo82607adc2015-12-08 11:28:04 -05002413 pool->watchdog_ts = jiffies;
2414
Tejun Heoc8e55f32010-06-29 10:07:12 +02002415 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2416 /* optimization path, not strictly necessary */
2417 process_one_work(worker, work);
2418 if (unlikely(!list_empty(&worker->scheduled)))
2419 process_scheduled_works(worker);
2420 } else {
2421 move_linked_works(work, &worker->scheduled, NULL);
2422 process_scheduled_works(worker);
2423 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002424 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002425
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002426 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002427sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002428 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002429 * pool->lock is held and there's no work to process and no need to
2430 * manage, sleep. Workers are woken up only while holding
2431 * pool->lock or from local cpu, so setting the current state
2432 * before releasing pool->lock is enough to prevent losing any
2433 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002434 */
2435 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002436 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002437 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002438 schedule();
2439 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440}
2441
Tejun Heoe22bee72010-06-29 10:07:14 +02002442/**
2443 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002444 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002445 *
2446 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002447 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002448 *
Tejun Heo706026c2013-01-24 11:01:34 -08002449 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002450 * worker which uses GFP_KERNEL allocation which has slight chance of
2451 * developing into deadlock if some works currently on the same queue
2452 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2453 * the problem rescuer solves.
2454 *
Tejun Heo706026c2013-01-24 11:01:34 -08002455 * When such condition is possible, the pool summons rescuers of all
2456 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002457 * those works so that forward progress can be guaranteed.
2458 *
2459 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002460 *
2461 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002462 */
Tejun Heo111c2252013-01-17 17:16:24 -08002463static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002464{
Tejun Heo111c2252013-01-17 17:16:24 -08002465 struct worker *rescuer = __rescuer;
2466 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002467 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002468 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002469
2470 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002471
2472 /*
2473 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2474 * doesn't participate in concurrency management.
2475 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002476 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002477repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002478 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002479
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002480 /*
2481 * By the time the rescuer is requested to stop, the workqueue
2482 * shouldn't have any work pending, but @wq->maydays may still have
2483 * pwq(s) queued. This can happen by non-rescuer workers consuming
2484 * all the work items before the rescuer got to them. Go through
2485 * @wq->maydays processing before acting on should_stop so that the
2486 * list is always empty on exit.
2487 */
2488 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002489
Tejun Heo493a1722013-03-12 11:29:59 -07002490 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002491 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002492
2493 while (!list_empty(&wq->maydays)) {
2494 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2495 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002496 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002497 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002498 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002499
2500 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002501 list_del_init(&pwq->mayday_node);
2502
Tejun Heo2e109a22013-03-13 19:47:40 -07002503 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002504
Lai Jiangshan51697d392014-05-20 17:46:36 +08002505 worker_attach_to_pool(rescuer, pool);
2506
2507 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002508
2509 /*
2510 * Slurp in all works issued via this workqueue and
2511 * process'em.
2512 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002513 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002514 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2515 if (get_work_pwq(work) == pwq) {
2516 if (first)
2517 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002518 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002519 }
2520 first = false;
2521 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002522
NeilBrown008847f2014-12-08 12:39:16 -05002523 if (!list_empty(scheduled)) {
2524 process_scheduled_works(rescuer);
2525
2526 /*
2527 * The above execution of rescued work items could
2528 * have created more to rescue through
2529 * pwq_activate_first_delayed() or chained
2530 * queueing. Let's put @pwq back on mayday list so
2531 * that such back-to-back work items, which may be
2532 * being used to relieve memory pressure, don't
2533 * incur MAYDAY_INTERVAL delay inbetween.
2534 */
2535 if (need_to_create_worker(pool)) {
2536 spin_lock(&wq_mayday_lock);
Tejun Heoe66b39a2019-09-25 06:59:15 -07002537 /*
2538 * Queue iff we aren't racing destruction
2539 * and somebody else hasn't queued it already.
2540 */
2541 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2542 get_pwq(pwq);
2543 list_add_tail(&pwq->mayday_node, &wq->maydays);
2544 }
NeilBrown008847f2014-12-08 12:39:16 -05002545 spin_unlock(&wq_mayday_lock);
2546 }
2547 }
Tejun Heo75769582011-02-14 14:04:46 +01002548
2549 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002550 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002551 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002552 */
2553 put_pwq(pwq);
2554
2555 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002556 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002557 * regular worker; otherwise, we end up with 0 concurrency
2558 * and stalling the execution.
2559 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002560 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002561 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002562
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002563 spin_unlock_irq(&pool->lock);
2564
Tejun Heoa2d812a2018-05-18 08:47:13 -07002565 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002566
2567 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002568 }
2569
Tejun Heo2e109a22013-03-13 19:47:40 -07002570 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002571
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002572 if (should_stop) {
2573 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002574 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002575 return 0;
2576 }
2577
Tejun Heo111c2252013-01-17 17:16:24 -08002578 /* rescuers should never participate in concurrency management */
2579 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002580 schedule();
2581 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582}
2583
Tejun Heofca839c2015-12-07 10:58:57 -05002584/**
2585 * check_flush_dependency - check for flush dependency sanity
2586 * @target_wq: workqueue being flushed
2587 * @target_work: work item being flushed (NULL for workqueue flushes)
2588 *
2589 * %current is trying to flush the whole @target_wq or @target_work on it.
2590 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2591 * reclaiming memory or running on a workqueue which doesn't have
2592 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2593 * a deadlock.
2594 */
2595static void check_flush_dependency(struct workqueue_struct *target_wq,
2596 struct work_struct *target_work)
2597{
2598 work_func_t target_func = target_work ? target_work->func : NULL;
2599 struct worker *worker;
2600
2601 if (target_wq->flags & WQ_MEM_RECLAIM)
2602 return;
2603
2604 worker = current_wq_worker();
2605
2606 WARN_ONCE(current->flags & PF_MEMALLOC,
Sakari Ailusd75f7732019-03-25 21:32:28 +02002607 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002608 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002609 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2610 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Sakari Ailusd75f7732019-03-25 21:32:28 +02002611 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
Tejun Heofca839c2015-12-07 10:58:57 -05002612 worker->current_pwq->wq->name, worker->current_func,
2613 target_wq->name, target_func);
2614}
2615
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002616struct wq_barrier {
2617 struct work_struct work;
2618 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002619 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002620};
2621
2622static void wq_barrier_func(struct work_struct *work)
2623{
2624 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2625 complete(&barr->done);
2626}
2627
Tejun Heo4690c4a2010-06-29 10:07:10 +02002628/**
2629 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002630 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002631 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002632 * @target: target work to attach @barr to
2633 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002634 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002635 * @barr is linked to @target such that @barr is completed only after
2636 * @target finishes execution. Please note that the ordering
2637 * guarantee is observed only with respect to @target and on the local
2638 * cpu.
2639 *
2640 * Currently, a queued barrier can't be canceled. This is because
2641 * try_to_grab_pending() can't determine whether the work to be
2642 * grabbed is at the head of the queue and thus can't clear LINKED
2643 * flag of the previous work while there must be a valid next work
2644 * after a work with LINKED flag set.
2645 *
2646 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002647 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002648 *
2649 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002650 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002651 */
Tejun Heo112202d2013-02-13 19:29:12 -08002652static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002653 struct wq_barrier *barr,
2654 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002655{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002656 struct list_head *head;
2657 unsigned int linked = 0;
2658
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002659 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002660 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002661 * as we know for sure that this will not trigger any of the
2662 * checks and call back into the fixup functions where we
2663 * might deadlock.
2664 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002665 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002666 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002667
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002668 init_completion_map(&barr->done, &target->lockdep_map);
2669
Tejun Heo2607d7a2015-03-09 09:22:28 -04002670 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002671
Tejun Heoaffee4b2010-06-29 10:07:12 +02002672 /*
2673 * If @target is currently being executed, schedule the
2674 * barrier to the worker; otherwise, put it after @target.
2675 */
2676 if (worker)
2677 head = worker->scheduled.next;
2678 else {
2679 unsigned long *bits = work_data_bits(target);
2680
2681 head = target->entry.next;
2682 /* there can already be other linked works, inherit and set */
2683 linked = *bits & WORK_STRUCT_LINKED;
2684 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2685 }
2686
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002687 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002688 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002689 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002690}
2691
Tejun Heo73f53c42010-06-29 10:07:11 +02002692/**
Tejun Heo112202d2013-02-13 19:29:12 -08002693 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002694 * @wq: workqueue being flushed
2695 * @flush_color: new flush color, < 0 for no-op
2696 * @work_color: new work color, < 0 for no-op
2697 *
Tejun Heo112202d2013-02-13 19:29:12 -08002698 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002699 *
Tejun Heo112202d2013-02-13 19:29:12 -08002700 * If @flush_color is non-negative, flush_color on all pwqs should be
2701 * -1. If no pwq has in-flight commands at the specified color, all
2702 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2703 * has in flight commands, its pwq->flush_color is set to
2704 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002705 * wakeup logic is armed and %true is returned.
2706 *
2707 * The caller should have initialized @wq->first_flusher prior to
2708 * calling this function with non-negative @flush_color. If
2709 * @flush_color is negative, no flush color update is done and %false
2710 * is returned.
2711 *
Tejun Heo112202d2013-02-13 19:29:12 -08002712 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002713 * work_color which is previous to @work_color and all will be
2714 * advanced to @work_color.
2715 *
2716 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002717 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002718 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002719 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002720 * %true if @flush_color >= 0 and there's something to flush. %false
2721 * otherwise.
2722 */
Tejun Heo112202d2013-02-13 19:29:12 -08002723static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002724 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725{
Tejun Heo73f53c42010-06-29 10:07:11 +02002726 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002727 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002728
Tejun Heo73f53c42010-06-29 10:07:11 +02002729 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002730 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002731 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002732 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002733
Tejun Heo49e3cf42013-03-12 11:29:58 -07002734 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002735 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002736
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002737 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002738
2739 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002740 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002741
Tejun Heo112202d2013-02-13 19:29:12 -08002742 if (pwq->nr_in_flight[flush_color]) {
2743 pwq->flush_color = flush_color;
2744 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002745 wait = true;
2746 }
2747 }
2748
2749 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002750 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002751 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002752 }
2753
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002754 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002755 }
2756
Tejun Heo112202d2013-02-13 19:29:12 -08002757 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002758 complete(&wq->first_flusher->done);
2759
2760 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761}
2762
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002763/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002765 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002767 * This function sleeps until all work items which were queued on entry
2768 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002770void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771{
Tejun Heo73f53c42010-06-29 10:07:11 +02002772 struct wq_flusher this_flusher = {
2773 .list = LIST_HEAD_INIT(this_flusher.list),
2774 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002775 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002776 };
2777 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002778
Tejun Heo3347fa02016-09-16 15:49:32 -04002779 if (WARN_ON(!wq_online))
2780 return;
2781
Johannes Berg87915ad2018-08-22 11:49:04 +02002782 lock_map_acquire(&wq->lockdep_map);
2783 lock_map_release(&wq->lockdep_map);
2784
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002785 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002786
2787 /*
2788 * Start-to-wait phase
2789 */
2790 next_color = work_next_color(wq->work_color);
2791
2792 if (next_color != wq->flush_color) {
2793 /*
2794 * Color space is not full. The current work_color
2795 * becomes our flush_color and work_color is advanced
2796 * by one.
2797 */
Tejun Heo6183c002013-03-12 11:29:57 -07002798 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002799 this_flusher.flush_color = wq->work_color;
2800 wq->work_color = next_color;
2801
2802 if (!wq->first_flusher) {
2803 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002804 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002805
2806 wq->first_flusher = &this_flusher;
2807
Tejun Heo112202d2013-02-13 19:29:12 -08002808 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002809 wq->work_color)) {
2810 /* nothing to flush, done */
2811 wq->flush_color = next_color;
2812 wq->first_flusher = NULL;
2813 goto out_unlock;
2814 }
2815 } else {
2816 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002817 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002818 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002819 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002820 }
2821 } else {
2822 /*
2823 * Oops, color space is full, wait on overflow queue.
2824 * The next flush completion will assign us
2825 * flush_color and transfer to flusher_queue.
2826 */
2827 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2828 }
2829
Tejun Heofca839c2015-12-07 10:58:57 -05002830 check_flush_dependency(wq, NULL);
2831
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002832 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002833
2834 wait_for_completion(&this_flusher.done);
2835
2836 /*
2837 * Wake-up-and-cascade phase
2838 *
2839 * First flushers are responsible for cascading flushes and
2840 * handling overflow. Non-first flushers can simply return.
2841 */
2842 if (wq->first_flusher != &this_flusher)
2843 return;
2844
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002845 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002846
Tejun Heo4ce48b32010-07-02 10:03:51 +02002847 /* we might have raced, check again with mutex held */
2848 if (wq->first_flusher != &this_flusher)
2849 goto out_unlock;
2850
Tejun Heo73f53c42010-06-29 10:07:11 +02002851 wq->first_flusher = NULL;
2852
Tejun Heo6183c002013-03-12 11:29:57 -07002853 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2854 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002855
2856 while (true) {
2857 struct wq_flusher *next, *tmp;
2858
2859 /* complete all the flushers sharing the current flush color */
2860 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2861 if (next->flush_color != wq->flush_color)
2862 break;
2863 list_del_init(&next->list);
2864 complete(&next->done);
2865 }
2866
Tejun Heo6183c002013-03-12 11:29:57 -07002867 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2868 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002869
2870 /* this flush_color is finished, advance by one */
2871 wq->flush_color = work_next_color(wq->flush_color);
2872
2873 /* one color has been freed, handle overflow queue */
2874 if (!list_empty(&wq->flusher_overflow)) {
2875 /*
2876 * Assign the same color to all overflowed
2877 * flushers, advance work_color and append to
2878 * flusher_queue. This is the start-to-wait
2879 * phase for these overflowed flushers.
2880 */
2881 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2882 tmp->flush_color = wq->work_color;
2883
2884 wq->work_color = work_next_color(wq->work_color);
2885
2886 list_splice_tail_init(&wq->flusher_overflow,
2887 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002888 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002889 }
2890
2891 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002892 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002893 break;
2894 }
2895
2896 /*
2897 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002898 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002899 */
Tejun Heo6183c002013-03-12 11:29:57 -07002900 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2901 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002902
2903 list_del_init(&next->list);
2904 wq->first_flusher = next;
2905
Tejun Heo112202d2013-02-13 19:29:12 -08002906 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002907 break;
2908
2909 /*
2910 * Meh... this color is already done, clear first
2911 * flusher and repeat cascading.
2912 */
2913 wq->first_flusher = NULL;
2914 }
2915
2916out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002917 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002919EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002921/**
2922 * drain_workqueue - drain a workqueue
2923 * @wq: workqueue to drain
2924 *
2925 * Wait until the workqueue becomes empty. While draining is in progress,
2926 * only chain queueing is allowed. IOW, only currently pending or running
2927 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002928 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002929 * by the depth of chaining and should be relatively short. Whine if it
2930 * takes too long.
2931 */
2932void drain_workqueue(struct workqueue_struct *wq)
2933{
2934 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002935 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002936
2937 /*
2938 * __queue_work() needs to test whether there are drainers, is much
2939 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002940 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002941 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002942 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002943 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002944 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002945 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002946reflush:
2947 flush_workqueue(wq);
2948
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002949 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002950
Tejun Heo49e3cf42013-03-12 11:29:58 -07002951 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002952 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002953
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002954 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002955 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002956 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002957
2958 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002959 continue;
2960
2961 if (++flush_cnt == 10 ||
2962 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002963 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002964 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002965
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002966 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002967 goto reflush;
2968 }
2969
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002970 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002971 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002972 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002973}
2974EXPORT_SYMBOL_GPL(drain_workqueue);
2975
Johannes Bergd6e89782018-08-22 11:49:03 +02002976static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2977 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002978{
2979 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002980 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002981 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002982
2983 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002984
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002985 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002986 pool = get_work_pool(work);
2987 if (!pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002988 rcu_read_unlock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07002989 return false;
2990 }
2991
Thomas Gleixner24acfb72019-03-13 17:55:47 +01002992 spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002993 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002994 pwq = get_work_pwq(work);
2995 if (pwq) {
2996 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002997 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002998 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002999 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02003000 if (!worker)
3001 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08003002 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07003003 }
Tejun Heobaf59022010-09-16 10:42:16 +02003004
Tejun Heofca839c2015-12-07 10:58:57 -05003005 check_flush_dependency(pwq->wq, work);
3006
Tejun Heo112202d2013-02-13 19:29:12 -08003007 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003008 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003009
Tejun Heoe159489b2011-01-09 23:32:15 +01003010 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003011 * Force a lock recursion deadlock when using flush_work() inside a
3012 * single-threaded or rescuer equipped workqueue.
3013 *
3014 * For single threaded workqueues the deadlock happens when the work
3015 * is after the work issuing the flush_work(). For rescuer equipped
3016 * workqueues the deadlock happens when the rescuer stalls, blocking
3017 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003018 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003019 if (!from_cancel &&
3020 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003021 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003022 lock_map_release(&pwq->wq->lockdep_map);
3023 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003024 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003025 return true;
3026already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08003027 spin_unlock_irq(&pool->lock);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003028 rcu_read_unlock();
Tejun Heobaf59022010-09-16 10:42:16 +02003029 return false;
3030}
3031
Johannes Bergd6e89782018-08-22 11:49:03 +02003032static bool __flush_work(struct work_struct *work, bool from_cancel)
3033{
3034 struct wq_barrier barr;
3035
3036 if (WARN_ON(!wq_online))
3037 return false;
3038
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003039 if (WARN_ON(!work->func))
3040 return false;
3041
Johannes Berg87915ad2018-08-22 11:49:04 +02003042 if (!from_cancel) {
3043 lock_map_acquire(&work->lockdep_map);
3044 lock_map_release(&work->lockdep_map);
3045 }
3046
Johannes Bergd6e89782018-08-22 11:49:03 +02003047 if (start_flush_work(work, &barr, from_cancel)) {
3048 wait_for_completion(&barr.done);
3049 destroy_work_on_stack(&barr.work);
3050 return true;
3051 } else {
3052 return false;
3053 }
3054}
3055
Oleg Nesterovdb700892008-07-25 01:47:49 -07003056/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003057 * flush_work - wait for a work to finish executing the last queueing instance
3058 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003059 *
Tejun Heo606a5022012-08-20 14:51:23 -07003060 * Wait until @work has finished execution. @work is guaranteed to be idle
3061 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003062 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003063 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003064 * %true if flush_work() waited for the work to finish execution,
3065 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003066 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003067bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003068{
Johannes Bergd6e89782018-08-22 11:49:03 +02003069 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003070}
3071EXPORT_SYMBOL_GPL(flush_work);
3072
Tejun Heo8603e1b32015-03-05 08:04:13 -05003073struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003074 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003075 struct work_struct *work;
3076};
3077
Ingo Molnarac6424b2017-06-20 12:06:13 +02003078static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003079{
3080 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3081
3082 if (cwait->work != key)
3083 return 0;
3084 return autoremove_wake_function(wait, mode, sync, key);
3085}
3086
Tejun Heo36e227d2012-08-03 10:30:46 -07003087static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003088{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003089 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003090 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003091 int ret;
3092
3093 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003094 ret = try_to_grab_pending(work, is_dwork, &flags);
3095 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003096 * If someone else is already canceling, wait for it to
3097 * finish. flush_work() doesn't work for PREEMPT_NONE
3098 * because we may get scheduled between @work's completion
3099 * and the other canceling task resuming and clearing
3100 * CANCELING - flush_work() will return false immediately
3101 * as @work is no longer busy, try_to_grab_pending() will
3102 * return -ENOENT as @work is still being canceled and the
3103 * other canceling task won't be able to clear CANCELING as
3104 * we're hogging the CPU.
3105 *
3106 * Let's wait for completion using a waitqueue. As this
3107 * may lead to the thundering herd problem, use a custom
3108 * wake function which matches @work along with exclusive
3109 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003110 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003111 if (unlikely(ret == -ENOENT)) {
3112 struct cwt_wait cwait;
3113
3114 init_wait(&cwait.wait);
3115 cwait.wait.func = cwt_wakefn;
3116 cwait.work = work;
3117
3118 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3119 TASK_UNINTERRUPTIBLE);
3120 if (work_is_canceling(work))
3121 schedule();
3122 finish_wait(&cancel_waitq, &cwait.wait);
3123 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003124 } while (unlikely(ret < 0));
3125
Tejun Heobbb68df2012-08-03 10:30:46 -07003126 /* tell other tasks trying to grab @work to back off */
3127 mark_work_canceling(work);
3128 local_irq_restore(flags);
3129
Tejun Heo3347fa02016-09-16 15:49:32 -04003130 /*
3131 * This allows canceling during early boot. We know that @work
3132 * isn't executing.
3133 */
3134 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003135 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003136
Tejun Heo7a22ad72010-06-29 10:07:13 +02003137 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003138
3139 /*
3140 * Paired with prepare_to_wait() above so that either
3141 * waitqueue_active() is visible here or !work_is_canceling() is
3142 * visible there.
3143 */
3144 smp_mb();
3145 if (waitqueue_active(&cancel_waitq))
3146 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3147
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003148 return ret;
3149}
3150
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003151/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003152 * cancel_work_sync - cancel a work and wait for it to finish
3153 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003154 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003155 * Cancel @work and wait for its execution to finish. This function
3156 * can be used even if the work re-queues itself or migrates to
3157 * another workqueue. On return from this function, @work is
3158 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003159 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003160 * cancel_work_sync(&delayed_work->work) must not be used for
3161 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003162 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003163 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003164 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003165 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003166 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003167 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003168 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003169bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003170{
Tejun Heo36e227d2012-08-03 10:30:46 -07003171 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003172}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003173EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003174
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003175/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003176 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3177 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003178 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003179 * Delayed timer is cancelled and the pending work is queued for
3180 * immediate execution. Like flush_work(), this function only
3181 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003182 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003183 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003184 * %true if flush_work() waited for the work to finish execution,
3185 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003186 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003187bool flush_delayed_work(struct delayed_work *dwork)
3188{
Tejun Heo8930cab2012-08-03 10:30:45 -07003189 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003190 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003191 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003192 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003193 return flush_work(&dwork->work);
3194}
3195EXPORT_SYMBOL(flush_delayed_work);
3196
Tejun Heo05f0fe62018-03-14 12:45:13 -07003197/**
3198 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3199 * @rwork: the rcu work to flush
3200 *
3201 * Return:
3202 * %true if flush_rcu_work() waited for the work to finish execution,
3203 * %false if it was already idle.
3204 */
3205bool flush_rcu_work(struct rcu_work *rwork)
3206{
3207 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3208 rcu_barrier();
3209 flush_work(&rwork->work);
3210 return true;
3211 } else {
3212 return flush_work(&rwork->work);
3213 }
3214}
3215EXPORT_SYMBOL(flush_rcu_work);
3216
Jens Axboef72b8792016-08-24 15:51:50 -06003217static bool __cancel_work(struct work_struct *work, bool is_dwork)
3218{
3219 unsigned long flags;
3220 int ret;
3221
3222 do {
3223 ret = try_to_grab_pending(work, is_dwork, &flags);
3224 } while (unlikely(ret == -EAGAIN));
3225
3226 if (unlikely(ret < 0))
3227 return false;
3228
3229 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3230 local_irq_restore(flags);
3231 return ret;
3232}
3233
Tejun Heo401a8d02010-09-16 10:36:00 +02003234/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003235 * cancel_delayed_work - cancel a delayed work
3236 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003237 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003238 * Kill off a pending delayed_work.
3239 *
3240 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3241 * pending.
3242 *
3243 * Note:
3244 * The work callback function may still be running on return, unless
3245 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3246 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003247 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003248 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003249 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003250bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003251{
Jens Axboef72b8792016-08-24 15:51:50 -06003252 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003253}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003254EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003255
3256/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003257 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3258 * @dwork: the delayed work cancel
3259 *
3260 * This is cancel_work_sync() for delayed works.
3261 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003262 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003263 * %true if @dwork was pending, %false otherwise.
3264 */
3265bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003266{
Tejun Heo36e227d2012-08-03 10:30:46 -07003267 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003268}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003269EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003271/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003272 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003273 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003274 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003275 * schedule_on_each_cpu() executes @func on each online CPU using the
3276 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003277 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003278 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003279 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003280 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003281 */
David Howells65f27f32006-11-22 14:55:48 +00003282int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003283{
3284 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003285 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003286
Andrew Mortonb6136772006-06-25 05:47:49 -07003287 works = alloc_percpu(struct work_struct);
3288 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003289 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003290
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003291 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003292
Christoph Lameter15316ba82006-01-08 01:00:43 -08003293 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003294 struct work_struct *work = per_cpu_ptr(works, cpu);
3295
3296 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003297 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003298 }
Tejun Heo93981802009-11-17 14:06:20 -08003299
3300 for_each_online_cpu(cpu)
3301 flush_work(per_cpu_ptr(works, cpu));
3302
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003303 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003304 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003305 return 0;
3306}
3307
Alan Sterneef6a7d2010-02-12 17:39:21 +09003308/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003309 * execute_in_process_context - reliably execute the routine with user context
3310 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003311 * @ew: guaranteed storage for the execute work structure (must
3312 * be available when the work executes)
3313 *
3314 * Executes the function immediately if process context is available,
3315 * otherwise schedules the function for delayed execution.
3316 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003317 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003318 * 1 - function was scheduled for execution
3319 */
David Howells65f27f32006-11-22 14:55:48 +00003320int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003321{
3322 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003323 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003324 return 0;
3325 }
3326
David Howells65f27f32006-11-22 14:55:48 +00003327 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003328 schedule_work(&ew->work);
3329
3330 return 1;
3331}
3332EXPORT_SYMBOL_GPL(execute_in_process_context);
3333
Tejun Heo7a4e3442013-03-12 11:30:00 -07003334/**
3335 * free_workqueue_attrs - free a workqueue_attrs
3336 * @attrs: workqueue_attrs to free
3337 *
3338 * Undo alloc_workqueue_attrs().
3339 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003340void free_workqueue_attrs(struct workqueue_attrs *attrs)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003341{
3342 if (attrs) {
3343 free_cpumask_var(attrs->cpumask);
3344 kfree(attrs);
3345 }
3346}
3347
3348/**
3349 * alloc_workqueue_attrs - allocate a workqueue_attrs
Tejun Heo7a4e3442013-03-12 11:30:00 -07003350 *
3351 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003352 * return it.
3353 *
3354 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003355 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04003356struct workqueue_attrs *alloc_workqueue_attrs(void)
Tejun Heo7a4e3442013-03-12 11:30:00 -07003357{
3358 struct workqueue_attrs *attrs;
3359
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003360 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003361 if (!attrs)
3362 goto fail;
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003363 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
Tejun Heo7a4e3442013-03-12 11:30:00 -07003364 goto fail;
3365
Tejun Heo13e2e552013-04-01 11:23:31 -07003366 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003367 return attrs;
3368fail:
3369 free_workqueue_attrs(attrs);
3370 return NULL;
3371}
3372
Tejun Heo29c91e92013-03-12 11:30:03 -07003373static void copy_workqueue_attrs(struct workqueue_attrs *to,
3374 const struct workqueue_attrs *from)
3375{
3376 to->nice = from->nice;
3377 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003378 /*
3379 * Unlike hash and equality test, this function doesn't ignore
3380 * ->no_numa as it is used for both pool and wq attrs. Instead,
3381 * get_unbound_pool() explicitly clears ->no_numa after copying.
3382 */
3383 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003384}
3385
Tejun Heo29c91e92013-03-12 11:30:03 -07003386/* hash value of the content of @attr */
3387static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3388{
3389 u32 hash = 0;
3390
3391 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003392 hash = jhash(cpumask_bits(attrs->cpumask),
3393 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003394 return hash;
3395}
3396
3397/* content equality test */
3398static bool wqattrs_equal(const struct workqueue_attrs *a,
3399 const struct workqueue_attrs *b)
3400{
3401 if (a->nice != b->nice)
3402 return false;
3403 if (!cpumask_equal(a->cpumask, b->cpumask))
3404 return false;
3405 return true;
3406}
3407
Tejun Heo7a4e3442013-03-12 11:30:00 -07003408/**
3409 * init_worker_pool - initialize a newly zalloc'd worker_pool
3410 * @pool: worker_pool to initialize
3411 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303412 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003413 *
3414 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003415 * inside @pool proper are initialized and put_unbound_pool() can be called
3416 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003417 */
3418static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003419{
3420 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003421 pool->id = -1;
3422 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003423 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003424 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003425 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003426 INIT_LIST_HEAD(&pool->worklist);
3427 INIT_LIST_HEAD(&pool->idle_list);
3428 hash_init(pool->busy_hash);
3429
Kees Cook32a6c722017-10-16 15:58:25 -07003430 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003431
Kees Cook32a6c722017-10-16 15:58:25 -07003432 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003433
Lai Jiangshanda028462014-05-20 17:46:31 +08003434 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003435
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003436 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003437 INIT_HLIST_NODE(&pool->hash_node);
3438 pool->refcnt = 1;
3439
3440 /* shouldn't fail above this point */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003441 pool->attrs = alloc_workqueue_attrs();
Tejun Heo7a4e3442013-03-12 11:30:00 -07003442 if (!pool->attrs)
3443 return -ENOMEM;
3444 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003445}
3446
Bart Van Assche669de8b2019-02-14 15:00:54 -08003447#ifdef CONFIG_LOCKDEP
3448static void wq_init_lockdep(struct workqueue_struct *wq)
3449{
3450 char *lock_name;
3451
3452 lockdep_register_key(&wq->key);
3453 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3454 if (!lock_name)
3455 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003456
3457 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003458 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3459}
3460
3461static void wq_unregister_lockdep(struct workqueue_struct *wq)
3462{
3463 lockdep_unregister_key(&wq->key);
3464}
3465
3466static void wq_free_lockdep(struct workqueue_struct *wq)
3467{
3468 if (wq->lock_name != wq->name)
3469 kfree(wq->lock_name);
3470}
3471#else
3472static void wq_init_lockdep(struct workqueue_struct *wq)
3473{
3474}
3475
3476static void wq_unregister_lockdep(struct workqueue_struct *wq)
3477{
3478}
3479
3480static void wq_free_lockdep(struct workqueue_struct *wq)
3481{
3482}
3483#endif
3484
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003485static void rcu_free_wq(struct rcu_head *rcu)
3486{
3487 struct workqueue_struct *wq =
3488 container_of(rcu, struct workqueue_struct, rcu);
3489
Bart Van Assche669de8b2019-02-14 15:00:54 -08003490 wq_free_lockdep(wq);
3491
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003492 if (!(wq->flags & WQ_UNBOUND))
3493 free_percpu(wq->cpu_pwqs);
3494 else
3495 free_workqueue_attrs(wq->unbound_attrs);
3496
3497 kfree(wq->rescuer);
3498 kfree(wq);
3499}
3500
Tejun Heo29c91e92013-03-12 11:30:03 -07003501static void rcu_free_pool(struct rcu_head *rcu)
3502{
3503 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3504
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003505 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003506 free_workqueue_attrs(pool->attrs);
3507 kfree(pool);
3508}
3509
3510/**
3511 * put_unbound_pool - put a worker_pool
3512 * @pool: worker_pool to put
3513 *
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003514 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003515 * safe manner. get_unbound_pool() calls this function on its failure path
3516 * and this function should be able to release pools which went through,
3517 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003518 *
3519 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003520 */
3521static void put_unbound_pool(struct worker_pool *pool)
3522{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003523 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003524 struct worker *worker;
3525
Tejun Heoa892cac2013-04-01 11:23:32 -07003526 lockdep_assert_held(&wq_pool_mutex);
3527
3528 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003529 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003530
3531 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003532 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003533 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003534 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003535
3536 /* release id and unhash */
3537 if (pool->id >= 0)
3538 idr_remove(&worker_pool_idr, pool->id);
3539 hash_del(&pool->hash_node);
3540
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003541 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003542 * Become the manager and destroy all workers. This prevents
3543 * @pool's workers from blocking on attach_mutex. We're the last
3544 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003545 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003546 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003547 wait_event_lock_irq(wq_manager_wait,
3548 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3549 pool->flags |= POOL_MANAGER_ACTIVE;
3550
Lai Jiangshan1037de32014-05-22 16:44:07 +08003551 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003552 destroy_worker(worker);
3553 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003554 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003555
Tejun Heo1258fae2018-05-18 08:47:13 -07003556 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003557 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003558 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003559 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003560
3561 if (pool->detach_completion)
3562 wait_for_completion(pool->detach_completion);
3563
Tejun Heo29c91e92013-03-12 11:30:03 -07003564 /* shut down the timers */
3565 del_timer_sync(&pool->idle_timer);
3566 del_timer_sync(&pool->mayday_timer);
3567
Thomas Gleixner24acfb72019-03-13 17:55:47 +01003568 /* RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003569 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003570}
3571
3572/**
3573 * get_unbound_pool - get a worker_pool with the specified attributes
3574 * @attrs: the attributes of the worker_pool to get
3575 *
3576 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3577 * reference count and return it. If there already is a matching
3578 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003579 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003580 *
3581 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003582 *
3583 * Return: On success, a worker_pool with the same attributes as @attrs.
3584 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003585 */
3586static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3587{
Tejun Heo29c91e92013-03-12 11:30:03 -07003588 u32 hash = wqattrs_hash(attrs);
3589 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003590 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003591 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003592
Tejun Heoa892cac2013-04-01 11:23:32 -07003593 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003594
3595 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003596 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3597 if (wqattrs_equal(pool->attrs, attrs)) {
3598 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003599 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003600 }
3601 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003602
Xunlei Pange22735842015-10-09 11:53:12 +08003603 /* if cpumask is contained inside a NUMA node, we belong to that node */
3604 if (wq_numa_enabled) {
3605 for_each_node(node) {
3606 if (cpumask_subset(attrs->cpumask,
3607 wq_numa_possible_cpumask[node])) {
3608 target_node = node;
3609 break;
3610 }
3611 }
3612 }
3613
Tejun Heo29c91e92013-03-12 11:30:03 -07003614 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003615 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003616 if (!pool || init_worker_pool(pool) < 0)
3617 goto fail;
3618
Tejun Heo8864b4e2013-03-12 11:30:04 -07003619 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003620 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003621 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003622
Shaohua Li2865a8f2013-08-01 09:56:36 +08003623 /*
3624 * no_numa isn't a worker_pool attribute, always clear it. See
3625 * 'struct workqueue_attrs' comments for detail.
3626 */
3627 pool->attrs->no_numa = false;
3628
Tejun Heo29c91e92013-03-12 11:30:03 -07003629 if (worker_pool_assign_id(pool) < 0)
3630 goto fail;
3631
3632 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003633 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003634 goto fail;
3635
Tejun Heo29c91e92013-03-12 11:30:03 -07003636 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003637 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003638
Tejun Heo29c91e92013-03-12 11:30:03 -07003639 return pool;
3640fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003641 if (pool)
3642 put_unbound_pool(pool);
3643 return NULL;
3644}
3645
Tejun Heo8864b4e2013-03-12 11:30:04 -07003646static void rcu_free_pwq(struct rcu_head *rcu)
3647{
3648 kmem_cache_free(pwq_cache,
3649 container_of(rcu, struct pool_workqueue, rcu));
3650}
3651
3652/*
3653 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3654 * and needs to be destroyed.
3655 */
3656static void pwq_unbound_release_workfn(struct work_struct *work)
3657{
3658 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3659 unbound_release_work);
3660 struct workqueue_struct *wq = pwq->wq;
3661 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003662 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003663
3664 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3665 return;
3666
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003667 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003668 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003669 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003670 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003671
Tejun Heoa892cac2013-04-01 11:23:32 -07003672 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003673 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003674 mutex_unlock(&wq_pool_mutex);
3675
Paul E. McKenney25b00772018-11-06 19:18:45 -08003676 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003677
3678 /*
3679 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003680 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003681 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003682 if (is_last) {
3683 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003684 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003685 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003686}
3687
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003688/**
Tejun Heo699ce092013-03-13 16:51:35 -07003689 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003690 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003691 *
Tejun Heo699ce092013-03-13 16:51:35 -07003692 * If @pwq isn't freezing, set @pwq->max_active to the associated
3693 * workqueue's saved_max_active and activate delayed work items
3694 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003695 */
Tejun Heo699ce092013-03-13 16:51:35 -07003696static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003697{
Tejun Heo699ce092013-03-13 16:51:35 -07003698 struct workqueue_struct *wq = pwq->wq;
3699 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003700 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003701
Tejun Heo699ce092013-03-13 16:51:35 -07003702 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003703 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003704
3705 /* fast exit for non-freezable wqs */
3706 if (!freezable && pwq->max_active == wq->saved_max_active)
3707 return;
3708
Tejun Heo3347fa02016-09-16 15:49:32 -04003709 /* this function can be called during early boot w/ irq disabled */
3710 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003711
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003712 /*
3713 * During [un]freezing, the caller is responsible for ensuring that
3714 * this function is called at least once after @workqueue_freezing
3715 * is updated and visible.
3716 */
3717 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003718 pwq->max_active = wq->saved_max_active;
3719
3720 while (!list_empty(&pwq->delayed_works) &&
3721 pwq->nr_active < pwq->max_active)
3722 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003723
3724 /*
3725 * Need to kick a worker after thawed or an unbound wq's
3726 * max_active is bumped. It's a slow path. Do it always.
3727 */
3728 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003729 } else {
3730 pwq->max_active = 0;
3731 }
3732
Tejun Heo3347fa02016-09-16 15:49:32 -04003733 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003734}
3735
Tejun Heoe50aba92013-04-01 11:23:35 -07003736/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003737static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3738 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003739{
3740 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3741
Tejun Heoe50aba92013-04-01 11:23:35 -07003742 memset(pwq, 0, sizeof(*pwq));
3743
Tejun Heod2c1d402013-03-12 11:30:04 -07003744 pwq->pool = pool;
3745 pwq->wq = wq;
3746 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003747 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003748 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003749 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003750 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003751 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003752}
Tejun Heod2c1d402013-03-12 11:30:04 -07003753
Tejun Heof147f292013-04-01 11:23:35 -07003754/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003755static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003756{
3757 struct workqueue_struct *wq = pwq->wq;
3758
3759 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003760
Tejun Heo1befcf32013-04-01 11:23:35 -07003761 /* may be called multiple times, ignore if already linked */
3762 if (!list_empty(&pwq->pwqs_node))
3763 return;
3764
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003765 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003766 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003767
3768 /* sync max_active to the current setting */
3769 pwq_adjust_max_active(pwq);
3770
3771 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003772 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003773}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003774
Tejun Heof147f292013-04-01 11:23:35 -07003775/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3776static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3777 const struct workqueue_attrs *attrs)
3778{
3779 struct worker_pool *pool;
3780 struct pool_workqueue *pwq;
3781
3782 lockdep_assert_held(&wq_pool_mutex);
3783
3784 pool = get_unbound_pool(attrs);
3785 if (!pool)
3786 return NULL;
3787
Tejun Heoe50aba92013-04-01 11:23:35 -07003788 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003789 if (!pwq) {
3790 put_unbound_pool(pool);
3791 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003792 }
Tejun Heo6029a912013-04-01 11:23:34 -07003793
Tejun Heof147f292013-04-01 11:23:35 -07003794 init_pwq(pwq, wq, pool);
3795 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003796}
3797
Tejun Heo4c16bd32013-04-01 11:23:36 -07003798/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003799 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003800 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003801 * @node: the target NUMA node
3802 * @cpu_going_down: if >= 0, the CPU to consider as offline
3803 * @cpumask: outarg, the resulting cpumask
3804 *
3805 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3806 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003807 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003808 *
3809 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3810 * enabled and @node has online CPUs requested by @attrs, the returned
3811 * cpumask is the intersection of the possible CPUs of @node and
3812 * @attrs->cpumask.
3813 *
3814 * The caller is responsible for ensuring that the cpumask of @node stays
3815 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003816 *
3817 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3818 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003819 */
3820static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3821 int cpu_going_down, cpumask_t *cpumask)
3822{
Tejun Heod55262c2013-04-01 11:23:38 -07003823 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003824 goto use_dfl;
3825
3826 /* does @node have any online CPUs @attrs wants? */
3827 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3828 if (cpu_going_down >= 0)
3829 cpumask_clear_cpu(cpu_going_down, cpumask);
3830
3831 if (cpumask_empty(cpumask))
3832 goto use_dfl;
3833
3834 /* yeap, return possible CPUs in @node that @attrs wants */
3835 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003836
3837 if (cpumask_empty(cpumask)) {
3838 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3839 "possible intersect\n");
3840 return false;
3841 }
3842
Tejun Heo4c16bd32013-04-01 11:23:36 -07003843 return !cpumask_equal(cpumask, attrs->cpumask);
3844
3845use_dfl:
3846 cpumask_copy(cpumask, attrs->cpumask);
3847 return false;
3848}
3849
Tejun Heo1befcf32013-04-01 11:23:35 -07003850/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3851static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3852 int node,
3853 struct pool_workqueue *pwq)
3854{
3855 struct pool_workqueue *old_pwq;
3856
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003857 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003858 lockdep_assert_held(&wq->mutex);
3859
3860 /* link_pwq() can handle duplicate calls */
3861 link_pwq(pwq);
3862
3863 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3864 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3865 return old_pwq;
3866}
3867
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003868/* context to store the prepared attrs & pwqs before applying */
3869struct apply_wqattrs_ctx {
3870 struct workqueue_struct *wq; /* target workqueue */
3871 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003872 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003873 struct pool_workqueue *dfl_pwq;
3874 struct pool_workqueue *pwq_tbl[];
3875};
3876
3877/* free the resources after success or abort */
3878static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3879{
3880 if (ctx) {
3881 int node;
3882
3883 for_each_node(node)
3884 put_pwq_unlocked(ctx->pwq_tbl[node]);
3885 put_pwq_unlocked(ctx->dfl_pwq);
3886
3887 free_workqueue_attrs(ctx->attrs);
3888
3889 kfree(ctx);
3890 }
3891}
3892
3893/* allocate the attrs and pwqs for later installation */
3894static struct apply_wqattrs_ctx *
3895apply_wqattrs_prepare(struct workqueue_struct *wq,
3896 const struct workqueue_attrs *attrs)
3897{
3898 struct apply_wqattrs_ctx *ctx;
3899 struct workqueue_attrs *new_attrs, *tmp_attrs;
3900 int node;
3901
3902 lockdep_assert_held(&wq_pool_mutex);
3903
Kees Cookacafe7e2018-05-08 13:45:50 -07003904 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003905
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02003906 new_attrs = alloc_workqueue_attrs();
3907 tmp_attrs = alloc_workqueue_attrs();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003908 if (!ctx || !new_attrs || !tmp_attrs)
3909 goto out_free;
3910
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003911 /*
3912 * Calculate the attrs of the default pwq.
3913 * If the user configured cpumask doesn't overlap with the
3914 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3915 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003916 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003917 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003918 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3919 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003920
3921 /*
3922 * We may create multiple pwqs with differing cpumasks. Make a
3923 * copy of @new_attrs which will be modified and used to obtain
3924 * pools.
3925 */
3926 copy_workqueue_attrs(tmp_attrs, new_attrs);
3927
3928 /*
3929 * If something goes wrong during CPU up/down, we'll fall back to
3930 * the default pwq covering whole @attrs->cpumask. Always create
3931 * it even if we don't use it immediately.
3932 */
3933 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3934 if (!ctx->dfl_pwq)
3935 goto out_free;
3936
3937 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003938 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003939 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3940 if (!ctx->pwq_tbl[node])
3941 goto out_free;
3942 } else {
3943 ctx->dfl_pwq->refcnt++;
3944 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3945 }
3946 }
3947
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003948 /* save the user configured attrs and sanitize it. */
3949 copy_workqueue_attrs(new_attrs, attrs);
3950 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003951 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003952
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003953 ctx->wq = wq;
3954 free_workqueue_attrs(tmp_attrs);
3955 return ctx;
3956
3957out_free:
3958 free_workqueue_attrs(tmp_attrs);
3959 free_workqueue_attrs(new_attrs);
3960 apply_wqattrs_cleanup(ctx);
3961 return NULL;
3962}
3963
3964/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3965static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3966{
3967 int node;
3968
3969 /* all pwqs have been created successfully, let's install'em */
3970 mutex_lock(&ctx->wq->mutex);
3971
3972 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3973
3974 /* save the previous pwq and install the new one */
3975 for_each_node(node)
3976 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3977 ctx->pwq_tbl[node]);
3978
3979 /* @dfl_pwq might not have been used, ensure it's linked */
3980 link_pwq(ctx->dfl_pwq);
3981 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3982
3983 mutex_unlock(&ctx->wq->mutex);
3984}
3985
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003986static void apply_wqattrs_lock(void)
3987{
3988 /* CPUs should stay stable across pwq creations and installations */
3989 get_online_cpus();
3990 mutex_lock(&wq_pool_mutex);
3991}
3992
3993static void apply_wqattrs_unlock(void)
3994{
3995 mutex_unlock(&wq_pool_mutex);
3996 put_online_cpus();
3997}
3998
3999static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4000 const struct workqueue_attrs *attrs)
4001{
4002 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004003
4004 /* only unbound workqueues can change attributes */
4005 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4006 return -EINVAL;
4007
4008 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004009 if (!list_empty(&wq->pwqs)) {
4010 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4011 return -EINVAL;
4012
4013 wq->flags &= ~__WQ_ORDERED;
4014 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004015
4016 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004017 if (!ctx)
4018 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004019
4020 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004021 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004022 apply_wqattrs_cleanup(ctx);
4023
wanghaibin62011712016-01-07 20:38:59 +08004024 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004025}
4026
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004027/**
4028 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4029 * @wq: the target workqueue
4030 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4031 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004032 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4033 * machines, this function maps a separate pwq to each NUMA node with
4034 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4035 * NUMA node it was issued on. Older pwqs are released as in-flight work
4036 * items finish. Note that a work item which repeatedly requeues itself
4037 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004038 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004039 * Performs GFP_KERNEL allocations.
4040 *
Daniel Jordan509b3202019-09-05 21:40:23 -04004041 * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus().
4042 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004043 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004044 */
Daniel Jordan513c98d2019-09-05 21:40:22 -04004045int apply_workqueue_attrs(struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004046 const struct workqueue_attrs *attrs)
4047{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004048 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004049
Daniel Jordan509b3202019-09-05 21:40:23 -04004050 lockdep_assert_cpus_held();
4051
4052 mutex_lock(&wq_pool_mutex);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004053 ret = apply_workqueue_attrs_locked(wq, attrs);
Daniel Jordan509b3202019-09-05 21:40:23 -04004054 mutex_unlock(&wq_pool_mutex);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004055
Tejun Heo48621252013-04-01 11:23:31 -07004056 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004057}
4058
Tejun Heo4c16bd32013-04-01 11:23:36 -07004059/**
4060 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4061 * @wq: the target workqueue
4062 * @cpu: the CPU coming up or going down
4063 * @online: whether @cpu is coming up or going down
4064 *
4065 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4066 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4067 * @wq accordingly.
4068 *
4069 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4070 * falls back to @wq->dfl_pwq which may not be optimal but is always
4071 * correct.
4072 *
4073 * Note that when the last allowed CPU of a NUMA node goes offline for a
4074 * workqueue with a cpumask spanning multiple nodes, the workers which were
4075 * already executing the work items for the workqueue will lose their CPU
4076 * affinity and may execute on any CPU. This is similar to how per-cpu
4077 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4078 * affinity, it's the user's responsibility to flush the work item from
4079 * CPU_DOWN_PREPARE.
4080 */
4081static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4082 bool online)
4083{
4084 int node = cpu_to_node(cpu);
4085 int cpu_off = online ? -1 : cpu;
4086 struct pool_workqueue *old_pwq = NULL, *pwq;
4087 struct workqueue_attrs *target_attrs;
4088 cpumask_t *cpumask;
4089
4090 lockdep_assert_held(&wq_pool_mutex);
4091
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004092 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4093 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004094 return;
4095
4096 /*
4097 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4098 * Let's use a preallocated one. The following buf is protected by
4099 * CPU hotplug exclusion.
4100 */
4101 target_attrs = wq_update_unbound_numa_attrs_buf;
4102 cpumask = target_attrs->cpumask;
4103
Tejun Heo4c16bd32013-04-01 11:23:36 -07004104 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4105 pwq = unbound_pwq_by_node(wq, node);
4106
4107 /*
4108 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004109 * different from the default pwq's, we need to compare it to @pwq's
4110 * and create a new one if they don't match. If the target cpumask
4111 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004112 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004113 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004114 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004115 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004116 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004117 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004118 }
4119
Tejun Heo4c16bd32013-04-01 11:23:36 -07004120 /* create a new pwq */
4121 pwq = alloc_unbound_pwq(wq, target_attrs);
4122 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004123 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4124 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004125 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004126 }
4127
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004128 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004129 mutex_lock(&wq->mutex);
4130 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4131 goto out_unlock;
4132
4133use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004134 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004135 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4136 get_pwq(wq->dfl_pwq);
4137 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4138 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4139out_unlock:
4140 mutex_unlock(&wq->mutex);
4141 put_pwq_unlocked(old_pwq);
4142}
4143
Tejun Heo30cdf2492013-03-12 11:29:57 -07004144static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004145{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004146 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004147 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004148
Tejun Heo30cdf2492013-03-12 11:29:57 -07004149 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004150 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4151 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004152 return -ENOMEM;
4153
4154 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004155 struct pool_workqueue *pwq =
4156 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004157 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004158 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004159
Tejun Heof147f292013-04-01 11:23:35 -07004160 init_pwq(pwq, wq, &cpu_pools[highpri]);
4161
4162 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004163 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004164 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004165 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004166 return 0;
Daniel Jordan509b3202019-09-05 21:40:23 -04004167 }
4168
4169 get_online_cpus();
4170 if (wq->flags & __WQ_ORDERED) {
Tejun Heo8a2b7532013-09-05 12:30:04 -04004171 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4172 /* there should only be single pwq for ordering guarantee */
4173 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4174 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4175 "ordering guarantee broken for workqueue %s\n", wq->name);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004176 } else {
Daniel Jordan509b3202019-09-05 21:40:23 -04004177 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004178 }
Daniel Jordan509b3202019-09-05 21:40:23 -04004179 put_online_cpus();
4180
4181 return ret;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004182}
4183
Tejun Heof3421792010-07-02 10:03:51 +02004184static int wq_clamp_max_active(int max_active, unsigned int flags,
4185 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004186{
Tejun Heof3421792010-07-02 10:03:51 +02004187 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4188
4189 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004190 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4191 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004192
Tejun Heof3421792010-07-02 10:03:51 +02004193 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004194}
4195
Tejun Heo983c7512018-01-08 05:38:32 -08004196/*
4197 * Workqueues which may be used during memory reclaim should have a rescuer
4198 * to guarantee forward progress.
4199 */
4200static int init_rescuer(struct workqueue_struct *wq)
4201{
4202 struct worker *rescuer;
4203 int ret;
4204
4205 if (!(wq->flags & WQ_MEM_RECLAIM))
4206 return 0;
4207
4208 rescuer = alloc_worker(NUMA_NO_NODE);
4209 if (!rescuer)
4210 return -ENOMEM;
4211
4212 rescuer->rescue_wq = wq;
4213 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4214 ret = PTR_ERR_OR_ZERO(rescuer->task);
4215 if (ret) {
4216 kfree(rescuer);
4217 return ret;
4218 }
4219
4220 wq->rescuer = rescuer;
4221 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4222 wake_up_process(rescuer->task);
4223
4224 return 0;
4225}
4226
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004227__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004228struct workqueue_struct *alloc_workqueue(const char *fmt,
4229 unsigned int flags,
4230 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004231{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004232 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004233 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004234 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004235 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004236
Tejun Heo5c0338c2017-07-18 18:41:52 -04004237 /*
4238 * Unbound && max_active == 1 used to imply ordered, which is no
4239 * longer the case on NUMA machines due to per-node pools. While
4240 * alloc_ordered_workqueue() is the right way to create an ordered
4241 * workqueue, keep the previous behavior to avoid subtle breakages
4242 * on NUMA.
4243 */
4244 if ((flags & WQ_UNBOUND) && max_active == 1)
4245 flags |= __WQ_ORDERED;
4246
Viresh Kumarcee22a12013-04-08 16:45:40 +05304247 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4248 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4249 flags |= WQ_UNBOUND;
4250
Tejun Heoecf68812013-04-01 11:23:34 -07004251 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004252 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004253 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004254
4255 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004256 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004257 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004258
Tejun Heo6029a912013-04-01 11:23:34 -07004259 if (flags & WQ_UNBOUND) {
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02004260 wq->unbound_attrs = alloc_workqueue_attrs();
Tejun Heo6029a912013-04-01 11:23:34 -07004261 if (!wq->unbound_attrs)
4262 goto err_free_wq;
4263 }
4264
Bart Van Assche669de8b2019-02-14 15:00:54 -08004265 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004266 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004267 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004268
Tejun Heod320c032010-06-29 10:07:14 +02004269 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004270 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004271
Tejun Heob196be82012-01-10 15:11:35 -08004272 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004273 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004274 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004275 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004276 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004277 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004278 INIT_LIST_HEAD(&wq->flusher_queue);
4279 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004280 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004281
Bart Van Assche669de8b2019-02-14 15:00:54 -08004282 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004283 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004284
Tejun Heo30cdf2492013-03-12 11:29:57 -07004285 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004286 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004287
Tejun Heo40c17f72018-01-08 05:38:37 -08004288 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004289 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004290
Tejun Heo226223a2013-03-12 11:30:05 -07004291 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4292 goto err_destroy;
4293
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004294 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004295 * wq_pool_mutex protects global freeze state and workqueues list.
4296 * Grab it, adjust max_active and add the new @wq to workqueues
4297 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004298 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004299 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004300
Lai Jiangshana357fc02013-03-25 16:57:19 -07004301 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004302 for_each_pwq(pwq, wq)
4303 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004304 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004305
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004306 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004307
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004308 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004309
Oleg Nesterov3af244332007-05-09 02:34:09 -07004310 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004311
Bart Van Assche82efcab2019-03-11 16:02:55 -07004312err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004313 wq_unregister_lockdep(wq);
4314 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004315err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004316 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004317 kfree(wq);
4318 return NULL;
4319err_destroy:
4320 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004321 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004322}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004323EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004324
Tejun Heoc29eb852019-09-23 11:08:58 -07004325static bool pwq_busy(struct pool_workqueue *pwq)
4326{
4327 int i;
4328
4329 for (i = 0; i < WORK_NR_COLORS; i++)
4330 if (pwq->nr_in_flight[i])
4331 return true;
4332
4333 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4334 return true;
4335 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4336 return true;
4337
4338 return false;
4339}
4340
Oleg Nesterov3af244332007-05-09 02:34:09 -07004341/**
4342 * destroy_workqueue - safely terminate a workqueue
4343 * @wq: target workqueue
4344 *
4345 * Safely destroy a workqueue. All work currently pending will be done first.
4346 */
4347void destroy_workqueue(struct workqueue_struct *wq)
4348{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004349 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004350 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004351
Tejun Heodef98c82019-09-18 18:43:40 -07004352 /*
4353 * Remove it from sysfs first so that sanity check failure doesn't
4354 * lead to sysfs name conflicts.
4355 */
4356 workqueue_sysfs_unregister(wq);
4357
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004358 /* drain it before proceeding with destruction */
4359 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004360
Tejun Heodef98c82019-09-18 18:43:40 -07004361 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4362 if (wq->rescuer) {
4363 struct worker *rescuer = wq->rescuer;
4364
4365 /* this prevents new queueing */
4366 spin_lock_irq(&wq_mayday_lock);
4367 wq->rescuer = NULL;
4368 spin_unlock_irq(&wq_mayday_lock);
4369
4370 /* rescuer will empty maydays list before exiting */
4371 kthread_stop(rescuer->task);
Tejun Heo8efe1222019-09-20 13:39:57 -07004372 kfree(rescuer);
Tejun Heodef98c82019-09-18 18:43:40 -07004373 }
4374
Tejun Heoc29eb852019-09-23 11:08:58 -07004375 /*
4376 * Sanity checks - grab all the locks so that we wait for all
4377 * in-flight operations which may do put_pwq().
4378 */
4379 mutex_lock(&wq_pool_mutex);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004380 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004381 for_each_pwq(pwq, wq) {
Tejun Heoc29eb852019-09-23 11:08:58 -07004382 spin_lock_irq(&pwq->pool->lock);
4383 if (WARN_ON(pwq_busy(pwq))) {
Tejun Heoe66b39a2019-09-25 06:59:15 -07004384 pr_warning("%s: %s has the following busy pwq\n",
4385 __func__, wq->name);
Tejun Heoc29eb852019-09-23 11:08:58 -07004386 show_pwq(pwq);
4387 spin_unlock_irq(&pwq->pool->lock);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004388 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004389 mutex_unlock(&wq_pool_mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004390 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004391 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004392 }
Tejun Heoc29eb852019-09-23 11:08:58 -07004393 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo6183c002013-03-12 11:29:57 -07004394 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004395 mutex_unlock(&wq->mutex);
Tejun Heoc29eb852019-09-23 11:08:58 -07004396 mutex_unlock(&wq_pool_mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004397
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004398 /*
4399 * wq list is used to freeze wq, remove from list after
4400 * flushing is complete in case freeze races us.
4401 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004402 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004403 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004404 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004405
Tejun Heo8864b4e2013-03-12 11:30:04 -07004406 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004407 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004408 /*
4409 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004410 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004411 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004412 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004413 } else {
4414 /*
4415 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004416 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4417 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004418 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004419 for_each_node(node) {
4420 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4421 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4422 put_pwq_unlocked(pwq);
4423 }
4424
4425 /*
4426 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4427 * put. Don't access it afterwards.
4428 */
4429 pwq = wq->dfl_pwq;
4430 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004431 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004432 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004433}
4434EXPORT_SYMBOL_GPL(destroy_workqueue);
4435
Tejun Heodcd989c2010-06-29 10:07:14 +02004436/**
4437 * workqueue_set_max_active - adjust max_active of a workqueue
4438 * @wq: target workqueue
4439 * @max_active: new max_active value.
4440 *
4441 * Set max_active of @wq to @max_active.
4442 *
4443 * CONTEXT:
4444 * Don't call from IRQ context.
4445 */
4446void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4447{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004448 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004449
Tejun Heo8719dce2013-03-12 11:30:04 -07004450 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004451 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004452 return;
4453
Tejun Heof3421792010-07-02 10:03:51 +02004454 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004455
Lai Jiangshana357fc02013-03-25 16:57:19 -07004456 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004457
Tejun Heo0a94efb2017-07-23 08:36:15 -04004458 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004459 wq->saved_max_active = max_active;
4460
Tejun Heo699ce092013-03-13 16:51:35 -07004461 for_each_pwq(pwq, wq)
4462 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004463
Lai Jiangshana357fc02013-03-25 16:57:19 -07004464 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004465}
4466EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4467
4468/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004469 * current_work - retrieve %current task's work struct
4470 *
4471 * Determine if %current task is a workqueue worker and what it's working on.
4472 * Useful to find out the context that the %current task is running in.
4473 *
4474 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4475 */
4476struct work_struct *current_work(void)
4477{
4478 struct worker *worker = current_wq_worker();
4479
4480 return worker ? worker->current_work : NULL;
4481}
4482EXPORT_SYMBOL(current_work);
4483
4484/**
Tejun Heoe62676162013-03-12 17:41:37 -07004485 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4486 *
4487 * Determine whether %current is a workqueue rescuer. Can be used from
4488 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004489 *
4490 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004491 */
4492bool current_is_workqueue_rescuer(void)
4493{
4494 struct worker *worker = current_wq_worker();
4495
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004496 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004497}
4498
4499/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004500 * workqueue_congested - test whether a workqueue is congested
4501 * @cpu: CPU in question
4502 * @wq: target workqueue
4503 *
4504 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4505 * no synchronization around this function and the test result is
4506 * unreliable and only useful as advisory hints or for debugging.
4507 *
Tejun Heod3251852013-05-10 11:10:17 -07004508 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4509 * Note that both per-cpu and unbound workqueues may be associated with
4510 * multiple pool_workqueues which have separate congested states. A
4511 * workqueue being congested on one CPU doesn't mean the workqueue is also
4512 * contested on other CPUs / NUMA nodes.
4513 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004514 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004515 * %true if congested, %false otherwise.
4516 */
Tejun Heod84ff052013-03-12 11:29:59 -07004517bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004518{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004519 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004520 bool ret;
4521
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004522 rcu_read_lock();
4523 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004524
Tejun Heod3251852013-05-10 11:10:17 -07004525 if (cpu == WORK_CPU_UNBOUND)
4526 cpu = smp_processor_id();
4527
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004528 if (!(wq->flags & WQ_UNBOUND))
4529 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4530 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004531 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004532
Tejun Heo76af4d92013-03-12 11:30:00 -07004533 ret = !list_empty(&pwq->delayed_works);
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004534 preempt_enable();
4535 rcu_read_unlock();
Tejun Heo76af4d92013-03-12 11:30:00 -07004536
4537 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004538}
4539EXPORT_SYMBOL_GPL(workqueue_congested);
4540
4541/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004542 * work_busy - test whether a work is currently pending or running
4543 * @work: the work to be tested
4544 *
4545 * Test whether @work is currently pending or running. There is no
4546 * synchronization around this function and the test result is
4547 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004548 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004549 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004550 * OR'd bitmask of WORK_BUSY_* bits.
4551 */
4552unsigned int work_busy(struct work_struct *work)
4553{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004554 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004555 unsigned long flags;
4556 unsigned int ret = 0;
4557
Tejun Heodcd989c2010-06-29 10:07:14 +02004558 if (work_pending(work))
4559 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004560
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004561 rcu_read_lock();
Tejun Heofa1b54e2013-03-12 11:30:00 -07004562 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004563 if (pool) {
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004564 spin_lock_irqsave(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004565 if (find_worker_executing_work(pool, work))
4566 ret |= WORK_BUSY_RUNNING;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004567 spin_unlock_irqrestore(&pool->lock, flags);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004568 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004569 rcu_read_unlock();
Tejun Heodcd989c2010-06-29 10:07:14 +02004570
4571 return ret;
4572}
4573EXPORT_SYMBOL_GPL(work_busy);
4574
Tejun Heo3d1cb202013-04-30 15:27:22 -07004575/**
4576 * set_worker_desc - set description for the current work item
4577 * @fmt: printf-style format string
4578 * @...: arguments for the format string
4579 *
4580 * This function can be called by a running work function to describe what
4581 * the work item is about. If the worker task gets dumped, this
4582 * information will be printed out together to help debugging. The
4583 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4584 */
4585void set_worker_desc(const char *fmt, ...)
4586{
4587 struct worker *worker = current_wq_worker();
4588 va_list args;
4589
4590 if (worker) {
4591 va_start(args, fmt);
4592 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4593 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004594 }
4595}
Steffen Maier5c750d52018-05-17 19:14:57 +02004596EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004597
4598/**
4599 * print_worker_info - print out worker information and description
4600 * @log_lvl: the log level to use when printing
4601 * @task: target task
4602 *
4603 * If @task is a worker and currently executing a work item, print out the
4604 * name of the workqueue being serviced and worker description set with
4605 * set_worker_desc() by the currently executing work item.
4606 *
4607 * This function can be safely called on any task as long as the
4608 * task_struct itself is accessible. While safe, this function isn't
4609 * synchronized and may print out mixups or garbages of limited length.
4610 */
4611void print_worker_info(const char *log_lvl, struct task_struct *task)
4612{
4613 work_func_t *fn = NULL;
4614 char name[WQ_NAME_LEN] = { };
4615 char desc[WORKER_DESC_LEN] = { };
4616 struct pool_workqueue *pwq = NULL;
4617 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004618 struct worker *worker;
4619
4620 if (!(task->flags & PF_WQ_WORKER))
4621 return;
4622
4623 /*
4624 * This function is called without any synchronization and @task
4625 * could be in any state. Be careful with dereferences.
4626 */
Petr Mladeke7005912016-10-11 13:55:17 -07004627 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004628
4629 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004630 * Carefully copy the associated workqueue's workfn, name and desc.
4631 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004632 */
4633 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4634 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4635 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4636 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004637 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004638
4639 if (fn || name[0] || desc[0]) {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004640 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004641 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004642 pr_cont(" (%s)", desc);
4643 pr_cont("\n");
4644 }
4645}
4646
Tejun Heo3494fc32015-03-09 09:22:28 -04004647static void pr_cont_pool_info(struct worker_pool *pool)
4648{
4649 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4650 if (pool->node != NUMA_NO_NODE)
4651 pr_cont(" node=%d", pool->node);
4652 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4653}
4654
4655static void pr_cont_work(bool comma, struct work_struct *work)
4656{
4657 if (work->func == wq_barrier_func) {
4658 struct wq_barrier *barr;
4659
4660 barr = container_of(work, struct wq_barrier, work);
4661
4662 pr_cont("%s BAR(%d)", comma ? "," : "",
4663 task_pid_nr(barr->task));
4664 } else {
Sakari Ailusd75f7732019-03-25 21:32:28 +02004665 pr_cont("%s %ps", comma ? "," : "", work->func);
Tejun Heo3494fc32015-03-09 09:22:28 -04004666 }
4667}
4668
4669static void show_pwq(struct pool_workqueue *pwq)
4670{
4671 struct worker_pool *pool = pwq->pool;
4672 struct work_struct *work;
4673 struct worker *worker;
4674 bool has_in_flight = false, has_pending = false;
4675 int bkt;
4676
4677 pr_info(" pwq %d:", pool->id);
4678 pr_cont_pool_info(pool);
4679
Tejun Heoe66b39a2019-09-25 06:59:15 -07004680 pr_cont(" active=%d/%d refcnt=%d%s\n",
4681 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004682 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4683
4684 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4685 if (worker->current_pwq == pwq) {
4686 has_in_flight = true;
4687 break;
4688 }
4689 }
4690 if (has_in_flight) {
4691 bool comma = false;
4692
4693 pr_info(" in-flight:");
4694 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4695 if (worker->current_pwq != pwq)
4696 continue;
4697
Sakari Ailusd75f7732019-03-25 21:32:28 +02004698 pr_cont("%s %d%s:%ps", comma ? "," : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004699 task_pid_nr(worker->task),
Tejun Heo30ae2fc2019-09-20 14:09:14 -07004700 worker->rescue_wq ? "(RESCUER)" : "",
Tejun Heo3494fc32015-03-09 09:22:28 -04004701 worker->current_func);
4702 list_for_each_entry(work, &worker->scheduled, entry)
4703 pr_cont_work(false, work);
4704 comma = true;
4705 }
4706 pr_cont("\n");
4707 }
4708
4709 list_for_each_entry(work, &pool->worklist, entry) {
4710 if (get_work_pwq(work) == pwq) {
4711 has_pending = true;
4712 break;
4713 }
4714 }
4715 if (has_pending) {
4716 bool comma = false;
4717
4718 pr_info(" pending:");
4719 list_for_each_entry(work, &pool->worklist, entry) {
4720 if (get_work_pwq(work) != pwq)
4721 continue;
4722
4723 pr_cont_work(comma, work);
4724 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4725 }
4726 pr_cont("\n");
4727 }
4728
4729 if (!list_empty(&pwq->delayed_works)) {
4730 bool comma = false;
4731
4732 pr_info(" delayed:");
4733 list_for_each_entry(work, &pwq->delayed_works, entry) {
4734 pr_cont_work(comma, work);
4735 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4736 }
4737 pr_cont("\n");
4738 }
4739}
4740
4741/**
4742 * show_workqueue_state - dump workqueue state
4743 *
Roger Lu7b776af2016-07-01 11:05:02 +08004744 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4745 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004746 */
4747void show_workqueue_state(void)
4748{
4749 struct workqueue_struct *wq;
4750 struct worker_pool *pool;
4751 unsigned long flags;
4752 int pi;
4753
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004754 rcu_read_lock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004755
4756 pr_info("Showing busy workqueues and worker pools:\n");
4757
4758 list_for_each_entry_rcu(wq, &workqueues, list) {
4759 struct pool_workqueue *pwq;
4760 bool idle = true;
4761
4762 for_each_pwq(pwq, wq) {
4763 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4764 idle = false;
4765 break;
4766 }
4767 }
4768 if (idle)
4769 continue;
4770
4771 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4772
4773 for_each_pwq(pwq, wq) {
4774 spin_lock_irqsave(&pwq->pool->lock, flags);
4775 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4776 show_pwq(pwq);
4777 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004778 /*
4779 * We could be printing a lot from atomic context, e.g.
4780 * sysrq-t -> show_workqueue_state(). Avoid triggering
4781 * hard lockup.
4782 */
4783 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004784 }
4785 }
4786
4787 for_each_pool(pool, pi) {
4788 struct worker *worker;
4789 bool first = true;
4790
4791 spin_lock_irqsave(&pool->lock, flags);
4792 if (pool->nr_workers == pool->nr_idle)
4793 goto next_pool;
4794
4795 pr_info("pool %d:", pool->id);
4796 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004797 pr_cont(" hung=%us workers=%d",
4798 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4799 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004800 if (pool->manager)
4801 pr_cont(" manager: %d",
4802 task_pid_nr(pool->manager->task));
4803 list_for_each_entry(worker, &pool->idle_list, entry) {
4804 pr_cont(" %s%d", first ? "idle: " : "",
4805 task_pid_nr(worker->task));
4806 first = false;
4807 }
4808 pr_cont("\n");
4809 next_pool:
4810 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004811 /*
4812 * We could be printing a lot from atomic context, e.g.
4813 * sysrq-t -> show_workqueue_state(). Avoid triggering
4814 * hard lockup.
4815 */
4816 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004817 }
4818
Thomas Gleixner24acfb72019-03-13 17:55:47 +01004819 rcu_read_unlock();
Tejun Heo3494fc32015-03-09 09:22:28 -04004820}
4821
Tejun Heo6b598082018-05-18 08:47:13 -07004822/* used to show worker information through /proc/PID/{comm,stat,status} */
4823void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4824{
Tejun Heo6b598082018-05-18 08:47:13 -07004825 int off;
4826
4827 /* always show the actual comm */
4828 off = strscpy(buf, task->comm, size);
4829 if (off < 0)
4830 return;
4831
Tejun Heo197f6ac2018-05-21 08:04:35 -07004832 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004833 mutex_lock(&wq_pool_attach_mutex);
4834
Tejun Heo197f6ac2018-05-21 08:04:35 -07004835 if (task->flags & PF_WQ_WORKER) {
4836 struct worker *worker = kthread_data(task);
4837 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004838
Tejun Heo197f6ac2018-05-21 08:04:35 -07004839 if (pool) {
4840 spin_lock_irq(&pool->lock);
4841 /*
4842 * ->desc tracks information (wq name or
4843 * set_worker_desc()) for the latest execution. If
4844 * current, prepend '+', otherwise '-'.
4845 */
4846 if (worker->desc[0] != '\0') {
4847 if (worker->current_work)
4848 scnprintf(buf + off, size - off, "+%s",
4849 worker->desc);
4850 else
4851 scnprintf(buf + off, size - off, "-%s",
4852 worker->desc);
4853 }
4854 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004855 }
Tejun Heo6b598082018-05-18 08:47:13 -07004856 }
4857
4858 mutex_unlock(&wq_pool_attach_mutex);
4859}
4860
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004861#ifdef CONFIG_SMP
4862
Tejun Heodb7bccf2010-06-29 10:07:12 +02004863/*
4864 * CPU hotplug.
4865 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004866 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004867 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004868 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004869 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004870 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004871 * blocked draining impractical.
4872 *
Tejun Heo24647572013-01-24 11:01:33 -08004873 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004874 * running as an unbound one and allowing it to be reattached later if the
4875 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004876 */
4877
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004878static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004879{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004880 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004881 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004882
Tejun Heof02ae732013-03-12 11:30:03 -07004883 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004884 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004885 spin_lock_irq(&pool->lock);
4886
4887 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004888 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004889 * unbound and set DISASSOCIATED. Before this, all workers
4890 * except for the ones which are still executing works from
4891 * before the last CPU down must be on the cpu. After
4892 * this, they may become diasporas.
4893 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004894 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004895 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004896
Tejun Heo24647572013-01-24 11:01:33 -08004897 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004898
Tejun Heo94cf58b2013-01-24 11:01:33 -08004899 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004900 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004901
Lai Jiangshaneb283422013-03-08 15:18:28 -08004902 /*
4903 * Call schedule() so that we cross rq->lock and thus can
4904 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4905 * This is necessary as scheduler callbacks may be invoked
4906 * from other cpus.
4907 */
4908 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004909
Lai Jiangshaneb283422013-03-08 15:18:28 -08004910 /*
4911 * Sched callbacks are disabled now. Zap nr_running.
4912 * After this, nr_running stays zero and need_more_worker()
4913 * and keep_working() are always true as long as the
4914 * worklist is not empty. This pool now behaves as an
4915 * unbound (in terms of concurrency management) pool which
4916 * are served by workers tied to the pool.
4917 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004918 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004919
4920 /*
4921 * With concurrency management just turned off, a busy
4922 * worker blocking could lead to lengthy stalls. Kick off
4923 * unbound chain execution of currently pending work items.
4924 */
4925 spin_lock_irq(&pool->lock);
4926 wake_up_worker(pool);
4927 spin_unlock_irq(&pool->lock);
4928 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004929}
4930
Tejun Heobd7c0892013-03-19 13:45:21 -07004931/**
4932 * rebind_workers - rebind all workers of a pool to the associated CPU
4933 * @pool: pool of interest
4934 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004935 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004936 */
4937static void rebind_workers(struct worker_pool *pool)
4938{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004939 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004940
Tejun Heo1258fae2018-05-18 08:47:13 -07004941 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004942
Tejun Heoa9ab7752013-03-19 13:45:21 -07004943 /*
4944 * Restore CPU affinity of all workers. As all idle workers should
4945 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304946 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004947 * of all workers first and then clear UNBOUND. As we're called
4948 * from CPU_ONLINE, the following shouldn't fail.
4949 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004950 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004951 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4952 pool->attrs->cpumask) < 0);
4953
4954 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004955
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004956 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004957
Lai Jiangshanda028462014-05-20 17:46:31 +08004958 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004959 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004960
4961 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004962 * A bound idle worker should actually be on the runqueue
4963 * of the associated CPU for local wake-ups targeting it to
4964 * work. Kick all idle workers so that they migrate to the
4965 * associated CPU. Doing this in the same loop as
4966 * replacing UNBOUND with REBOUND is safe as no worker will
4967 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004968 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004969 if (worker_flags & WORKER_IDLE)
4970 wake_up_process(worker->task);
4971
4972 /*
4973 * We want to clear UNBOUND but can't directly call
4974 * worker_clr_flags() or adjust nr_running. Atomically
4975 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4976 * @worker will clear REBOUND using worker_clr_flags() when
4977 * it initiates the next execution cycle thus restoring
4978 * concurrency management. Note that when or whether
4979 * @worker clears REBOUND doesn't affect correctness.
4980 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004981 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004982 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01004983 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07004984 * fail incorrectly leading to premature concurrency
4985 * management operations.
4986 */
4987 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4988 worker_flags |= WORKER_REBOUND;
4989 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004990 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004991 }
4992
Tejun Heoa9ab7752013-03-19 13:45:21 -07004993 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004994}
4995
Tejun Heo7dbc7252013-03-19 13:45:21 -07004996/**
4997 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4998 * @pool: unbound pool of interest
4999 * @cpu: the CPU which is coming up
5000 *
5001 * An unbound pool may end up with a cpumask which doesn't have any online
5002 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5003 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5004 * online CPU before, cpus_allowed of all its workers should be restored.
5005 */
5006static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5007{
5008 static cpumask_t cpumask;
5009 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005010
Tejun Heo1258fae2018-05-18 08:47:13 -07005011 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005012
5013 /* is @cpu allowed for @pool? */
5014 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5015 return;
5016
Tejun Heo7dbc7252013-03-19 13:45:21 -07005017 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005018
5019 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08005020 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02005021 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005022}
5023
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005024int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07005025{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005026 struct worker_pool *pool;
5027
5028 for_each_cpu_worker_pool(pool, cpu) {
5029 if (pool->nr_workers)
5030 continue;
5031 if (!create_worker(pool))
5032 return -ENOMEM;
5033 }
5034 return 0;
5035}
5036
5037int workqueue_online_cpu(unsigned int cpu)
5038{
Tejun Heo4ce62e92012-07-13 22:16:44 -07005039 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07005040 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07005041 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005042
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005043 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07005044
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005045 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07005046 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07005047
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005048 if (pool->cpu == cpu)
5049 rebind_workers(pool);
5050 else if (pool->cpu < 0)
5051 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005052
Tejun Heo1258fae2018-05-18 08:47:13 -07005053 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005054 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005055
5056 /* update NUMA affinity of unbound workqueues */
5057 list_for_each_entry(wq, &workqueues, list)
5058 wq_update_unbound_numa(wq, cpu, true);
5059
5060 mutex_unlock(&wq_pool_mutex);
5061 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005062}
5063
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005064int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005065{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005066 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005067
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005068 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005069 if (WARN_ON(cpu != smp_processor_id()))
5070 return -1;
5071
5072 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005073
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005074 /* update NUMA affinity of unbound workqueues */
5075 mutex_lock(&wq_pool_mutex);
5076 list_for_each_entry(wq, &workqueues, list)
5077 wq_update_unbound_numa(wq, cpu, false);
5078 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005079
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005080 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005081}
5082
Rusty Russell2d3854a2008-11-05 13:39:10 +11005083struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005084 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005085 long (*fn)(void *);
5086 void *arg;
5087 long ret;
5088};
5089
Tejun Heoed48ece2012-09-18 12:48:43 -07005090static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005091{
Tejun Heoed48ece2012-09-18 12:48:43 -07005092 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5093
Rusty Russell2d3854a2008-11-05 13:39:10 +11005094 wfc->ret = wfc->fn(wfc->arg);
5095}
5096
5097/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005098 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005099 * @cpu: the cpu to run on
5100 * @fn: the function to run
5101 * @arg: the function arg
5102 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005103 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005104 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005105 *
5106 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005107 */
Tejun Heod84ff052013-03-12 11:29:59 -07005108long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005109{
Tejun Heoed48ece2012-09-18 12:48:43 -07005110 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005111
Tejun Heoed48ece2012-09-18 12:48:43 -07005112 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5113 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005114 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005115 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005116 return wfc.ret;
5117}
5118EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005119
5120/**
5121 * work_on_cpu_safe - run a function in thread context on a particular cpu
5122 * @cpu: the cpu to run on
5123 * @fn: the function to run
5124 * @arg: the function argument
5125 *
5126 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5127 * any locks which would prevent @fn from completing.
5128 *
5129 * Return: The value @fn returns.
5130 */
5131long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5132{
5133 long ret = -ENODEV;
5134
5135 get_online_cpus();
5136 if (cpu_online(cpu))
5137 ret = work_on_cpu(cpu, fn, arg);
5138 put_online_cpus();
5139 return ret;
5140}
5141EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005142#endif /* CONFIG_SMP */
5143
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005144#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305145
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005146/**
5147 * freeze_workqueues_begin - begin freezing workqueues
5148 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005149 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005150 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005151 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005152 *
5153 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005154 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005155 */
5156void freeze_workqueues_begin(void)
5157{
Tejun Heo24b8a842013-03-12 11:29:58 -07005158 struct workqueue_struct *wq;
5159 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005160
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005161 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005162
Tejun Heo6183c002013-03-12 11:29:57 -07005163 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005164 workqueue_freezing = true;
5165
Tejun Heo24b8a842013-03-12 11:29:58 -07005166 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005167 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005168 for_each_pwq(pwq, wq)
5169 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005170 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005171 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005172
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005173 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005174}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005175
5176/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005177 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005178 *
5179 * Check whether freezing is complete. This function must be called
5180 * between freeze_workqueues_begin() and thaw_workqueues().
5181 *
5182 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005183 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005184 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005185 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005186 * %true if some freezable workqueues are still busy. %false if freezing
5187 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005188 */
5189bool freeze_workqueues_busy(void)
5190{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005191 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005192 struct workqueue_struct *wq;
5193 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005194
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005195 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005196
Tejun Heo6183c002013-03-12 11:29:57 -07005197 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005198
Tejun Heo24b8a842013-03-12 11:29:58 -07005199 list_for_each_entry(wq, &workqueues, list) {
5200 if (!(wq->flags & WQ_FREEZABLE))
5201 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005202 /*
5203 * nr_active is monotonically decreasing. It's safe
5204 * to peek without lock.
5205 */
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005206 rcu_read_lock();
Tejun Heo24b8a842013-03-12 11:29:58 -07005207 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005208 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005209 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005210 busy = true;
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005211 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005212 goto out_unlock;
5213 }
5214 }
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005215 rcu_read_unlock();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005216 }
5217out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005218 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005219 return busy;
5220}
5221
5222/**
5223 * thaw_workqueues - thaw workqueues
5224 *
5225 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005226 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005227 *
5228 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005229 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005230 */
5231void thaw_workqueues(void)
5232{
Tejun Heo24b8a842013-03-12 11:29:58 -07005233 struct workqueue_struct *wq;
5234 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005235
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005236 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005237
5238 if (!workqueue_freezing)
5239 goto out_unlock;
5240
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005241 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005242
Tejun Heo24b8a842013-03-12 11:29:58 -07005243 /* restore max_active and repopulate worklist */
5244 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005245 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005246 for_each_pwq(pwq, wq)
5247 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005248 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005249 }
5250
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005251out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005252 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005253}
5254#endif /* CONFIG_FREEZER */
5255
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005256static int workqueue_apply_unbound_cpumask(void)
5257{
5258 LIST_HEAD(ctxs);
5259 int ret = 0;
5260 struct workqueue_struct *wq;
5261 struct apply_wqattrs_ctx *ctx, *n;
5262
5263 lockdep_assert_held(&wq_pool_mutex);
5264
5265 list_for_each_entry(wq, &workqueues, list) {
5266 if (!(wq->flags & WQ_UNBOUND))
5267 continue;
5268 /* creating multiple pwqs breaks ordering guarantee */
5269 if (wq->flags & __WQ_ORDERED)
5270 continue;
5271
5272 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5273 if (!ctx) {
5274 ret = -ENOMEM;
5275 break;
5276 }
5277
5278 list_add_tail(&ctx->list, &ctxs);
5279 }
5280
5281 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5282 if (!ret)
5283 apply_wqattrs_commit(ctx);
5284 apply_wqattrs_cleanup(ctx);
5285 }
5286
5287 return ret;
5288}
5289
5290/**
5291 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5292 * @cpumask: the cpumask to set
5293 *
5294 * The low-level workqueues cpumask is a global cpumask that limits
5295 * the affinity of all unbound workqueues. This function check the @cpumask
5296 * and apply it to all unbound workqueues and updates all pwqs of them.
5297 *
5298 * Retun: 0 - Success
5299 * -EINVAL - Invalid @cpumask
5300 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5301 */
5302int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5303{
5304 int ret = -EINVAL;
5305 cpumask_var_t saved_cpumask;
5306
5307 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5308 return -ENOMEM;
5309
Tal Shorerc98a9802017-11-03 17:27:50 +02005310 /*
5311 * Not excluding isolated cpus on purpose.
5312 * If the user wishes to include them, we allow that.
5313 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005314 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5315 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005316 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005317
5318 /* save the old wq_unbound_cpumask. */
5319 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5320
5321 /* update wq_unbound_cpumask at first and apply it to wqs. */
5322 cpumask_copy(wq_unbound_cpumask, cpumask);
5323 ret = workqueue_apply_unbound_cpumask();
5324
5325 /* restore the wq_unbound_cpumask when failed. */
5326 if (ret < 0)
5327 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5328
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005329 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005330 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005331
5332 free_cpumask_var(saved_cpumask);
5333 return ret;
5334}
5335
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005336#ifdef CONFIG_SYSFS
5337/*
5338 * Workqueues with WQ_SYSFS flag set is visible to userland via
5339 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5340 * following attributes.
5341 *
5342 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5343 * max_active RW int : maximum number of in-flight work items
5344 *
5345 * Unbound workqueues have the following extra attributes.
5346 *
Wang Long9a19b462017-11-02 23:05:12 -04005347 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005348 * nice RW int : nice value of the workers
5349 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005350 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005351 */
5352struct wq_device {
5353 struct workqueue_struct *wq;
5354 struct device dev;
5355};
5356
5357static struct workqueue_struct *dev_to_wq(struct device *dev)
5358{
5359 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5360
5361 return wq_dev->wq;
5362}
5363
5364static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5365 char *buf)
5366{
5367 struct workqueue_struct *wq = dev_to_wq(dev);
5368
5369 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5370}
5371static DEVICE_ATTR_RO(per_cpu);
5372
5373static ssize_t max_active_show(struct device *dev,
5374 struct device_attribute *attr, char *buf)
5375{
5376 struct workqueue_struct *wq = dev_to_wq(dev);
5377
5378 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5379}
5380
5381static ssize_t max_active_store(struct device *dev,
5382 struct device_attribute *attr, const char *buf,
5383 size_t count)
5384{
5385 struct workqueue_struct *wq = dev_to_wq(dev);
5386 int val;
5387
5388 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5389 return -EINVAL;
5390
5391 workqueue_set_max_active(wq, val);
5392 return count;
5393}
5394static DEVICE_ATTR_RW(max_active);
5395
5396static struct attribute *wq_sysfs_attrs[] = {
5397 &dev_attr_per_cpu.attr,
5398 &dev_attr_max_active.attr,
5399 NULL,
5400};
5401ATTRIBUTE_GROUPS(wq_sysfs);
5402
5403static ssize_t wq_pool_ids_show(struct device *dev,
5404 struct device_attribute *attr, char *buf)
5405{
5406 struct workqueue_struct *wq = dev_to_wq(dev);
5407 const char *delim = "";
5408 int node, written = 0;
5409
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005410 get_online_cpus();
5411 rcu_read_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005412 for_each_node(node) {
5413 written += scnprintf(buf + written, PAGE_SIZE - written,
5414 "%s%d:%d", delim, node,
5415 unbound_pwq_by_node(wq, node)->pool->id);
5416 delim = " ";
5417 }
5418 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Thomas Gleixner24acfb72019-03-13 17:55:47 +01005419 rcu_read_unlock();
5420 put_online_cpus();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005421
5422 return written;
5423}
5424
5425static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5426 char *buf)
5427{
5428 struct workqueue_struct *wq = dev_to_wq(dev);
5429 int written;
5430
5431 mutex_lock(&wq->mutex);
5432 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5433 mutex_unlock(&wq->mutex);
5434
5435 return written;
5436}
5437
5438/* prepare workqueue_attrs for sysfs store operations */
5439static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5440{
5441 struct workqueue_attrs *attrs;
5442
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005443 lockdep_assert_held(&wq_pool_mutex);
5444
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005445 attrs = alloc_workqueue_attrs();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005446 if (!attrs)
5447 return NULL;
5448
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005449 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005450 return attrs;
5451}
5452
5453static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5454 const char *buf, size_t count)
5455{
5456 struct workqueue_struct *wq = dev_to_wq(dev);
5457 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005458 int ret = -ENOMEM;
5459
5460 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005461
5462 attrs = wq_sysfs_prep_attrs(wq);
5463 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005464 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005465
5466 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5467 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005468 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005469 else
5470 ret = -EINVAL;
5471
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005472out_unlock:
5473 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005474 free_workqueue_attrs(attrs);
5475 return ret ?: count;
5476}
5477
5478static ssize_t wq_cpumask_show(struct device *dev,
5479 struct device_attribute *attr, char *buf)
5480{
5481 struct workqueue_struct *wq = dev_to_wq(dev);
5482 int written;
5483
5484 mutex_lock(&wq->mutex);
5485 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5486 cpumask_pr_args(wq->unbound_attrs->cpumask));
5487 mutex_unlock(&wq->mutex);
5488 return written;
5489}
5490
5491static ssize_t wq_cpumask_store(struct device *dev,
5492 struct device_attribute *attr,
5493 const char *buf, size_t count)
5494{
5495 struct workqueue_struct *wq = dev_to_wq(dev);
5496 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005497 int ret = -ENOMEM;
5498
5499 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005500
5501 attrs = wq_sysfs_prep_attrs(wq);
5502 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005503 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005504
5505 ret = cpumask_parse(buf, attrs->cpumask);
5506 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005507 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005508
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005509out_unlock:
5510 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005511 free_workqueue_attrs(attrs);
5512 return ret ?: count;
5513}
5514
5515static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5516 char *buf)
5517{
5518 struct workqueue_struct *wq = dev_to_wq(dev);
5519 int written;
5520
5521 mutex_lock(&wq->mutex);
5522 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5523 !wq->unbound_attrs->no_numa);
5524 mutex_unlock(&wq->mutex);
5525
5526 return written;
5527}
5528
5529static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5530 const char *buf, size_t count)
5531{
5532 struct workqueue_struct *wq = dev_to_wq(dev);
5533 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005534 int v, ret = -ENOMEM;
5535
5536 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005537
5538 attrs = wq_sysfs_prep_attrs(wq);
5539 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005540 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005541
5542 ret = -EINVAL;
5543 if (sscanf(buf, "%d", &v) == 1) {
5544 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005545 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005546 }
5547
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005548out_unlock:
5549 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005550 free_workqueue_attrs(attrs);
5551 return ret ?: count;
5552}
5553
5554static struct device_attribute wq_sysfs_unbound_attrs[] = {
5555 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5556 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5557 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5558 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5559 __ATTR_NULL,
5560};
5561
5562static struct bus_type wq_subsys = {
5563 .name = "workqueue",
5564 .dev_groups = wq_sysfs_groups,
5565};
5566
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005567static ssize_t wq_unbound_cpumask_show(struct device *dev,
5568 struct device_attribute *attr, char *buf)
5569{
5570 int written;
5571
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005572 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005573 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5574 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005575 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005576
5577 return written;
5578}
5579
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005580static ssize_t wq_unbound_cpumask_store(struct device *dev,
5581 struct device_attribute *attr, const char *buf, size_t count)
5582{
5583 cpumask_var_t cpumask;
5584 int ret;
5585
5586 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5587 return -ENOMEM;
5588
5589 ret = cpumask_parse(buf, cpumask);
5590 if (!ret)
5591 ret = workqueue_set_unbound_cpumask(cpumask);
5592
5593 free_cpumask_var(cpumask);
5594 return ret ? ret : count;
5595}
5596
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005597static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005598 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5599 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005600
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005601static int __init wq_sysfs_init(void)
5602{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005603 int err;
5604
5605 err = subsys_virtual_register(&wq_subsys, NULL);
5606 if (err)
5607 return err;
5608
5609 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005610}
5611core_initcall(wq_sysfs_init);
5612
5613static void wq_device_release(struct device *dev)
5614{
5615 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5616
5617 kfree(wq_dev);
5618}
5619
5620/**
5621 * workqueue_sysfs_register - make a workqueue visible in sysfs
5622 * @wq: the workqueue to register
5623 *
5624 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5625 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5626 * which is the preferred method.
5627 *
5628 * Workqueue user should use this function directly iff it wants to apply
5629 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5630 * apply_workqueue_attrs() may race against userland updating the
5631 * attributes.
5632 *
5633 * Return: 0 on success, -errno on failure.
5634 */
5635int workqueue_sysfs_register(struct workqueue_struct *wq)
5636{
5637 struct wq_device *wq_dev;
5638 int ret;
5639
5640 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305641 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005642 * attributes breaks ordering guarantee. Disallow exposing ordered
5643 * workqueues.
5644 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005645 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005646 return -EINVAL;
5647
5648 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5649 if (!wq_dev)
5650 return -ENOMEM;
5651
5652 wq_dev->wq = wq;
5653 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005654 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005655 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005656
5657 /*
5658 * unbound_attrs are created separately. Suppress uevent until
5659 * everything is ready.
5660 */
5661 dev_set_uevent_suppress(&wq_dev->dev, true);
5662
5663 ret = device_register(&wq_dev->dev);
5664 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305665 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005666 wq->wq_dev = NULL;
5667 return ret;
5668 }
5669
5670 if (wq->flags & WQ_UNBOUND) {
5671 struct device_attribute *attr;
5672
5673 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5674 ret = device_create_file(&wq_dev->dev, attr);
5675 if (ret) {
5676 device_unregister(&wq_dev->dev);
5677 wq->wq_dev = NULL;
5678 return ret;
5679 }
5680 }
5681 }
5682
5683 dev_set_uevent_suppress(&wq_dev->dev, false);
5684 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5685 return 0;
5686}
5687
5688/**
5689 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5690 * @wq: the workqueue to unregister
5691 *
5692 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5693 */
5694static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5695{
5696 struct wq_device *wq_dev = wq->wq_dev;
5697
5698 if (!wq->wq_dev)
5699 return;
5700
5701 wq->wq_dev = NULL;
5702 device_unregister(&wq_dev->dev);
5703}
5704#else /* CONFIG_SYSFS */
5705static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5706#endif /* CONFIG_SYSFS */
5707
Tejun Heo82607adc2015-12-08 11:28:04 -05005708/*
5709 * Workqueue watchdog.
5710 *
5711 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5712 * flush dependency, a concurrency managed work item which stays RUNNING
5713 * indefinitely. Workqueue stalls can be very difficult to debug as the
5714 * usual warning mechanisms don't trigger and internal workqueue state is
5715 * largely opaque.
5716 *
5717 * Workqueue watchdog monitors all worker pools periodically and dumps
5718 * state if some pools failed to make forward progress for a while where
5719 * forward progress is defined as the first item on ->worklist changing.
5720 *
5721 * This mechanism is controlled through the kernel parameter
5722 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5723 * corresponding sysfs parameter file.
5724 */
5725#ifdef CONFIG_WQ_WATCHDOG
5726
Tejun Heo82607adc2015-12-08 11:28:04 -05005727static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005728static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005729
5730static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5731static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5732
5733static void wq_watchdog_reset_touched(void)
5734{
5735 int cpu;
5736
5737 wq_watchdog_touched = jiffies;
5738 for_each_possible_cpu(cpu)
5739 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5740}
5741
Kees Cook5cd79d62017-10-04 16:27:00 -07005742static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005743{
5744 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5745 bool lockup_detected = false;
5746 struct worker_pool *pool;
5747 int pi;
5748
5749 if (!thresh)
5750 return;
5751
5752 rcu_read_lock();
5753
5754 for_each_pool(pool, pi) {
5755 unsigned long pool_ts, touched, ts;
5756
5757 if (list_empty(&pool->worklist))
5758 continue;
5759
5760 /* get the latest of pool and touched timestamps */
5761 pool_ts = READ_ONCE(pool->watchdog_ts);
5762 touched = READ_ONCE(wq_watchdog_touched);
5763
5764 if (time_after(pool_ts, touched))
5765 ts = pool_ts;
5766 else
5767 ts = touched;
5768
5769 if (pool->cpu >= 0) {
5770 unsigned long cpu_touched =
5771 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5772 pool->cpu));
5773 if (time_after(cpu_touched, ts))
5774 ts = cpu_touched;
5775 }
5776
5777 /* did we stall? */
5778 if (time_after(jiffies, ts + thresh)) {
5779 lockup_detected = true;
5780 pr_emerg("BUG: workqueue lockup - pool");
5781 pr_cont_pool_info(pool);
5782 pr_cont(" stuck for %us!\n",
5783 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5784 }
5785 }
5786
5787 rcu_read_unlock();
5788
5789 if (lockup_detected)
5790 show_workqueue_state();
5791
5792 wq_watchdog_reset_touched();
5793 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5794}
5795
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005796notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005797{
5798 if (cpu >= 0)
5799 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5800 else
5801 wq_watchdog_touched = jiffies;
5802}
5803
5804static void wq_watchdog_set_thresh(unsigned long thresh)
5805{
5806 wq_watchdog_thresh = 0;
5807 del_timer_sync(&wq_watchdog_timer);
5808
5809 if (thresh) {
5810 wq_watchdog_thresh = thresh;
5811 wq_watchdog_reset_touched();
5812 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5813 }
5814}
5815
5816static int wq_watchdog_param_set_thresh(const char *val,
5817 const struct kernel_param *kp)
5818{
5819 unsigned long thresh;
5820 int ret;
5821
5822 ret = kstrtoul(val, 0, &thresh);
5823 if (ret)
5824 return ret;
5825
5826 if (system_wq)
5827 wq_watchdog_set_thresh(thresh);
5828 else
5829 wq_watchdog_thresh = thresh;
5830
5831 return 0;
5832}
5833
5834static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5835 .set = wq_watchdog_param_set_thresh,
5836 .get = param_get_ulong,
5837};
5838
5839module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5840 0644);
5841
5842static void wq_watchdog_init(void)
5843{
Kees Cook5cd79d62017-10-04 16:27:00 -07005844 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005845 wq_watchdog_set_thresh(wq_watchdog_thresh);
5846}
5847
5848#else /* CONFIG_WQ_WATCHDOG */
5849
5850static inline void wq_watchdog_init(void) { }
5851
5852#endif /* CONFIG_WQ_WATCHDOG */
5853
Tejun Heobce90382013-04-01 11:23:32 -07005854static void __init wq_numa_init(void)
5855{
5856 cpumask_var_t *tbl;
5857 int node, cpu;
5858
Tejun Heobce90382013-04-01 11:23:32 -07005859 if (num_possible_nodes() <= 1)
5860 return;
5861
Tejun Heod55262c2013-04-01 11:23:38 -07005862 if (wq_disable_numa) {
5863 pr_info("workqueue: NUMA affinity support disabled\n");
5864 return;
5865 }
5866
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005867 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
Tejun Heo4c16bd32013-04-01 11:23:36 -07005868 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5869
Tejun Heobce90382013-04-01 11:23:32 -07005870 /*
5871 * We want masks of possible CPUs of each node which isn't readily
5872 * available. Build one from cpu_to_node() which should have been
5873 * fully initialized by now.
5874 */
Kees Cook6396bb22018-06-12 14:03:40 -07005875 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005876 BUG_ON(!tbl);
5877
5878 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005879 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005880 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005881
5882 for_each_possible_cpu(cpu) {
5883 node = cpu_to_node(cpu);
5884 if (WARN_ON(node == NUMA_NO_NODE)) {
5885 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5886 /* happens iff arch is bonkers, let's just proceed */
5887 return;
5888 }
5889 cpumask_set_cpu(cpu, tbl[node]);
5890 }
5891
5892 wq_numa_possible_cpumask = tbl;
5893 wq_numa_enabled = true;
5894}
5895
Tejun Heo3347fa02016-09-16 15:49:32 -04005896/**
5897 * workqueue_init_early - early init for workqueue subsystem
5898 *
5899 * This is the first half of two-staged workqueue subsystem initialization
5900 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5901 * idr are up. It sets up all the data structures and system workqueues
5902 * and allows early boot code to create workqueues and queue/cancel work
5903 * items. Actual work item execution starts only after kthreads can be
5904 * created and scheduled right before early initcalls.
5905 */
5906int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005907{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005908 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005909 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005910 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005911
Tejun Heoe904e6c2013-03-12 11:29:57 -07005912 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5913
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005914 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005915 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005916
Tejun Heoe904e6c2013-03-12 11:29:57 -07005917 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5918
Tejun Heo706026c2013-01-24 11:01:34 -08005919 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005920 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005921 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005922
Tejun Heo7a4e3442013-03-12 11:30:00 -07005923 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005924 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005925 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005926 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005927 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005928 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005929 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005930
Tejun Heo9daf9e62013-01-24 11:01:33 -08005931 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005932 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005933 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005934 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005935 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005936 }
5937
Tejun Heo8a2b7532013-09-05 12:30:04 -04005938 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005939 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5940 struct workqueue_attrs *attrs;
5941
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005942 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo29c91e92013-03-12 11:30:03 -07005943 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005944 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005945
5946 /*
5947 * An ordered wq should have only one pwq as ordering is
5948 * guaranteed by max_active which is enforced by pwqs.
5949 * Turn off NUMA so that dfl_pwq is used for all nodes.
5950 */
Thomas Gleixnerbe69d002019-06-26 16:52:38 +02005951 BUG_ON(!(attrs = alloc_workqueue_attrs()));
Tejun Heo8a2b7532013-09-05 12:30:04 -04005952 attrs->nice = std_nice[i];
5953 attrs->no_numa = true;
5954 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005955 }
5956
Tejun Heod320c032010-06-29 10:07:14 +02005957 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005958 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005959 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005960 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5961 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005962 system_freezable_wq = alloc_workqueue("events_freezable",
5963 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305964 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5965 WQ_POWER_EFFICIENT, 0);
5966 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5967 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5968 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005969 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305970 !system_unbound_wq || !system_freezable_wq ||
5971 !system_power_efficient_wq ||
5972 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005973
Tejun Heo3347fa02016-09-16 15:49:32 -04005974 return 0;
5975}
5976
5977/**
5978 * workqueue_init - bring workqueue subsystem fully online
5979 *
5980 * This is the latter half of two-staged workqueue subsystem initialization
5981 * and invoked as soon as kthreads can be created and scheduled.
5982 * Workqueues have been created and work items queued on them, but there
5983 * are no kworkers executing the work items yet. Populate the worker pools
5984 * with the initial workers and enable future kworker creations.
5985 */
5986int __init workqueue_init(void)
5987{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005988 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005989 struct worker_pool *pool;
5990 int cpu, bkt;
5991
Tejun Heo2186d9f2016-10-19 12:01:27 -04005992 /*
5993 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5994 * CPU to node mapping may not be available that early on some
5995 * archs such as power and arm64. As per-cpu pools created
5996 * previously could be missing node hint and unbound pools NUMA
5997 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005998 *
5999 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04006000 */
6001 wq_numa_init();
6002
6003 mutex_lock(&wq_pool_mutex);
6004
6005 for_each_possible_cpu(cpu) {
6006 for_each_cpu_worker_pool(pool, cpu) {
6007 pool->node = cpu_to_node(cpu);
6008 }
6009 }
6010
Tejun Heo40c17f72018-01-08 05:38:37 -08006011 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04006012 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08006013 WARN(init_rescuer(wq),
6014 "workqueue: failed to create early rescuer for %s",
6015 wq->name);
6016 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04006017
6018 mutex_unlock(&wq_pool_mutex);
6019
Tejun Heo3347fa02016-09-16 15:49:32 -04006020 /* create the initial workers */
6021 for_each_online_cpu(cpu) {
6022 for_each_cpu_worker_pool(pool, cpu) {
6023 pool->flags &= ~POOL_DISASSOCIATED;
6024 BUG_ON(!create_worker(pool));
6025 }
6026 }
6027
6028 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6029 BUG_ON(!create_worker(pool));
6030
6031 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05006032 wq_watchdog_init();
6033
Suresh Siddha6ee05782010-07-30 14:57:37 -07006034 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07006035}