blob: ddee541ea97aa63863ebcdbee26c437de6b63e42 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070024 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070044#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050045#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070046#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070047#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070048#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070049#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020050#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090051#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020052
Tejun Heoea138442013-01-18 14:05:55 -080053#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070056 /*
Tejun Heo24647572013-01-24 11:01:33 -080057 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 *
Tejun Heo24647572013-01-24 11:01:33 -080059 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 * While associated (!DISASSOCIATED), all workers are bound to the
61 * CPU and none has %WORKER_UNBOUND set and concurrency management
62 * is in effect.
63 *
64 * While DISASSOCIATED, the cpu may be offline and all workers have
65 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080066 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070067 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070068 * Note that DISASSOCIATED should be flipped only while holding
Tejun Heo1258fae2018-05-18 08:47:13 -070069 * wq_pool_attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080070 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070071 */
Tejun Heo692b4822017-10-09 08:04:13 -070072 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080073 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020074
Tejun Heoc8e55f32010-06-29 10:07:12 +020075 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 WORKER_DIE = 1 << 1, /* die die die */
77 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020078 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020079 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020080 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020082
Tejun Heoa9ab7752013-03-19 13:45:21 -070083 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
84 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020085
Tejun Heoe34cdddb2013-01-24 11:01:33 -080086 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070087
Tejun Heo29c91e92013-03-12 11:30:03 -070088 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020089 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020090
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
92 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
93
Tejun Heo3233cdb2011-02-16 18:10:19 +010094 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
95 /* call for help after 10ms
96 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020097 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
98 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020099
100 /*
101 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200103 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800104 RESCUER_NICE_LEVEL = MIN_NICE,
105 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700106
107 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200108};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200111 * Structure fields follow one of the following exclusion rules.
112 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200113 * I: Modifiable by initialization/destruction paths and read-only for
114 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * P: Preemption protected. Disabling preemption is enough and should
117 * only be modified and accessed from the local cpu.
118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200120 *
Tejun Heod565ed62013-01-24 11:01:33 -0800121 * X: During normal operation, modification requires pool->lock and should
122 * be done only from local cpu. Either disabling preemption on local
123 * cpu or grabbing pool->lock is enough for read access. If
124 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200125 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700126 * A: wq_pool_attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700129 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700130 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700131 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800132 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
133 *
134 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
135 * sched-RCU for reads.
136 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700137 * WQ: wq->mutex protected.
138 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700139 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700140 *
141 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200142 */
143
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800144/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200145
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800147 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700148 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700149 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800150 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700151 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700152
Tejun Heo82607adc2015-12-08 11:28:04 -0500153 unsigned long watchdog_ts; /* L: watchdog timestamp */
154
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700156
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800157 int nr_workers; /* L: total number of workers */
158 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159
160 struct list_head idle_list; /* X: list of idle workers */
161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for workers */
163
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700164 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800165 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
166 /* L: hash of busy workers */
167
Tejun Heo2607d7a2015-03-09 09:22:28 -0400168 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800169 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800170 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800171
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800172 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Tejun Heo7a4e3442013-03-12 11:30:00 -0700174 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700175 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
176 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700177
Tejun Heoe19e3972013-01-24 11:39:44 -0800178 /*
179 * The current concurrency level. As it's likely to be accessed
180 * from other CPUs during try_to_wake_up(), put it in a separate
181 * cacheline.
182 */
183 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700184
185 /*
186 * Destruction of pool is sched-RCU protected to allow dereferences
187 * from get_work_pool().
188 */
189 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200190} ____cacheline_aligned_in_smp;
191
192/*
Tejun Heo112202d2013-02-13 19:29:12 -0800193 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
194 * of work_struct->data are used for flags and the remaining high bits
195 * point to the pwq; thus, pwqs need to be aligned at two's power of the
196 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
Tejun Heo112202d2013-02-13 19:29:12 -0800198struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700199 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200200 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200201 int work_color; /* L: current color */
202 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700203 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 int nr_in_flight[WORK_NR_COLORS];
205 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200206 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200207 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700209 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700210 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211
212 /*
213 * Release of unbound pwq is punted to system_wq. See put_pwq()
214 * and pwq_unbound_release_workfn() for details. pool_workqueue
215 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700216 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700217 */
218 struct work_struct unbound_release_work;
219 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700220} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 * Structure used to wait for workqueue flush.
224 */
225struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700226 struct list_head list; /* WQ: list of flushers */
227 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200228 struct completion done; /* flush completion */
229};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Tejun Heo226223a2013-03-12 11:30:05 -0700231struct wq_device;
232
Tejun Heo73f53c42010-06-29 10:07:11 +0200233/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700234 * The externally visible workqueue. It relays the issued work items to
235 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 */
237struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700238 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400239 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200240
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct mutex mutex; /* protects this wq */
242 int work_color; /* WQ: current work color */
243 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800244 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct wq_flusher *first_flusher; /* WQ: first flusher */
246 struct list_head flusher_queue; /* WQ: flush waiters */
247 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200248
Tejun Heo2e109a22013-03-13 19:47:40 -0700249 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200250 struct worker *rescuer; /* I: rescue worker */
251
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700252 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700253 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700254
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800255 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
256 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700257
Tejun Heo226223a2013-03-12 11:30:05 -0700258#ifdef CONFIG_SYSFS
259 struct wq_device *wq_dev; /* I: for sysfs interface */
260#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700261#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800262 char *lock_name;
263 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700266 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700267
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400268 /*
269 * Destruction of workqueue_struct is sched-RCU protected to allow
270 * walking the workqueues list without grabbing wq_pool_mutex.
271 * This is used to dump all workqueues from sysrq.
272 */
273 struct rcu_head rcu;
274
Tejun Heo2728fd22013-04-01 11:23:35 -0700275 /* hot fields used during command issue, aligned to cacheline */
276 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
277 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800278 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279};
280
Tejun Heoe904e6c2013-03-12 11:29:57 -0700281static struct kmem_cache *pwq_cache;
282
Tejun Heobce90382013-04-01 11:23:32 -0700283static cpumask_var_t *wq_numa_possible_cpumask;
284 /* possible CPUs of each node */
285
Tejun Heod55262c2013-04-01 11:23:38 -0700286static bool wq_disable_numa;
287module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930290static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292
Tejun Heo863b7102016-09-16 15:49:34 -0400293static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400294
Tejun Heobce90382013-04-01 11:23:32 -0700295static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
296
Tejun Heo4c16bd32013-04-01 11:23:36 -0700297/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
298static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
299
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700301static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Tejun Heo2e109a22013-03-13 19:47:40 -0700302static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo692b4822017-10-09 08:04:13 -0700303static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700304
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400305static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700306static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700307
Mike Galbraithef5571802016-02-09 17:59:38 -0500308/* PL: allowable cpus for unbound wqs and work items */
309static cpumask_var_t wq_unbound_cpumask;
310
311/* CPU where unbound work was last round robin scheduled from this CPU */
312static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800313
Tejun Heof303fccb2016-02-09 17:59:38 -0500314/*
315 * Local execution of unbound work items is no longer guaranteed. The
316 * following always forces round-robin CPU selection on unbound work items
317 * to uncover usages which depend on it.
318 */
319#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
320static bool wq_debug_force_rr_cpu = true;
321#else
322static bool wq_debug_force_rr_cpu = false;
323#endif
324module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
325
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700326/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700327static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700328
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700329static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700330
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700331/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700332static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
333
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700334/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700335static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
336
Tejun Heo8a2b7532013-09-05 12:30:04 -0400337/* I: attributes used when instantiating ordered pools on demand */
338static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
339
Tejun Heod320c032010-06-29 10:07:14 +0200340struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400341EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300342struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900343EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200345EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300346struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200347EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300348struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100349EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530350struct workqueue_struct *system_power_efficient_wq __read_mostly;
351EXPORT_SYMBOL_GPL(system_power_efficient_wq);
352struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
353EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200354
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700355static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800356static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700357
Tejun Heo97bd2342010-10-05 10:41:14 +0200358#define CREATE_TRACE_POINTS
359#include <trace/events/workqueue.h>
360
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700361#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700362 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
363 !lockdep_is_held(&wq_pool_mutex), \
364 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700365
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700366#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700367 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
368 !lockdep_is_held(&wq->mutex), \
369 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700370
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800371#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700372 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
373 !lockdep_is_held(&wq->mutex) && \
374 !lockdep_is_held(&wq_pool_mutex), \
375 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800376
Tejun Heof02ae732013-03-12 11:30:03 -0700377#define for_each_cpu_worker_pool(pool, cpu) \
378 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
379 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700380 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700381
Tejun Heo49e3cf42013-03-12 11:29:58 -0700382/**
Tejun Heo17116962013-03-12 11:29:58 -0700383 * for_each_pool - iterate through all worker_pools in the system
384 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700385 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700386 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700387 * This must be called either with wq_pool_mutex held or sched RCU read
388 * locked. If the pool needs to be used beyond the locking in effect, the
389 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700390 *
391 * The if/else clause exists only for the lockdep assertion and can be
392 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700393 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700394#define for_each_pool(pool, pi) \
395 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700396 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700397 else
Tejun Heo17116962013-03-12 11:29:58 -0700398
399/**
Tejun Heo822d8402013-03-19 13:45:21 -0700400 * for_each_pool_worker - iterate through all workers of a worker_pool
401 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700402 * @pool: worker_pool to iterate workers of
403 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700404 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700405 *
406 * The if/else clause exists only for the lockdep assertion and can be
407 * ignored.
408 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800409#define for_each_pool_worker(worker, pool) \
410 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700411 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700412 else
413
414/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700415 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
416 * @pwq: iteration cursor
417 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700418 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700419 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700420 * If the pwq needs to be used beyond the locking in effect, the caller is
421 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700422 *
423 * The if/else clause exists only for the lockdep assertion and can be
424 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700425 */
426#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700427 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700428 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700429 else
Tejun Heof3421792010-07-02 10:03:51 +0200430
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900431#ifdef CONFIG_DEBUG_OBJECTS_WORK
432
433static struct debug_obj_descr work_debug_descr;
434
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100435static void *work_debug_hint(void *addr)
436{
437 return ((struct work_struct *) addr)->func;
438}
439
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700440static bool work_is_static_object(void *addr)
441{
442 struct work_struct *work = addr;
443
444 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
445}
446
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900447/*
448 * fixup_init is called when:
449 * - an active object is initialized
450 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700451static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900452{
453 struct work_struct *work = addr;
454
455 switch (state) {
456 case ODEBUG_STATE_ACTIVE:
457 cancel_work_sync(work);
458 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700459 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900460 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700461 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462 }
463}
464
465/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900466 * fixup_free is called when:
467 * - an active object is freed
468 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700469static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900470{
471 struct work_struct *work = addr;
472
473 switch (state) {
474 case ODEBUG_STATE_ACTIVE:
475 cancel_work_sync(work);
476 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700479 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900480 }
481}
482
483static struct debug_obj_descr work_debug_descr = {
484 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100485 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700486 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900487 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900488 .fixup_free = work_fixup_free,
489};
490
491static inline void debug_work_activate(struct work_struct *work)
492{
493 debug_object_activate(work, &work_debug_descr);
494}
495
496static inline void debug_work_deactivate(struct work_struct *work)
497{
498 debug_object_deactivate(work, &work_debug_descr);
499}
500
501void __init_work(struct work_struct *work, int onstack)
502{
503 if (onstack)
504 debug_object_init_on_stack(work, &work_debug_descr);
505 else
506 debug_object_init(work, &work_debug_descr);
507}
508EXPORT_SYMBOL_GPL(__init_work);
509
510void destroy_work_on_stack(struct work_struct *work)
511{
512 debug_object_free(work, &work_debug_descr);
513}
514EXPORT_SYMBOL_GPL(destroy_work_on_stack);
515
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000516void destroy_delayed_work_on_stack(struct delayed_work *work)
517{
518 destroy_timer_on_stack(&work->timer);
519 debug_object_free(&work->work, &work_debug_descr);
520}
521EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
522
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900523#else
524static inline void debug_work_activate(struct work_struct *work) { }
525static inline void debug_work_deactivate(struct work_struct *work) { }
526#endif
527
Li Bin4e8b22b2013-09-10 09:52:35 +0800528/**
529 * worker_pool_assign_id - allocate ID and assing it to @pool
530 * @pool: the pool pointer of interest
531 *
532 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
533 * successfully, -errno on failure.
534 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800535static int worker_pool_assign_id(struct worker_pool *pool)
536{
537 int ret;
538
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700539 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700540
Li Bin4e8b22b2013-09-10 09:52:35 +0800541 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
542 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700543 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700544 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700545 return 0;
546 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800547 return ret;
548}
549
Tejun Heo76af4d92013-03-12 11:30:00 -0700550/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700551 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
552 * @wq: the target workqueue
553 * @node: the node ID
554 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800555 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
556 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700557 * If the pwq needs to be used beyond the locking in effect, the caller is
558 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700559 *
560 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700561 */
562static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563 int node)
564{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800565 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500566
567 /*
568 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
569 * delayed item is pending. The plan is to keep CPU -> NODE
570 * mapping valid and stable across CPU on/offlines. Once that
571 * happens, this workaround can be removed.
572 */
573 if (unlikely(node == NUMA_NO_NODE))
574 return wq->dfl_pwq;
575
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700576 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
577}
578
Tejun Heo73f53c42010-06-29 10:07:11 +0200579static unsigned int work_color_to_flags(int color)
580{
581 return color << WORK_STRUCT_COLOR_SHIFT;
582}
583
584static int get_work_color(struct work_struct *work)
585{
586 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
587 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
588}
589
590static int work_next_color(int color)
591{
592 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700593}
594
David Howells4594bf12006-12-07 11:33:26 +0000595/*
Tejun Heo112202d2013-02-13 19:29:12 -0800596 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
597 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800598 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 *
Tejun Heo112202d2013-02-13 19:29:12 -0800600 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
601 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700602 * work->data. These functions should only be called while the work is
603 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604 *
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800607 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700609 *
610 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
611 * canceled. While being canceled, a work item may have its PENDING set
612 * but stay off timer and worklist for arbitrarily long and nobody should
613 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000614 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200615static inline void set_work_data(struct work_struct *work, unsigned long data,
616 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000617{
Tejun Heo6183c002013-03-12 11:29:57 -0700618 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200619 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000620}
David Howells365970a2006-11-22 14:54:49 +0000621
Tejun Heo112202d2013-02-13 19:29:12 -0800622static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200623 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200624{
Tejun Heo112202d2013-02-13 19:29:12 -0800625 set_work_data(work, (unsigned long)pwq,
626 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200627}
628
Lai Jiangshan4468a002013-02-06 18:04:53 -0800629static void set_work_pool_and_keep_pending(struct work_struct *work,
630 int pool_id)
631{
632 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
633 WORK_STRUCT_PENDING);
634}
635
Tejun Heo7c3eed52013-01-24 11:01:33 -0800636static void set_work_pool_and_clear_pending(struct work_struct *work,
637 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000638{
Tejun Heo23657bb2012-08-13 17:08:19 -0700639 /*
640 * The following wmb is paired with the implied mb in
641 * test_and_set_bit(PENDING) and ensures all updates to @work made
642 * here are visible to and precede any updates by the next PENDING
643 * owner.
644 */
645 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800646 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200647 /*
648 * The following mb guarantees that previous clear of a PENDING bit
649 * will not be reordered with any speculative LOADS or STORES from
650 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800651 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200652 * the same @work. E.g. consider this case:
653 *
654 * CPU#0 CPU#1
655 * ---------------------------- --------------------------------
656 *
657 * 1 STORE event_indicated
658 * 2 queue_work_on() {
659 * 3 test_and_set_bit(PENDING)
660 * 4 } set_..._and_clear_pending() {
661 * 5 set_work_data() # clear bit
662 * 6 smp_mb()
663 * 7 work->current_func() {
664 * 8 LOAD event_indicated
665 * }
666 *
667 * Without an explicit full barrier speculative LOAD on line 8 can
668 * be executed before CPU#0 does STORE on line 1. If that happens,
669 * CPU#0 observes the PENDING bit is still set and new execution of
670 * a @work is not queued in a hope, that CPU#1 will eventually
671 * finish the queued @work. Meanwhile CPU#1 does not see
672 * event_indicated is set, because speculative LOAD was executed
673 * before actual STORE.
674 */
675 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200676}
677
678static void clear_work_data(struct work_struct *work)
679{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800680 smp_wmb(); /* see set_work_pool_and_clear_pending() */
681 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200682}
683
Tejun Heo112202d2013-02-13 19:29:12 -0800684static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685{
Tejun Heoe1201532010-07-22 14:14:25 +0200686 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200687
Tejun Heo112202d2013-02-13 19:29:12 -0800688 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200689 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
690 else
691 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200692}
693
Tejun Heo7c3eed52013-01-24 11:01:33 -0800694/**
695 * get_work_pool - return the worker_pool a given work was associated with
696 * @work: the work item of interest
697 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700698 * Pools are created and destroyed under wq_pool_mutex, and allows read
699 * access under sched-RCU read lock. As such, this function should be
700 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700701 *
702 * All fields of the returned pool are accessible as long as the above
703 * mentioned locking is in effect. If the returned pool needs to be used
704 * beyond the critical section, the caller is responsible for ensuring the
705 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700706 *
707 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800708 */
709static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200710{
Tejun Heoe1201532010-07-22 14:14:25 +0200711 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800712 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200713
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700714 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700715
Tejun Heo112202d2013-02-13 19:29:12 -0800716 if (data & WORK_STRUCT_PWQ)
717 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800718 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200719
Tejun Heo7c3eed52013-01-24 11:01:33 -0800720 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
721 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200722 return NULL;
723
Tejun Heofa1b54e2013-03-12 11:30:00 -0700724 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800725}
726
727/**
728 * get_work_pool_id - return the worker pool ID a given work is associated with
729 * @work: the work item of interest
730 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700731 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800732 * %WORK_OFFQ_POOL_NONE if none.
733 */
734static int get_work_pool_id(struct work_struct *work)
735{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800736 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800737
Tejun Heo112202d2013-02-13 19:29:12 -0800738 if (data & WORK_STRUCT_PWQ)
739 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800740 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
741
742 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800743}
744
Tejun Heobbb68df2012-08-03 10:30:46 -0700745static void mark_work_canceling(struct work_struct *work)
746{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700748
Tejun Heo7c3eed52013-01-24 11:01:33 -0800749 pool_id <<= WORK_OFFQ_POOL_SHIFT;
750 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700751}
752
753static bool work_is_canceling(struct work_struct *work)
754{
755 unsigned long data = atomic_long_read(&work->data);
756
Tejun Heo112202d2013-02-13 19:29:12 -0800757 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700758}
759
David Howells365970a2006-11-22 14:54:49 +0000760/*
Tejun Heo32704762012-07-13 22:16:45 -0700761 * Policy functions. These define the policies on how the global worker
762 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800763 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000764 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200765
Tejun Heo63d95a92012-07-12 14:46:37 -0700766static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000767{
Tejun Heoe19e3972013-01-24 11:39:44 -0800768 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000769}
770
Tejun Heoe22bee72010-06-29 10:07:14 +0200771/*
772 * Need to wake up a worker? Called from anything but currently
773 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700774 *
775 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800776 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700777 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200778 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700779static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000780{
Tejun Heo63d95a92012-07-12 14:46:37 -0700781 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000782}
783
Tejun Heoe22bee72010-06-29 10:07:14 +0200784/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700785static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200786{
Tejun Heo63d95a92012-07-12 14:46:37 -0700787 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200788}
789
790/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700791static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200792{
Tejun Heoe19e3972013-01-24 11:39:44 -0800793 return !list_empty(&pool->worklist) &&
794 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200795}
796
797/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700798static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200799{
Tejun Heo63d95a92012-07-12 14:46:37 -0700800 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200801}
802
Tejun Heoe22bee72010-06-29 10:07:14 +0200803/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700804static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200805{
Tejun Heo692b4822017-10-09 08:04:13 -0700806 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700807 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
808 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200809
810 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
811}
812
813/*
814 * Wake up functions.
815 */
816
Lai Jiangshan1037de32014-05-22 16:44:07 +0800817/* Return the first idle worker. Safe with preemption disabled */
818static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200819{
Tejun Heo63d95a92012-07-12 14:46:37 -0700820 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200821 return NULL;
822
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200824}
825
826/**
827 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200831 *
832 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800833 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200834 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700835static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200836{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800837 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200838
839 if (likely(worker))
840 wake_up_process(worker->task);
841}
842
Tejun Heo4690c4a2010-06-29 10:07:10 +0200843/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 * wq_worker_waking_up - a worker is waking up
845 * @task: task waking up
846 * @cpu: CPU @task is waking up to
847 *
848 * This function is called during try_to_wake_up() when a worker is
849 * being awoken.
850 *
851 * CONTEXT:
852 * spin_lock_irq(rq->lock)
853 */
Tejun Heod84ff052013-03-12 11:29:59 -0700854void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200855{
856 struct worker *worker = kthread_data(task);
857
Joonsoo Kim36576002012-10-26 23:03:49 +0900858 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800859 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800860 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900861 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200862}
863
864/**
865 * wq_worker_sleeping - a worker is going to sleep
866 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200867 *
868 * This function is called during schedule() when a busy worker is
869 * going to sleep. Worker on the same cpu can be woken up by
870 * returning pointer to its task.
871 *
872 * CONTEXT:
873 * spin_lock_irq(rq->lock)
874 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700875 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200876 * Worker task on @cpu to wake up, %NULL if none.
877 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100878struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200879{
880 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800881 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200882
Tejun Heo111c2252013-01-17 17:16:24 -0800883 /*
884 * Rescuers, which may not have all the fields set up like normal
885 * workers, also reach here, let's not access anything before
886 * checking NOT_RUNNING.
887 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500888 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200889 return NULL;
890
Tejun Heo111c2252013-01-17 17:16:24 -0800891 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800892
Tejun Heoe22bee72010-06-29 10:07:14 +0200893 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100894 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700895 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200896
897 /*
898 * The counterpart of the following dec_and_test, implied mb,
899 * worklist not empty test sequence is in insert_work().
900 * Please read comment there.
901 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700902 * NOT_RUNNING is clear. This means that we're bound to and
903 * running on the local cpu w/ rq lock held and preemption
904 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800905 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700906 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200907 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800908 if (atomic_dec_and_test(&pool->nr_running) &&
909 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800910 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 return to_wakeup ? to_wakeup->task : NULL;
912}
913
914/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800915 * wq_worker_last_func - retrieve worker's last work function
916 *
917 * Determine the last function a worker executed. This is called from
918 * the scheduler to get a worker's last known identity.
919 *
920 * CONTEXT:
921 * spin_lock_irq(rq->lock)
922 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800923 * This function is called during schedule() when a kworker is going
924 * to sleep. It's used by psi to identify aggregation workers during
925 * dequeuing, to allow periodic aggregation to shut-off when that
926 * worker is the last task in the system or cgroup to go to sleep.
927 *
928 * As this function doesn't involve any workqueue-related locking, it
929 * only returns stable values when called from inside the scheduler's
930 * queuing and dequeuing paths, when @task, which must be a kworker,
931 * is guaranteed to not be processing any works.
932 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800933 * Return:
934 * The last work function %current executed as a worker, NULL if it
935 * hasn't executed any work yet.
936 */
937work_func_t wq_worker_last_func(struct task_struct *task)
938{
939 struct worker *worker = kthread_data(task);
940
941 return worker->last_func;
942}
943
944/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200945 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200946 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200947 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200948 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800949 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200950 *
Tejun Heocb444762010-07-02 10:03:50 +0200951 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800952 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200953 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800954static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200955{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700956 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200957
Tejun Heocb444762010-07-02 10:03:50 +0200958 WARN_ON_ONCE(worker->task != current);
959
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800960 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200961 if ((flags & WORKER_NOT_RUNNING) &&
962 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800963 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200964 }
965
Tejun Heod302f012010-06-29 10:07:13 +0200966 worker->flags |= flags;
967}
968
969/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200970 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200971 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200972 * @flags: flags to clear
973 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200974 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200975 *
Tejun Heocb444762010-07-02 10:03:50 +0200976 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800977 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200978 */
979static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
980{
Tejun Heo63d95a92012-07-12 14:46:37 -0700981 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200982 unsigned int oflags = worker->flags;
983
Tejun Heocb444762010-07-02 10:03:50 +0200984 WARN_ON_ONCE(worker->task != current);
985
Tejun Heod302f012010-06-29 10:07:13 +0200986 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200987
Tejun Heo42c025f2011-01-11 15:58:49 +0100988 /*
989 * If transitioning out of NOT_RUNNING, increment nr_running. Note
990 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
991 * of multiple flags, not a single flag.
992 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200993 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
994 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800995 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200996}
997
998/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200999 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001000 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001001 * @work: work to find worker for
1002 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001003 * Find a worker which is executing @work on @pool by searching
1004 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001005 * to match, its current execution should match the address of @work and
1006 * its work function. This is to avoid unwanted dependency between
1007 * unrelated work executions through a work item being recycled while still
1008 * being executed.
1009 *
1010 * This is a bit tricky. A work item may be freed once its execution
1011 * starts and nothing prevents the freed area from being recycled for
1012 * another work item. If the same work item address ends up being reused
1013 * before the original execution finishes, workqueue will identify the
1014 * recycled work item as currently executing and make it wait until the
1015 * current execution finishes, introducing an unwanted dependency.
1016 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001017 * This function checks the work item address and work function to avoid
1018 * false positives. Note that this isn't complete as one may construct a
1019 * work function which can introduce dependency onto itself through a
1020 * recycled work item. Well, if somebody wants to shoot oneself in the
1021 * foot that badly, there's only so much we can do, and if such deadlock
1022 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001023 *
1024 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001025 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001026 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001027 * Return:
1028 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001029 * otherwise.
1030 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001031static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001032 struct work_struct *work)
1033{
Sasha Levin42f85702012-12-17 10:01:23 -05001034 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001035
Sasha Levinb67bfe02013-02-27 17:06:00 -08001036 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001037 (unsigned long)work)
1038 if (worker->current_work == work &&
1039 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001040 return worker;
1041
1042 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001043}
1044
1045/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001046 * move_linked_works - move linked works to a list
1047 * @work: start of series of works to be scheduled
1048 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301049 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001050 *
1051 * Schedule linked works starting from @work to @head. Work series to
1052 * be scheduled starts at @work and includes any consecutive work with
1053 * WORK_STRUCT_LINKED set in its predecessor.
1054 *
1055 * If @nextp is not NULL, it's updated to point to the next work of
1056 * the last scheduled work. This allows move_linked_works() to be
1057 * nested inside outer list_for_each_entry_safe().
1058 *
1059 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001060 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001061 */
1062static void move_linked_works(struct work_struct *work, struct list_head *head,
1063 struct work_struct **nextp)
1064{
1065 struct work_struct *n;
1066
1067 /*
1068 * Linked worklist will always end before the end of the list,
1069 * use NULL for list head.
1070 */
1071 list_for_each_entry_safe_from(work, n, NULL, entry) {
1072 list_move_tail(&work->entry, head);
1073 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1074 break;
1075 }
1076
1077 /*
1078 * If we're already inside safe list traversal and have moved
1079 * multiple works to the scheduled queue, the next position
1080 * needs to be updated.
1081 */
1082 if (nextp)
1083 *nextp = n;
1084}
1085
Tejun Heo8864b4e2013-03-12 11:30:04 -07001086/**
1087 * get_pwq - get an extra reference on the specified pool_workqueue
1088 * @pwq: pool_workqueue to get
1089 *
1090 * Obtain an extra reference on @pwq. The caller should guarantee that
1091 * @pwq has positive refcnt and be holding the matching pool->lock.
1092 */
1093static void get_pwq(struct pool_workqueue *pwq)
1094{
1095 lockdep_assert_held(&pwq->pool->lock);
1096 WARN_ON_ONCE(pwq->refcnt <= 0);
1097 pwq->refcnt++;
1098}
1099
1100/**
1101 * put_pwq - put a pool_workqueue reference
1102 * @pwq: pool_workqueue to put
1103 *
1104 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1105 * destruction. The caller should be holding the matching pool->lock.
1106 */
1107static void put_pwq(struct pool_workqueue *pwq)
1108{
1109 lockdep_assert_held(&pwq->pool->lock);
1110 if (likely(--pwq->refcnt))
1111 return;
1112 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1113 return;
1114 /*
1115 * @pwq can't be released under pool->lock, bounce to
1116 * pwq_unbound_release_workfn(). This never recurses on the same
1117 * pool->lock as this path is taken only for unbound workqueues and
1118 * the release work item is scheduled on a per-cpu workqueue. To
1119 * avoid lockdep warning, unbound pool->locks are given lockdep
1120 * subclass of 1 in get_unbound_pool().
1121 */
1122 schedule_work(&pwq->unbound_release_work);
1123}
1124
Tejun Heodce90d42013-04-01 11:23:35 -07001125/**
1126 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1127 * @pwq: pool_workqueue to put (can be %NULL)
1128 *
1129 * put_pwq() with locking. This function also allows %NULL @pwq.
1130 */
1131static void put_pwq_unlocked(struct pool_workqueue *pwq)
1132{
1133 if (pwq) {
1134 /*
1135 * As both pwqs and pools are sched-RCU protected, the
1136 * following lock operations are safe.
1137 */
1138 spin_lock_irq(&pwq->pool->lock);
1139 put_pwq(pwq);
1140 spin_unlock_irq(&pwq->pool->lock);
1141 }
1142}
1143
Tejun Heo112202d2013-02-13 19:29:12 -08001144static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001145{
Tejun Heo112202d2013-02-13 19:29:12 -08001146 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001147
1148 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001149 if (list_empty(&pwq->pool->worklist))
1150 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001151 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001152 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001153 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001154}
1155
Tejun Heo112202d2013-02-13 19:29:12 -08001156static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001157{
Tejun Heo112202d2013-02-13 19:29:12 -08001158 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001159 struct work_struct, entry);
1160
Tejun Heo112202d2013-02-13 19:29:12 -08001161 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001162}
1163
Tejun Heobf4ede02012-08-03 10:30:46 -07001164/**
Tejun Heo112202d2013-02-13 19:29:12 -08001165 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1166 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001167 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001168 *
1169 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001170 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001171 *
1172 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001173 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001174 */
Tejun Heo112202d2013-02-13 19:29:12 -08001175static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001176{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001177 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001178 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001179 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001180
Tejun Heo112202d2013-02-13 19:29:12 -08001181 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001182
Tejun Heo112202d2013-02-13 19:29:12 -08001183 pwq->nr_active--;
1184 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001185 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001186 if (pwq->nr_active < pwq->max_active)
1187 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001188 }
1189
1190 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001191 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001192 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001193
1194 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001195 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001196 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001197
Tejun Heo112202d2013-02-13 19:29:12 -08001198 /* this pwq is done, clear flush_color */
1199 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001200
1201 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001202 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001203 * will handle the rest.
1204 */
Tejun Heo112202d2013-02-13 19:29:12 -08001205 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1206 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001207out_put:
1208 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001209}
1210
Tejun Heo36e227d2012-08-03 10:30:46 -07001211/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001212 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001213 * @work: work item to steal
1214 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001215 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001216 *
1217 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001218 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001219 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001220 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001221 * 1 if @work was pending and we successfully stole PENDING
1222 * 0 if @work was idle and we claimed PENDING
1223 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001224 * -ENOENT if someone else is canceling @work, this state may persist
1225 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001226 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001227 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001228 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001229 * interrupted while holding PENDING and @work off queue, irq must be
1230 * disabled on entry. This, combined with delayed_work->timer being
1231 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001232 *
1233 * On successful return, >= 0, irq is disabled and the caller is
1234 * responsible for releasing it using local_irq_restore(*@flags).
1235 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001236 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001237 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001238static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1239 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001240{
Tejun Heod565ed62013-01-24 11:01:33 -08001241 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001242 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001243
Tejun Heobbb68df2012-08-03 10:30:46 -07001244 local_irq_save(*flags);
1245
Tejun Heo36e227d2012-08-03 10:30:46 -07001246 /* try to steal the timer if it exists */
1247 if (is_dwork) {
1248 struct delayed_work *dwork = to_delayed_work(work);
1249
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001250 /*
1251 * dwork->timer is irqsafe. If del_timer() fails, it's
1252 * guaranteed that the timer is not queued anywhere and not
1253 * running on the local CPU.
1254 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001255 if (likely(del_timer(&dwork->timer)))
1256 return 1;
1257 }
1258
1259 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001260 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1261 return 0;
1262
1263 /*
1264 * The queueing is in progress, or it is already queued. Try to
1265 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1266 */
Tejun Heod565ed62013-01-24 11:01:33 -08001267 pool = get_work_pool(work);
1268 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001269 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001270
Tejun Heod565ed62013-01-24 11:01:33 -08001271 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001272 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001273 * work->data is guaranteed to point to pwq only while the work
1274 * item is queued on pwq->wq, and both updating work->data to point
1275 * to pwq on queueing and to pool on dequeueing are done under
1276 * pwq->pool->lock. This in turn guarantees that, if work->data
1277 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001278 * item is currently queued on that pool.
1279 */
Tejun Heo112202d2013-02-13 19:29:12 -08001280 pwq = get_work_pwq(work);
1281 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001282 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001283
Tejun Heo16062832013-02-06 18:04:53 -08001284 /*
1285 * A delayed work item cannot be grabbed directly because
1286 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001287 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001288 * management later on and cause stall. Make sure the work
1289 * item is activated before grabbing.
1290 */
1291 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001292 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001293
Tejun Heo16062832013-02-06 18:04:53 -08001294 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001295 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001296
Tejun Heo112202d2013-02-13 19:29:12 -08001297 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001298 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001299
Tejun Heo16062832013-02-06 18:04:53 -08001300 spin_unlock(&pool->lock);
1301 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:
1305 local_irq_restore(*flags);
1306 if (work_is_canceling(work))
1307 return -ENOENT;
1308 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001309 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001310}
1311
1312/**
Tejun Heo706026c2013-01-24 11:01:34 -08001313 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001314 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001315 * @work: work to insert
1316 * @head: insertion point
1317 * @extra_flags: extra WORK_STRUCT_* flags to set
1318 *
Tejun Heo112202d2013-02-13 19:29:12 -08001319 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001320 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001321 *
1322 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001323 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001324 */
Tejun Heo112202d2013-02-13 19:29:12 -08001325static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1326 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001327{
Tejun Heo112202d2013-02-13 19:29:12 -08001328 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001329
Tejun Heo4690c4a2010-06-29 10:07:10 +02001330 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001331 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001332 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001333 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001334
1335 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001336 * Ensure either wq_worker_sleeping() sees the above
1337 * list_add_tail() or we see zero nr_running to avoid workers lying
1338 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001339 */
1340 smp_mb();
1341
Tejun Heo63d95a92012-07-12 14:46:37 -07001342 if (__need_more_worker(pool))
1343 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001344}
1345
Tejun Heoc8efcc22010-12-20 19:32:04 +01001346/*
1347 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001348 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001349 */
1350static bool is_chained_work(struct workqueue_struct *wq)
1351{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001352 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001353
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001354 worker = current_wq_worker();
1355 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001356 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001357 * I'm @worker, it's safe to dereference it without locking.
1358 */
Tejun Heo112202d2013-02-13 19:29:12 -08001359 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001360}
1361
Mike Galbraithef5571802016-02-09 17:59:38 -05001362/*
1363 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1364 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1365 * avoid perturbing sensitive tasks.
1366 */
1367static int wq_select_unbound_cpu(int cpu)
1368{
Tejun Heof303fccb2016-02-09 17:59:38 -05001369 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001370 int new_cpu;
1371
Tejun Heof303fccb2016-02-09 17:59:38 -05001372 if (likely(!wq_debug_force_rr_cpu)) {
1373 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1374 return cpu;
1375 } else if (!printed_dbg_warning) {
1376 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1377 printed_dbg_warning = true;
1378 }
1379
Mike Galbraithef5571802016-02-09 17:59:38 -05001380 if (cpumask_empty(wq_unbound_cpumask))
1381 return cpu;
1382
1383 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1384 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1385 if (unlikely(new_cpu >= nr_cpu_ids)) {
1386 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1387 if (unlikely(new_cpu >= nr_cpu_ids))
1388 return cpu;
1389 }
1390 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1391
1392 return new_cpu;
1393}
1394
Tejun Heod84ff052013-03-12 11:29:59 -07001395static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 struct work_struct *work)
1397{
Tejun Heo112202d2013-02-13 19:29:12 -08001398 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001399 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001400 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001401 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001402 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001403
1404 /*
1405 * While a work item is PENDING && off queue, a task trying to
1406 * steal the PENDING will busy-loop waiting for it to either get
1407 * queued or lose PENDING. Grabbing PENDING and queueing should
1408 * happen with IRQ disabled.
1409 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001410 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001412 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001413
Li Bin9ef28a72013-09-09 13:13:58 +08001414 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001415 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001416 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001417 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001418retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001419 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001420 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001421
Tejun Heoc9178082013-03-12 11:30:04 -07001422 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001423 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001424 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001425 else
1426 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001427
Tejun Heoc9178082013-03-12 11:30:04 -07001428 /*
1429 * If @work was previously on a different pool, it might still be
1430 * running there, in which case the work needs to be queued on that
1431 * pool to guarantee non-reentrancy.
1432 */
1433 last_pool = get_work_pool(work);
1434 if (last_pool && last_pool != pwq->pool) {
1435 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001436
Tejun Heoc9178082013-03-12 11:30:04 -07001437 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001438
Tejun Heoc9178082013-03-12 11:30:04 -07001439 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001440
Tejun Heoc9178082013-03-12 11:30:04 -07001441 if (worker && worker->current_pwq->wq == wq) {
1442 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001443 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001444 /* meh... not running there, queue here */
1445 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001446 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001447 }
Tejun Heof3421792010-07-02 10:03:51 +02001448 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001449 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001450 }
1451
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001452 /*
1453 * pwq is determined and locked. For unbound pools, we could have
1454 * raced with pwq release and it could already be dead. If its
1455 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001456 * without another pwq replacing it in the numa_pwq_tbl or while
1457 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001458 * make forward-progress.
1459 */
1460 if (unlikely(!pwq->refcnt)) {
1461 if (wq->flags & WQ_UNBOUND) {
1462 spin_unlock(&pwq->pool->lock);
1463 cpu_relax();
1464 goto retry;
1465 }
1466 /* oops */
1467 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1468 wq->name, cpu);
1469 }
1470
Tejun Heo112202d2013-02-13 19:29:12 -08001471 /* pwq determined, queue */
1472 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001473
Dan Carpenterf5b25522012-04-13 22:06:58 +03001474 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001475 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001476 return;
1477 }
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
Tejun Heo112202d2013-02-13 19:29:12 -08001495 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496}
1497
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001498/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001499 * queue_work_on - queue work on specific cpu
1500 * @cpu: CPU number to execute work on
1501 * @wq: workqueue to use
1502 * @work: work to queue
1503 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001504 * We queue the work to a specific CPU, the caller must ensure it
1505 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001506 *
1507 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001508 */
Tejun Heod4283e92012-08-03 10:30:44 -07001509bool queue_work_on(int cpu, struct workqueue_struct *wq,
1510 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001511{
Tejun Heod4283e92012-08-03 10:30:44 -07001512 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001513 unsigned long flags;
1514
1515 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001516
Tejun Heo22df02b2010-06-29 10:07:10 +02001517 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001518 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001519 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001520 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001521
1522 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001523 return ret;
1524}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001525EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001526
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001527/**
1528 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1529 * @node: NUMA node ID that we want to select a CPU from
1530 *
1531 * This function will attempt to find a "random" cpu available on a given
1532 * node. If there are no CPUs available on the given node it will return
1533 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1534 * available CPU if we need to schedule this work.
1535 */
1536static int workqueue_select_cpu_near(int node)
1537{
1538 int cpu;
1539
1540 /* No point in doing this if NUMA isn't enabled for workqueues */
1541 if (!wq_numa_enabled)
1542 return WORK_CPU_UNBOUND;
1543
1544 /* Delay binding to CPU if node is not valid or online */
1545 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1546 return WORK_CPU_UNBOUND;
1547
1548 /* Use local node/cpu if we are already there */
1549 cpu = raw_smp_processor_id();
1550 if (node == cpu_to_node(cpu))
1551 return cpu;
1552
1553 /* Use "random" otherwise know as "first" online CPU of node */
1554 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1555
1556 /* If CPU is valid return that, otherwise just defer */
1557 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1558}
1559
1560/**
1561 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1562 * @node: NUMA node that we are targeting the work for
1563 * @wq: workqueue to use
1564 * @work: work to queue
1565 *
1566 * We queue the work to a "random" CPU within a given NUMA node. The basic
1567 * idea here is to provide a way to somehow associate work with a given
1568 * NUMA node.
1569 *
1570 * This function will only make a best effort attempt at getting this onto
1571 * the right NUMA node. If no node is requested or the requested node is
1572 * offline then we just fall back to standard queue_work behavior.
1573 *
1574 * Currently the "random" CPU ends up being the first available CPU in the
1575 * intersection of cpu_online_mask and the cpumask of the node, unless we
1576 * are running on the node. In that case we just use the current CPU.
1577 *
1578 * Return: %false if @work was already on a queue, %true otherwise.
1579 */
1580bool queue_work_node(int node, struct workqueue_struct *wq,
1581 struct work_struct *work)
1582{
1583 unsigned long flags;
1584 bool ret = false;
1585
1586 /*
1587 * This current implementation is specific to unbound workqueues.
1588 * Specifically we only return the first available CPU for a given
1589 * node instead of cycling through individual CPUs within the node.
1590 *
1591 * If this is used with a per-cpu workqueue then the logic in
1592 * workqueue_select_cpu_near would need to be updated to allow for
1593 * some round robin type logic.
1594 */
1595 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1596
1597 local_irq_save(flags);
1598
1599 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1600 int cpu = workqueue_select_cpu_near(node);
1601
1602 __queue_work(cpu, wq, work);
1603 ret = true;
1604 }
1605
1606 local_irq_restore(flags);
1607 return ret;
1608}
1609EXPORT_SYMBOL_GPL(queue_work_node);
1610
Kees Cook8c20feb2017-10-04 16:27:07 -07001611void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612{
Kees Cook8c20feb2017-10-04 16:27:07 -07001613 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001615 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001616 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001618EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001620static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1621 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001623 struct timer_list *timer = &dwork->timer;
1624 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Tejun Heo637fdba2017-03-06 15:33:42 -05001626 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001627 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001628 WARN_ON_ONCE(timer_pending(timer));
1629 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001630
Tejun Heo8852aac2012-12-01 16:23:42 -08001631 /*
1632 * If @delay is 0, queue @dwork->work immediately. This is for
1633 * both optimization and correctness. The earliest @timer can
1634 * expire is on the closest next tick and delayed_work users depend
1635 * on that there's no such delay when @delay is 0.
1636 */
1637 if (!delay) {
1638 __queue_work(cpu, wq, &dwork->work);
1639 return;
1640 }
1641
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001642 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001643 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001644 timer->expires = jiffies + delay;
1645
Tejun Heo041bd122016-02-09 16:11:26 -05001646 if (unlikely(cpu != WORK_CPU_UNBOUND))
1647 add_timer_on(timer, cpu);
1648 else
1649 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650}
1651
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001652/**
1653 * queue_delayed_work_on - queue work on specific CPU after delay
1654 * @cpu: CPU number to execute work on
1655 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001656 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001657 * @delay: number of jiffies to wait before queueing
1658 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001659 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001660 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1661 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001662 */
Tejun Heod4283e92012-08-03 10:30:44 -07001663bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1664 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001665{
David Howells52bad642006-11-22 14:54:01 +00001666 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001667 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001668 unsigned long flags;
1669
1670 /* read the comment in __queue_work() */
1671 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001672
Tejun Heo22df02b2010-06-29 10:07:10 +02001673 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001674 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001675 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001676 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001677
1678 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001679 return ret;
1680}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001681EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682
Tejun Heoc8e55f32010-06-29 10:07:12 +02001683/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001684 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1685 * @cpu: CPU number to execute work on
1686 * @wq: workqueue to use
1687 * @dwork: work to queue
1688 * @delay: number of jiffies to wait before queueing
1689 *
1690 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1691 * modify @dwork's timer so that it expires after @delay. If @delay is
1692 * zero, @work is guaranteed to be scheduled immediately regardless of its
1693 * current state.
1694 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001695 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001696 * pending and its timer was modified.
1697 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001698 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001699 * See try_to_grab_pending() for details.
1700 */
1701bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1702 struct delayed_work *dwork, unsigned long delay)
1703{
1704 unsigned long flags;
1705 int ret;
1706
1707 do {
1708 ret = try_to_grab_pending(&dwork->work, true, &flags);
1709 } while (unlikely(ret == -EAGAIN));
1710
1711 if (likely(ret >= 0)) {
1712 __queue_delayed_work(cpu, wq, dwork, delay);
1713 local_irq_restore(flags);
1714 }
1715
1716 /* -ENOENT from try_to_grab_pending() becomes %true */
1717 return ret;
1718}
1719EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1720
Tejun Heo05f0fe62018-03-14 12:45:13 -07001721static void rcu_work_rcufn(struct rcu_head *rcu)
1722{
1723 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1724
1725 /* read the comment in __queue_work() */
1726 local_irq_disable();
1727 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1728 local_irq_enable();
1729}
1730
1731/**
1732 * queue_rcu_work - queue work after a RCU grace period
1733 * @wq: workqueue to use
1734 * @rwork: work to queue
1735 *
1736 * Return: %false if @rwork was already pending, %true otherwise. Note
1737 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001738 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001739 * execution may happen before a full RCU grace period has passed.
1740 */
1741bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1742{
1743 struct work_struct *work = &rwork->work;
1744
1745 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1746 rwork->wq = wq;
1747 call_rcu(&rwork->rcu, rcu_work_rcufn);
1748 return true;
1749 }
1750
1751 return false;
1752}
1753EXPORT_SYMBOL(queue_rcu_work);
1754
Tejun Heo8376fe22012-08-03 10:30:47 -07001755/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001756 * worker_enter_idle - enter idle state
1757 * @worker: worker which is entering idle state
1758 *
1759 * @worker is entering idle state. Update stats and idle timer if
1760 * necessary.
1761 *
1762 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001763 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001764 */
1765static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001767 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
Tejun Heo6183c002013-03-12 11:29:57 -07001769 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1770 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1771 (worker->hentry.next || worker->hentry.pprev)))
1772 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Lai Jiangshan051e1852014-07-22 13:03:02 +08001774 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001775 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001776 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001777 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001778
Tejun Heoc8e55f32010-06-29 10:07:12 +02001779 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001780 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001781
Tejun Heo628c78e2012-07-17 12:39:27 -07001782 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1783 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001784
Tejun Heo544ecf32012-05-14 15:04:50 -07001785 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001786 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001787 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001788 * nr_running, the warning may trigger spuriously. Check iff
1789 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001790 */
Tejun Heo24647572013-01-24 11:01:33 -08001791 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001792 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001793 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794}
1795
Tejun Heoc8e55f32010-06-29 10:07:12 +02001796/**
1797 * worker_leave_idle - leave idle state
1798 * @worker: worker which is leaving idle state
1799 *
1800 * @worker is leaving idle state. Update stats.
1801 *
1802 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001803 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001804 */
1805static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001807 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Tejun Heo6183c002013-03-12 11:29:57 -07001809 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1810 return;
Tejun Heod302f012010-06-29 10:07:13 +02001811 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001812 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001813 list_del_init(&worker->entry);
1814}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001816static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001817{
1818 struct worker *worker;
1819
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001820 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001821 if (worker) {
1822 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001823 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001824 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001825 /* on creation a worker is in !idle && prep state */
1826 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001827 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001828 return worker;
1829}
1830
1831/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001832 * worker_attach_to_pool() - attach a worker to a pool
1833 * @worker: worker to be attached
1834 * @pool: the target pool
1835 *
1836 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1837 * cpu-binding of @worker are kept coordinated with the pool across
1838 * cpu-[un]hotplugs.
1839 */
1840static void worker_attach_to_pool(struct worker *worker,
1841 struct worker_pool *pool)
1842{
Tejun Heo1258fae2018-05-18 08:47:13 -07001843 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001844
1845 /*
1846 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1847 * online CPUs. It'll be re-applied when any of the CPUs come up.
1848 */
1849 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1850
1851 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001852 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1853 * stable across this function. See the comments above the flag
1854 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001855 */
1856 if (pool->flags & POOL_DISASSOCIATED)
1857 worker->flags |= WORKER_UNBOUND;
1858
1859 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001860 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001861
Tejun Heo1258fae2018-05-18 08:47:13 -07001862 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001863}
1864
1865/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001866 * worker_detach_from_pool() - detach a worker from its pool
1867 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001868 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001869 * Undo the attaching which had been done in worker_attach_to_pool(). The
1870 * caller worker shouldn't access to the pool after detached except it has
1871 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001872 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001873static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001874{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001875 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001876 struct completion *detach_completion = NULL;
1877
Tejun Heo1258fae2018-05-18 08:47:13 -07001878 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001879
Lai Jiangshanda028462014-05-20 17:46:31 +08001880 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001881 worker->pool = NULL;
1882
Lai Jiangshanda028462014-05-20 17:46:31 +08001883 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001884 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001885 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001886
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001887 /* clear leftover flags without pool->lock after it is detached */
1888 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1889
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001890 if (detach_completion)
1891 complete(detach_completion);
1892}
1893
1894/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001895 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001896 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001897 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001898 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001899 *
1900 * CONTEXT:
1901 * Might sleep. Does GFP_KERNEL allocations.
1902 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001903 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001904 * Pointer to the newly created worker.
1905 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001906static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001907{
Tejun Heoc34056a2010-06-29 10:07:11 +02001908 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001909 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001910 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001911
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001912 /* ID is needed to determine kthread name */
1913 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001914 if (id < 0)
1915 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001916
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001917 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001918 if (!worker)
1919 goto fail;
1920
Tejun Heoc34056a2010-06-29 10:07:11 +02001921 worker->id = id;
1922
Tejun Heo29c91e92013-03-12 11:30:03 -07001923 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001924 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1925 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001926 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001927 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1928
Tejun Heof3f90ad2013-04-01 11:23:34 -07001929 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001930 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001931 if (IS_ERR(worker->task))
1932 goto fail;
1933
Oleg Nesterov91151222013-11-14 12:56:18 +01001934 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001935 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001936
Lai Jiangshanda028462014-05-20 17:46:31 +08001937 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001938 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001939
Lai Jiangshan051e1852014-07-22 13:03:02 +08001940 /* start the newly created worker */
1941 spin_lock_irq(&pool->lock);
1942 worker->pool->nr_workers++;
1943 worker_enter_idle(worker);
1944 wake_up_process(worker->task);
1945 spin_unlock_irq(&pool->lock);
1946
Tejun Heoc34056a2010-06-29 10:07:11 +02001947 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001948
Tejun Heoc34056a2010-06-29 10:07:11 +02001949fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001950 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001951 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001952 kfree(worker);
1953 return NULL;
1954}
1955
1956/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001957 * destroy_worker - destroy a workqueue worker
1958 * @worker: worker to be destroyed
1959 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001960 * Destroy @worker and adjust @pool stats accordingly. The worker should
1961 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001962 *
1963 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001964 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001965 */
1966static void destroy_worker(struct worker *worker)
1967{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001968 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001969
Tejun Heocd549682013-03-13 19:47:39 -07001970 lockdep_assert_held(&pool->lock);
1971
Tejun Heoc34056a2010-06-29 10:07:11 +02001972 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001973 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001974 WARN_ON(!list_empty(&worker->scheduled)) ||
1975 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001976 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001977
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001978 pool->nr_workers--;
1979 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001980
Tejun Heoc8e55f32010-06-29 10:07:12 +02001981 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001982 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001983 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001984}
1985
Kees Cook32a6c722017-10-16 15:58:25 -07001986static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001987{
Kees Cook32a6c722017-10-16 15:58:25 -07001988 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001989
Tejun Heod565ed62013-01-24 11:01:33 -08001990 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001991
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001992 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 struct worker *worker;
1994 unsigned long expires;
1995
1996 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001997 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1999
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002000 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002001 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002002 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002004
2005 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002006 }
2007
Tejun Heod565ed62013-01-24 11:01:33 -08002008 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002009}
2010
Tejun Heo493a1722013-03-12 11:29:59 -07002011static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002012{
Tejun Heo112202d2013-02-13 19:29:12 -08002013 struct pool_workqueue *pwq = get_work_pwq(work);
2014 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002015
Tejun Heo2e109a22013-03-13 19:47:40 -07002016 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002017
Tejun Heo493008a2013-03-12 11:30:03 -07002018 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002019 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002020
2021 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002022 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002023 /*
2024 * If @pwq is for an unbound wq, its base ref may be put at
2025 * any time due to an attribute change. Pin @pwq until the
2026 * rescuer is done with it.
2027 */
2028 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002029 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002030 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002031 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002032}
2033
Kees Cook32a6c722017-10-16 15:58:25 -07002034static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002035{
Kees Cook32a6c722017-10-16 15:58:25 -07002036 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002037 struct work_struct *work;
2038
Tejun Heob2d82902014-12-08 12:39:16 -05002039 spin_lock_irq(&pool->lock);
2040 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002041
Tejun Heo63d95a92012-07-12 14:46:37 -07002042 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002043 /*
2044 * We've been trying to create a new worker but
2045 * haven't been successful. We might be hitting an
2046 * allocation deadlock. Send distress signals to
2047 * rescuers.
2048 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002049 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002050 send_mayday(work);
2051 }
2052
Tejun Heob2d82902014-12-08 12:39:16 -05002053 spin_unlock(&wq_mayday_lock);
2054 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002055
Tejun Heo63d95a92012-07-12 14:46:37 -07002056 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002057}
2058
2059/**
2060 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002061 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002062 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002063 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002064 * have at least one idle worker on return from this function. If
2065 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002066 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002067 * possible allocation deadlock.
2068 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002069 * On return, need_to_create_worker() is guaranteed to be %false and
2070 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002071 *
2072 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08002073 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002074 * multiple times. Does GFP_KERNEL allocations. Called only from
2075 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002076 */
Tejun Heo29187a92015-01-16 14:21:16 -05002077static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002078__releases(&pool->lock)
2079__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002080{
Tejun Heoe22bee72010-06-29 10:07:14 +02002081restart:
Tejun Heod565ed62013-01-24 11:01:33 -08002082 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002083
Tejun Heoe22bee72010-06-29 10:07:14 +02002084 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002085 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002086
2087 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002088 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002089 break;
2090
Lai Jiangshane212f362014-06-03 15:32:17 +08002091 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002092
Tejun Heo63d95a92012-07-12 14:46:37 -07002093 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002094 break;
2095 }
2096
Tejun Heo63d95a92012-07-12 14:46:37 -07002097 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08002098 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002099 /*
2100 * This is necessary even after a new worker was just successfully
2101 * created as @pool->lock was dropped and the new worker might have
2102 * already become busy.
2103 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002104 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002105 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002106}
2107
2108/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002109 * manage_workers - manage worker pool
2110 * @worker: self
2111 *
Tejun Heo706026c2013-01-24 11:01:34 -08002112 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002113 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002114 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002115 *
2116 * The caller can safely start processing works on false return. On
2117 * true return, it's guaranteed that need_to_create_worker() is false
2118 * and may_start_working() is true.
2119 *
2120 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002121 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002122 * multiple times. Does GFP_KERNEL allocations.
2123 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002124 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002125 * %false if the pool doesn't need management and the caller can safely
2126 * start processing works, %true if management function was performed and
2127 * the conditions that the caller verified before calling the function may
2128 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002129 */
2130static bool manage_workers(struct worker *worker)
2131{
Tejun Heo63d95a92012-07-12 14:46:37 -07002132 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002133
Tejun Heo692b4822017-10-09 08:04:13 -07002134 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002135 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002136
2137 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002138 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002139
Tejun Heo29187a92015-01-16 14:21:16 -05002140 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002141
Tejun Heo2607d7a2015-03-09 09:22:28 -04002142 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002143 pool->flags &= ~POOL_MANAGER_ACTIVE;
2144 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002145 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002146}
2147
Tejun Heoa62428c2010-06-29 10:07:10 +02002148/**
2149 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002150 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002151 * @work: work to process
2152 *
2153 * Process @work. This function contains all the logics necessary to
2154 * process a single work including synchronization against and
2155 * interaction with other workers on the same cpu, queueing and
2156 * flushing. As long as context requirement is met, any worker can
2157 * call this function to process a work.
2158 *
2159 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002160 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002161 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002162static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002163__releases(&pool->lock)
2164__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002165{
Tejun Heo112202d2013-02-13 19:29:12 -08002166 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002167 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002168 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002169 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002170 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002171#ifdef CONFIG_LOCKDEP
2172 /*
2173 * It is permissible to free the struct work_struct from
2174 * inside the function that is called from it, this we need to
2175 * take into account for lockdep too. To avoid bogus "held
2176 * lock freed" warnings as well as problems when looking into
2177 * work->lockdep_map, make a copy and use that here.
2178 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002179 struct lockdep_map lockdep_map;
2180
2181 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002182#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002183 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002184 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002185 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002186
Tejun Heo7e116292010-06-29 10:07:13 +02002187 /*
2188 * A single work shouldn't be executed concurrently by
2189 * multiple workers on a single cpu. Check whether anyone is
2190 * already processing the work. If so, defer the work to the
2191 * currently executing one.
2192 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002193 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002194 if (unlikely(collision)) {
2195 move_linked_works(work, &collision->scheduled, NULL);
2196 return;
2197 }
2198
Tejun Heo8930cab2012-08-03 10:30:45 -07002199 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002200 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002201 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002202 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002203 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002204 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002205 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002206
Tejun Heo8bf89592018-05-18 08:47:13 -07002207 /*
2208 * Record wq name for cmdline and debug reporting, may get
2209 * overridden through set_worker_desc().
2210 */
2211 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2212
Tejun Heoa62428c2010-06-29 10:07:10 +02002213 list_del_init(&work->entry);
2214
Tejun Heo649027d2010-06-29 10:07:14 +02002215 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002216 * CPU intensive works don't participate in concurrency management.
2217 * They're the scheduler's responsibility. This takes @worker out
2218 * of concurrency management and the next code block will chain
2219 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002220 */
2221 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002222 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002223
Tejun Heo974271c2012-07-12 14:46:37 -07002224 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002225 * Wake up another worker if necessary. The condition is always
2226 * false for normal per-cpu workers since nr_running would always
2227 * be >= 1 at this point. This is used to chain execution of the
2228 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002229 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002230 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002231 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002232 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002233
Tejun Heo8930cab2012-08-03 10:30:45 -07002234 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002235 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002236 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002237 * PENDING and queued state changes happen together while IRQ is
2238 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002239 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002240 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002241
Tejun Heod565ed62013-01-24 11:01:33 -08002242 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002243
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002244 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002245 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002246 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002247 * Strictly speaking we should mark the invariant state without holding
2248 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002249 *
2250 * However, that would result in:
2251 *
2252 * A(W1)
2253 * WFC(C)
2254 * A(W1)
2255 * C(C)
2256 *
2257 * Which would create W1->C->W1 dependencies, even though there is no
2258 * actual deadlock possible. There are two solutions, using a
2259 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002260 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002261 * these locks.
2262 *
2263 * AFAICT there is no possible deadlock scenario between the
2264 * flush_work() and complete() primitives (except for single-threaded
2265 * workqueues), so hiding them isn't a problem.
2266 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002267 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002268 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002269 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002270 /*
2271 * While we must be careful to not use "work" after this, the trace
2272 * point will only record its address.
2273 */
2274 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002275 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002276 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002277
2278 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002279 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2280 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002281 current->comm, preempt_count(), task_pid_nr(current),
2282 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002283 debug_show_held_locks(current);
2284 dump_stack();
2285 }
2286
Tejun Heob22ce272013-08-28 17:33:37 -04002287 /*
2288 * The following prevents a kworker from hogging CPU on !PREEMPT
2289 * kernels, where a requeueing work item waiting for something to
2290 * happen could deadlock with stop_machine as such work item could
2291 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002292 * stop_machine. At the same time, report a quiescent RCU state so
2293 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002294 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002295 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002296
Tejun Heod565ed62013-01-24 11:01:33 -08002297 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002298
Tejun Heofb0e7be2010-06-29 10:07:15 +02002299 /* clear cpu intensive status */
2300 if (unlikely(cpu_intensive))
2301 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2302
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002303 /* tag the worker for identification in schedule() */
2304 worker->last_func = worker->current_func;
2305
Tejun Heoa62428c2010-06-29 10:07:10 +02002306 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002307 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002308 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002309 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002310 worker->current_pwq = NULL;
2311 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002312}
2313
Tejun Heoaffee4b2010-06-29 10:07:12 +02002314/**
2315 * process_scheduled_works - process scheduled works
2316 * @worker: self
2317 *
2318 * Process all scheduled works. Please note that the scheduled list
2319 * may change while processing a work, so this function repeatedly
2320 * fetches a work from the top and executes it.
2321 *
2322 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002323 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002324 * multiple times.
2325 */
2326static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002328 while (!list_empty(&worker->scheduled)) {
2329 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002331 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333}
2334
Tejun Heo197f6ac2018-05-21 08:04:35 -07002335static void set_pf_worker(bool val)
2336{
2337 mutex_lock(&wq_pool_attach_mutex);
2338 if (val)
2339 current->flags |= PF_WQ_WORKER;
2340 else
2341 current->flags &= ~PF_WQ_WORKER;
2342 mutex_unlock(&wq_pool_attach_mutex);
2343}
2344
Tejun Heo4690c4a2010-06-29 10:07:10 +02002345/**
2346 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002347 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002348 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002349 * The worker thread function. All workers belong to a worker_pool -
2350 * either a per-cpu one or dynamic unbound one. These workers process all
2351 * work items regardless of their specific target workqueue. The only
2352 * exception is work items which belong to workqueues with a rescuer which
2353 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002354 *
2355 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002356 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002357static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358{
Tejun Heoc34056a2010-06-29 10:07:11 +02002359 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002360 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361
Tejun Heoe22bee72010-06-29 10:07:14 +02002362 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002363 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002364woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002365 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002366
Tejun Heoa9ab7752013-03-19 13:45:21 -07002367 /* am I supposed to die? */
2368 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002369 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002370 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002371 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002372
2373 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002374 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002375 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002376 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002377 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002379
Tejun Heoc8e55f32010-06-29 10:07:12 +02002380 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002381recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002382 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002383 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002384 goto sleep;
2385
2386 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002387 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002388 goto recheck;
2389
Tejun Heoc8e55f32010-06-29 10:07:12 +02002390 /*
2391 * ->scheduled list can only be filled while a worker is
2392 * preparing to process a work or actually processing it.
2393 * Make sure nobody diddled with it while I was sleeping.
2394 */
Tejun Heo6183c002013-03-12 11:29:57 -07002395 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002396
Tejun Heoe22bee72010-06-29 10:07:14 +02002397 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002398 * Finish PREP stage. We're guaranteed to have at least one idle
2399 * worker or that someone else has already assumed the manager
2400 * role. This is where @worker starts participating in concurrency
2401 * management if applicable and concurrency management is restored
2402 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002403 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002404 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002405
2406 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002407 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002408 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002409 struct work_struct, entry);
2410
Tejun Heo82607adc2015-12-08 11:28:04 -05002411 pool->watchdog_ts = jiffies;
2412
Tejun Heoc8e55f32010-06-29 10:07:12 +02002413 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2414 /* optimization path, not strictly necessary */
2415 process_one_work(worker, work);
2416 if (unlikely(!list_empty(&worker->scheduled)))
2417 process_scheduled_works(worker);
2418 } else {
2419 move_linked_works(work, &worker->scheduled, NULL);
2420 process_scheduled_works(worker);
2421 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002422 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002423
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002424 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002425sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002426 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002427 * pool->lock is held and there's no work to process and no need to
2428 * manage, sleep. Workers are woken up only while holding
2429 * pool->lock or from local cpu, so setting the current state
2430 * before releasing pool->lock is enough to prevent losing any
2431 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002432 */
2433 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002434 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002435 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002436 schedule();
2437 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438}
2439
Tejun Heoe22bee72010-06-29 10:07:14 +02002440/**
2441 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002442 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002443 *
2444 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002445 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002446 *
Tejun Heo706026c2013-01-24 11:01:34 -08002447 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002448 * worker which uses GFP_KERNEL allocation which has slight chance of
2449 * developing into deadlock if some works currently on the same queue
2450 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2451 * the problem rescuer solves.
2452 *
Tejun Heo706026c2013-01-24 11:01:34 -08002453 * When such condition is possible, the pool summons rescuers of all
2454 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002455 * those works so that forward progress can be guaranteed.
2456 *
2457 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002458 *
2459 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002460 */
Tejun Heo111c2252013-01-17 17:16:24 -08002461static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002462{
Tejun Heo111c2252013-01-17 17:16:24 -08002463 struct worker *rescuer = __rescuer;
2464 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002465 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002466 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002467
2468 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002469
2470 /*
2471 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2472 * doesn't participate in concurrency management.
2473 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002474 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002475repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002476 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002477
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002478 /*
2479 * By the time the rescuer is requested to stop, the workqueue
2480 * shouldn't have any work pending, but @wq->maydays may still have
2481 * pwq(s) queued. This can happen by non-rescuer workers consuming
2482 * all the work items before the rescuer got to them. Go through
2483 * @wq->maydays processing before acting on should_stop so that the
2484 * list is always empty on exit.
2485 */
2486 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002487
Tejun Heo493a1722013-03-12 11:29:59 -07002488 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002489 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002490
2491 while (!list_empty(&wq->maydays)) {
2492 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2493 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002494 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002495 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002496 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002497
2498 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002499 list_del_init(&pwq->mayday_node);
2500
Tejun Heo2e109a22013-03-13 19:47:40 -07002501 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002502
Lai Jiangshan51697d392014-05-20 17:46:36 +08002503 worker_attach_to_pool(rescuer, pool);
2504
2505 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002506
2507 /*
2508 * Slurp in all works issued via this workqueue and
2509 * process'em.
2510 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002511 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002512 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2513 if (get_work_pwq(work) == pwq) {
2514 if (first)
2515 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002516 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002517 }
2518 first = false;
2519 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002520
NeilBrown008847f2014-12-08 12:39:16 -05002521 if (!list_empty(scheduled)) {
2522 process_scheduled_works(rescuer);
2523
2524 /*
2525 * The above execution of rescued work items could
2526 * have created more to rescue through
2527 * pwq_activate_first_delayed() or chained
2528 * queueing. Let's put @pwq back on mayday list so
2529 * that such back-to-back work items, which may be
2530 * being used to relieve memory pressure, don't
2531 * incur MAYDAY_INTERVAL delay inbetween.
2532 */
2533 if (need_to_create_worker(pool)) {
2534 spin_lock(&wq_mayday_lock);
2535 get_pwq(pwq);
2536 list_move_tail(&pwq->mayday_node, &wq->maydays);
2537 spin_unlock(&wq_mayday_lock);
2538 }
2539 }
Tejun Heo75769582011-02-14 14:04:46 +01002540
2541 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002542 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002543 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002544 */
2545 put_pwq(pwq);
2546
2547 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002548 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002549 * regular worker; otherwise, we end up with 0 concurrency
2550 * and stalling the execution.
2551 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002552 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002553 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002554
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002555 spin_unlock_irq(&pool->lock);
2556
Tejun Heoa2d812a2018-05-18 08:47:13 -07002557 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002558
2559 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002560 }
2561
Tejun Heo2e109a22013-03-13 19:47:40 -07002562 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002563
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002564 if (should_stop) {
2565 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002566 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002567 return 0;
2568 }
2569
Tejun Heo111c2252013-01-17 17:16:24 -08002570 /* rescuers should never participate in concurrency management */
2571 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002572 schedule();
2573 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574}
2575
Tejun Heofca839c2015-12-07 10:58:57 -05002576/**
2577 * check_flush_dependency - check for flush dependency sanity
2578 * @target_wq: workqueue being flushed
2579 * @target_work: work item being flushed (NULL for workqueue flushes)
2580 *
2581 * %current is trying to flush the whole @target_wq or @target_work on it.
2582 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2583 * reclaiming memory or running on a workqueue which doesn't have
2584 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2585 * a deadlock.
2586 */
2587static void check_flush_dependency(struct workqueue_struct *target_wq,
2588 struct work_struct *target_work)
2589{
2590 work_func_t target_func = target_work ? target_work->func : NULL;
2591 struct worker *worker;
2592
2593 if (target_wq->flags & WQ_MEM_RECLAIM)
2594 return;
2595
2596 worker = current_wq_worker();
2597
2598 WARN_ONCE(current->flags & PF_MEMALLOC,
2599 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2600 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002601 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2602 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002603 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2604 worker->current_pwq->wq->name, worker->current_func,
2605 target_wq->name, target_func);
2606}
2607
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002608struct wq_barrier {
2609 struct work_struct work;
2610 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002611 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002612};
2613
2614static void wq_barrier_func(struct work_struct *work)
2615{
2616 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2617 complete(&barr->done);
2618}
2619
Tejun Heo4690c4a2010-06-29 10:07:10 +02002620/**
2621 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002622 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002623 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002624 * @target: target work to attach @barr to
2625 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002626 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002627 * @barr is linked to @target such that @barr is completed only after
2628 * @target finishes execution. Please note that the ordering
2629 * guarantee is observed only with respect to @target and on the local
2630 * cpu.
2631 *
2632 * Currently, a queued barrier can't be canceled. This is because
2633 * try_to_grab_pending() can't determine whether the work to be
2634 * grabbed is at the head of the queue and thus can't clear LINKED
2635 * flag of the previous work while there must be a valid next work
2636 * after a work with LINKED flag set.
2637 *
2638 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002639 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002640 *
2641 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002642 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002643 */
Tejun Heo112202d2013-02-13 19:29:12 -08002644static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002645 struct wq_barrier *barr,
2646 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002647{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002648 struct list_head *head;
2649 unsigned int linked = 0;
2650
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002651 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002652 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002653 * as we know for sure that this will not trigger any of the
2654 * checks and call back into the fixup functions where we
2655 * might deadlock.
2656 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002657 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002658 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002659
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002660 init_completion_map(&barr->done, &target->lockdep_map);
2661
Tejun Heo2607d7a2015-03-09 09:22:28 -04002662 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002663
Tejun Heoaffee4b2010-06-29 10:07:12 +02002664 /*
2665 * If @target is currently being executed, schedule the
2666 * barrier to the worker; otherwise, put it after @target.
2667 */
2668 if (worker)
2669 head = worker->scheduled.next;
2670 else {
2671 unsigned long *bits = work_data_bits(target);
2672
2673 head = target->entry.next;
2674 /* there can already be other linked works, inherit and set */
2675 linked = *bits & WORK_STRUCT_LINKED;
2676 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2677 }
2678
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002679 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002680 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002681 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002682}
2683
Tejun Heo73f53c42010-06-29 10:07:11 +02002684/**
Tejun Heo112202d2013-02-13 19:29:12 -08002685 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002686 * @wq: workqueue being flushed
2687 * @flush_color: new flush color, < 0 for no-op
2688 * @work_color: new work color, < 0 for no-op
2689 *
Tejun Heo112202d2013-02-13 19:29:12 -08002690 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002691 *
Tejun Heo112202d2013-02-13 19:29:12 -08002692 * If @flush_color is non-negative, flush_color on all pwqs should be
2693 * -1. If no pwq has in-flight commands at the specified color, all
2694 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2695 * has in flight commands, its pwq->flush_color is set to
2696 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002697 * wakeup logic is armed and %true is returned.
2698 *
2699 * The caller should have initialized @wq->first_flusher prior to
2700 * calling this function with non-negative @flush_color. If
2701 * @flush_color is negative, no flush color update is done and %false
2702 * is returned.
2703 *
Tejun Heo112202d2013-02-13 19:29:12 -08002704 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002705 * work_color which is previous to @work_color and all will be
2706 * advanced to @work_color.
2707 *
2708 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002709 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002710 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002711 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002712 * %true if @flush_color >= 0 and there's something to flush. %false
2713 * otherwise.
2714 */
Tejun Heo112202d2013-02-13 19:29:12 -08002715static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002716 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717{
Tejun Heo73f53c42010-06-29 10:07:11 +02002718 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002719 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002720
Tejun Heo73f53c42010-06-29 10:07:11 +02002721 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002722 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002723 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002724 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002725
Tejun Heo49e3cf42013-03-12 11:29:58 -07002726 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002727 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002728
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002729 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002730
2731 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002732 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002733
Tejun Heo112202d2013-02-13 19:29:12 -08002734 if (pwq->nr_in_flight[flush_color]) {
2735 pwq->flush_color = flush_color;
2736 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002737 wait = true;
2738 }
2739 }
2740
2741 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002742 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002743 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002744 }
2745
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002746 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002747 }
2748
Tejun Heo112202d2013-02-13 19:29:12 -08002749 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002750 complete(&wq->first_flusher->done);
2751
2752 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753}
2754
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002755/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002757 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002759 * This function sleeps until all work items which were queued on entry
2760 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002762void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763{
Tejun Heo73f53c42010-06-29 10:07:11 +02002764 struct wq_flusher this_flusher = {
2765 .list = LIST_HEAD_INIT(this_flusher.list),
2766 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002767 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002768 };
2769 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002770
Tejun Heo3347fa02016-09-16 15:49:32 -04002771 if (WARN_ON(!wq_online))
2772 return;
2773
Johannes Berg87915ad2018-08-22 11:49:04 +02002774 lock_map_acquire(&wq->lockdep_map);
2775 lock_map_release(&wq->lockdep_map);
2776
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002777 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002778
2779 /*
2780 * Start-to-wait phase
2781 */
2782 next_color = work_next_color(wq->work_color);
2783
2784 if (next_color != wq->flush_color) {
2785 /*
2786 * Color space is not full. The current work_color
2787 * becomes our flush_color and work_color is advanced
2788 * by one.
2789 */
Tejun Heo6183c002013-03-12 11:29:57 -07002790 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002791 this_flusher.flush_color = wq->work_color;
2792 wq->work_color = next_color;
2793
2794 if (!wq->first_flusher) {
2795 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002796 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002797
2798 wq->first_flusher = &this_flusher;
2799
Tejun Heo112202d2013-02-13 19:29:12 -08002800 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002801 wq->work_color)) {
2802 /* nothing to flush, done */
2803 wq->flush_color = next_color;
2804 wq->first_flusher = NULL;
2805 goto out_unlock;
2806 }
2807 } else {
2808 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002809 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002810 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002811 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002812 }
2813 } else {
2814 /*
2815 * Oops, color space is full, wait on overflow queue.
2816 * The next flush completion will assign us
2817 * flush_color and transfer to flusher_queue.
2818 */
2819 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2820 }
2821
Tejun Heofca839c2015-12-07 10:58:57 -05002822 check_flush_dependency(wq, NULL);
2823
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002824 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002825
2826 wait_for_completion(&this_flusher.done);
2827
2828 /*
2829 * Wake-up-and-cascade phase
2830 *
2831 * First flushers are responsible for cascading flushes and
2832 * handling overflow. Non-first flushers can simply return.
2833 */
2834 if (wq->first_flusher != &this_flusher)
2835 return;
2836
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002837 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002838
Tejun Heo4ce48b32010-07-02 10:03:51 +02002839 /* we might have raced, check again with mutex held */
2840 if (wq->first_flusher != &this_flusher)
2841 goto out_unlock;
2842
Tejun Heo73f53c42010-06-29 10:07:11 +02002843 wq->first_flusher = NULL;
2844
Tejun Heo6183c002013-03-12 11:29:57 -07002845 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2846 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002847
2848 while (true) {
2849 struct wq_flusher *next, *tmp;
2850
2851 /* complete all the flushers sharing the current flush color */
2852 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2853 if (next->flush_color != wq->flush_color)
2854 break;
2855 list_del_init(&next->list);
2856 complete(&next->done);
2857 }
2858
Tejun Heo6183c002013-03-12 11:29:57 -07002859 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2860 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002861
2862 /* this flush_color is finished, advance by one */
2863 wq->flush_color = work_next_color(wq->flush_color);
2864
2865 /* one color has been freed, handle overflow queue */
2866 if (!list_empty(&wq->flusher_overflow)) {
2867 /*
2868 * Assign the same color to all overflowed
2869 * flushers, advance work_color and append to
2870 * flusher_queue. This is the start-to-wait
2871 * phase for these overflowed flushers.
2872 */
2873 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2874 tmp->flush_color = wq->work_color;
2875
2876 wq->work_color = work_next_color(wq->work_color);
2877
2878 list_splice_tail_init(&wq->flusher_overflow,
2879 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002880 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002881 }
2882
2883 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002884 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002885 break;
2886 }
2887
2888 /*
2889 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002890 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002891 */
Tejun Heo6183c002013-03-12 11:29:57 -07002892 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2893 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002894
2895 list_del_init(&next->list);
2896 wq->first_flusher = next;
2897
Tejun Heo112202d2013-02-13 19:29:12 -08002898 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002899 break;
2900
2901 /*
2902 * Meh... this color is already done, clear first
2903 * flusher and repeat cascading.
2904 */
2905 wq->first_flusher = NULL;
2906 }
2907
2908out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002909 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002911EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002913/**
2914 * drain_workqueue - drain a workqueue
2915 * @wq: workqueue to drain
2916 *
2917 * Wait until the workqueue becomes empty. While draining is in progress,
2918 * only chain queueing is allowed. IOW, only currently pending or running
2919 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002920 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002921 * by the depth of chaining and should be relatively short. Whine if it
2922 * takes too long.
2923 */
2924void drain_workqueue(struct workqueue_struct *wq)
2925{
2926 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002927 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002928
2929 /*
2930 * __queue_work() needs to test whether there are drainers, is much
2931 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002932 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002933 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002934 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002935 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002936 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002937 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002938reflush:
2939 flush_workqueue(wq);
2940
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002941 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002942
Tejun Heo49e3cf42013-03-12 11:29:58 -07002943 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002944 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002945
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002946 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002947 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002948 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002949
2950 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002951 continue;
2952
2953 if (++flush_cnt == 10 ||
2954 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002955 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002956 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002957
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002958 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002959 goto reflush;
2960 }
2961
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002962 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002963 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002964 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002965}
2966EXPORT_SYMBOL_GPL(drain_workqueue);
2967
Johannes Bergd6e89782018-08-22 11:49:03 +02002968static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2969 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002970{
2971 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002972 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002973 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002974
2975 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002976
Tejun Heofa1b54e2013-03-12 11:30:00 -07002977 local_irq_disable();
2978 pool = get_work_pool(work);
2979 if (!pool) {
2980 local_irq_enable();
2981 return false;
2982 }
2983
2984 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002985 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002986 pwq = get_work_pwq(work);
2987 if (pwq) {
2988 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002989 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002990 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002991 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002992 if (!worker)
2993 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002994 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002995 }
Tejun Heobaf59022010-09-16 10:42:16 +02002996
Tejun Heofca839c2015-12-07 10:58:57 -05002997 check_flush_dependency(pwq->wq, work);
2998
Tejun Heo112202d2013-02-13 19:29:12 -08002999 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003000 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003001
Tejun Heoe159489b2011-01-09 23:32:15 +01003002 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003003 * Force a lock recursion deadlock when using flush_work() inside a
3004 * single-threaded or rescuer equipped workqueue.
3005 *
3006 * For single threaded workqueues the deadlock happens when the work
3007 * is after the work issuing the flush_work(). For rescuer equipped
3008 * workqueues the deadlock happens when the rescuer stalls, blocking
3009 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003010 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003011 if (!from_cancel &&
3012 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003013 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003014 lock_map_release(&pwq->wq->lockdep_map);
3015 }
Tejun Heoe159489b2011-01-09 23:32:15 +01003016
Tejun Heobaf59022010-09-16 10:42:16 +02003017 return true;
3018already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08003019 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003020 return false;
3021}
3022
Johannes Bergd6e89782018-08-22 11:49:03 +02003023static bool __flush_work(struct work_struct *work, bool from_cancel)
3024{
3025 struct wq_barrier barr;
3026
3027 if (WARN_ON(!wq_online))
3028 return false;
3029
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003030 if (WARN_ON(!work->func))
3031 return false;
3032
Johannes Berg87915ad2018-08-22 11:49:04 +02003033 if (!from_cancel) {
3034 lock_map_acquire(&work->lockdep_map);
3035 lock_map_release(&work->lockdep_map);
3036 }
3037
Johannes Bergd6e89782018-08-22 11:49:03 +02003038 if (start_flush_work(work, &barr, from_cancel)) {
3039 wait_for_completion(&barr.done);
3040 destroy_work_on_stack(&barr.work);
3041 return true;
3042 } else {
3043 return false;
3044 }
3045}
3046
Oleg Nesterovdb700892008-07-25 01:47:49 -07003047/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003048 * flush_work - wait for a work to finish executing the last queueing instance
3049 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003050 *
Tejun Heo606a5022012-08-20 14:51:23 -07003051 * Wait until @work has finished execution. @work is guaranteed to be idle
3052 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003053 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003054 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003055 * %true if flush_work() waited for the work to finish execution,
3056 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003057 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003058bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003059{
Johannes Bergd6e89782018-08-22 11:49:03 +02003060 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003061}
3062EXPORT_SYMBOL_GPL(flush_work);
3063
Tejun Heo8603e1b32015-03-05 08:04:13 -05003064struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003065 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003066 struct work_struct *work;
3067};
3068
Ingo Molnarac6424b2017-06-20 12:06:13 +02003069static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003070{
3071 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3072
3073 if (cwait->work != key)
3074 return 0;
3075 return autoremove_wake_function(wait, mode, sync, key);
3076}
3077
Tejun Heo36e227d2012-08-03 10:30:46 -07003078static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003079{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003080 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003081 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003082 int ret;
3083
3084 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003085 ret = try_to_grab_pending(work, is_dwork, &flags);
3086 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003087 * If someone else is already canceling, wait for it to
3088 * finish. flush_work() doesn't work for PREEMPT_NONE
3089 * because we may get scheduled between @work's completion
3090 * and the other canceling task resuming and clearing
3091 * CANCELING - flush_work() will return false immediately
3092 * as @work is no longer busy, try_to_grab_pending() will
3093 * return -ENOENT as @work is still being canceled and the
3094 * other canceling task won't be able to clear CANCELING as
3095 * we're hogging the CPU.
3096 *
3097 * Let's wait for completion using a waitqueue. As this
3098 * may lead to the thundering herd problem, use a custom
3099 * wake function which matches @work along with exclusive
3100 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003101 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003102 if (unlikely(ret == -ENOENT)) {
3103 struct cwt_wait cwait;
3104
3105 init_wait(&cwait.wait);
3106 cwait.wait.func = cwt_wakefn;
3107 cwait.work = work;
3108
3109 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3110 TASK_UNINTERRUPTIBLE);
3111 if (work_is_canceling(work))
3112 schedule();
3113 finish_wait(&cancel_waitq, &cwait.wait);
3114 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003115 } while (unlikely(ret < 0));
3116
Tejun Heobbb68df2012-08-03 10:30:46 -07003117 /* tell other tasks trying to grab @work to back off */
3118 mark_work_canceling(work);
3119 local_irq_restore(flags);
3120
Tejun Heo3347fa02016-09-16 15:49:32 -04003121 /*
3122 * This allows canceling during early boot. We know that @work
3123 * isn't executing.
3124 */
3125 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003126 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003127
Tejun Heo7a22ad72010-06-29 10:07:13 +02003128 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003129
3130 /*
3131 * Paired with prepare_to_wait() above so that either
3132 * waitqueue_active() is visible here or !work_is_canceling() is
3133 * visible there.
3134 */
3135 smp_mb();
3136 if (waitqueue_active(&cancel_waitq))
3137 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3138
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003139 return ret;
3140}
3141
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003142/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003143 * cancel_work_sync - cancel a work and wait for it to finish
3144 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003145 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003146 * Cancel @work and wait for its execution to finish. This function
3147 * can be used even if the work re-queues itself or migrates to
3148 * another workqueue. On return from this function, @work is
3149 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003150 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003151 * cancel_work_sync(&delayed_work->work) must not be used for
3152 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003153 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003154 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003155 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003156 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003157 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003158 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003159 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003160bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003161{
Tejun Heo36e227d2012-08-03 10:30:46 -07003162 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003163}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003164EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003165
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003166/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003167 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3168 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003169 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003170 * Delayed timer is cancelled and the pending work is queued for
3171 * immediate execution. Like flush_work(), this function only
3172 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003173 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003174 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003175 * %true if flush_work() waited for the work to finish execution,
3176 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003177 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003178bool flush_delayed_work(struct delayed_work *dwork)
3179{
Tejun Heo8930cab2012-08-03 10:30:45 -07003180 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003181 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003182 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003183 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003184 return flush_work(&dwork->work);
3185}
3186EXPORT_SYMBOL(flush_delayed_work);
3187
Tejun Heo05f0fe62018-03-14 12:45:13 -07003188/**
3189 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3190 * @rwork: the rcu work to flush
3191 *
3192 * Return:
3193 * %true if flush_rcu_work() waited for the work to finish execution,
3194 * %false if it was already idle.
3195 */
3196bool flush_rcu_work(struct rcu_work *rwork)
3197{
3198 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3199 rcu_barrier();
3200 flush_work(&rwork->work);
3201 return true;
3202 } else {
3203 return flush_work(&rwork->work);
3204 }
3205}
3206EXPORT_SYMBOL(flush_rcu_work);
3207
Jens Axboef72b8792016-08-24 15:51:50 -06003208static bool __cancel_work(struct work_struct *work, bool is_dwork)
3209{
3210 unsigned long flags;
3211 int ret;
3212
3213 do {
3214 ret = try_to_grab_pending(work, is_dwork, &flags);
3215 } while (unlikely(ret == -EAGAIN));
3216
3217 if (unlikely(ret < 0))
3218 return false;
3219
3220 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3221 local_irq_restore(flags);
3222 return ret;
3223}
3224
Tejun Heo401a8d02010-09-16 10:36:00 +02003225/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003226 * cancel_delayed_work - cancel a delayed work
3227 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003228 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003229 * Kill off a pending delayed_work.
3230 *
3231 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3232 * pending.
3233 *
3234 * Note:
3235 * The work callback function may still be running on return, unless
3236 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3237 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003238 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003239 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003240 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003241bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003242{
Jens Axboef72b8792016-08-24 15:51:50 -06003243 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003244}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003245EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003246
3247/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003248 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3249 * @dwork: the delayed work cancel
3250 *
3251 * This is cancel_work_sync() for delayed works.
3252 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003253 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003254 * %true if @dwork was pending, %false otherwise.
3255 */
3256bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003257{
Tejun Heo36e227d2012-08-03 10:30:46 -07003258 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003259}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003260EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003262/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003263 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003264 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003265 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003266 * schedule_on_each_cpu() executes @func on each online CPU using the
3267 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003268 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003269 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003270 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003271 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003272 */
David Howells65f27f32006-11-22 14:55:48 +00003273int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003274{
3275 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003276 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003277
Andrew Mortonb6136772006-06-25 05:47:49 -07003278 works = alloc_percpu(struct work_struct);
3279 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003280 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003281
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003282 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003283
Christoph Lameter15316ba2006-01-08 01:00:43 -08003284 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003285 struct work_struct *work = per_cpu_ptr(works, cpu);
3286
3287 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003288 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003289 }
Tejun Heo93981802009-11-17 14:06:20 -08003290
3291 for_each_online_cpu(cpu)
3292 flush_work(per_cpu_ptr(works, cpu));
3293
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003294 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003295 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003296 return 0;
3297}
3298
Alan Sterneef6a7d2010-02-12 17:39:21 +09003299/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003300 * execute_in_process_context - reliably execute the routine with user context
3301 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003302 * @ew: guaranteed storage for the execute work structure (must
3303 * be available when the work executes)
3304 *
3305 * Executes the function immediately if process context is available,
3306 * otherwise schedules the function for delayed execution.
3307 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003308 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003309 * 1 - function was scheduled for execution
3310 */
David Howells65f27f32006-11-22 14:55:48 +00003311int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003312{
3313 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003314 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003315 return 0;
3316 }
3317
David Howells65f27f32006-11-22 14:55:48 +00003318 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003319 schedule_work(&ew->work);
3320
3321 return 1;
3322}
3323EXPORT_SYMBOL_GPL(execute_in_process_context);
3324
Tejun Heo7a4e3442013-03-12 11:30:00 -07003325/**
3326 * free_workqueue_attrs - free a workqueue_attrs
3327 * @attrs: workqueue_attrs to free
3328 *
3329 * Undo alloc_workqueue_attrs().
3330 */
3331void free_workqueue_attrs(struct workqueue_attrs *attrs)
3332{
3333 if (attrs) {
3334 free_cpumask_var(attrs->cpumask);
3335 kfree(attrs);
3336 }
3337}
3338
3339/**
3340 * alloc_workqueue_attrs - allocate a workqueue_attrs
3341 * @gfp_mask: allocation mask to use
3342 *
3343 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003344 * return it.
3345 *
3346 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003347 */
3348struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3349{
3350 struct workqueue_attrs *attrs;
3351
3352 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3353 if (!attrs)
3354 goto fail;
3355 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3356 goto fail;
3357
Tejun Heo13e2e552013-04-01 11:23:31 -07003358 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003359 return attrs;
3360fail:
3361 free_workqueue_attrs(attrs);
3362 return NULL;
3363}
3364
Tejun Heo29c91e92013-03-12 11:30:03 -07003365static void copy_workqueue_attrs(struct workqueue_attrs *to,
3366 const struct workqueue_attrs *from)
3367{
3368 to->nice = from->nice;
3369 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003370 /*
3371 * Unlike hash and equality test, this function doesn't ignore
3372 * ->no_numa as it is used for both pool and wq attrs. Instead,
3373 * get_unbound_pool() explicitly clears ->no_numa after copying.
3374 */
3375 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003376}
3377
Tejun Heo29c91e92013-03-12 11:30:03 -07003378/* hash value of the content of @attr */
3379static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3380{
3381 u32 hash = 0;
3382
3383 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003384 hash = jhash(cpumask_bits(attrs->cpumask),
3385 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 return hash;
3387}
3388
3389/* content equality test */
3390static bool wqattrs_equal(const struct workqueue_attrs *a,
3391 const struct workqueue_attrs *b)
3392{
3393 if (a->nice != b->nice)
3394 return false;
3395 if (!cpumask_equal(a->cpumask, b->cpumask))
3396 return false;
3397 return true;
3398}
3399
Tejun Heo7a4e3442013-03-12 11:30:00 -07003400/**
3401 * init_worker_pool - initialize a newly zalloc'd worker_pool
3402 * @pool: worker_pool to initialize
3403 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303404 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003405 *
3406 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 * inside @pool proper are initialized and put_unbound_pool() can be called
3408 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003409 */
3410static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003411{
3412 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003413 pool->id = -1;
3414 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003415 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003416 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003417 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003418 INIT_LIST_HEAD(&pool->worklist);
3419 INIT_LIST_HEAD(&pool->idle_list);
3420 hash_init(pool->busy_hash);
3421
Kees Cook32a6c722017-10-16 15:58:25 -07003422 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003423
Kees Cook32a6c722017-10-16 15:58:25 -07003424 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003425
Lai Jiangshanda028462014-05-20 17:46:31 +08003426 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003427
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003428 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003429 INIT_HLIST_NODE(&pool->hash_node);
3430 pool->refcnt = 1;
3431
3432 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003433 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3434 if (!pool->attrs)
3435 return -ENOMEM;
3436 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003437}
3438
Bart Van Assche669de8b2019-02-14 15:00:54 -08003439#ifdef CONFIG_LOCKDEP
3440static void wq_init_lockdep(struct workqueue_struct *wq)
3441{
3442 char *lock_name;
3443
3444 lockdep_register_key(&wq->key);
3445 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3446 if (!lock_name)
3447 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003448
3449 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003450 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3451}
3452
3453static void wq_unregister_lockdep(struct workqueue_struct *wq)
3454{
3455 lockdep_unregister_key(&wq->key);
3456}
3457
3458static void wq_free_lockdep(struct workqueue_struct *wq)
3459{
3460 if (wq->lock_name != wq->name)
3461 kfree(wq->lock_name);
3462}
3463#else
3464static void wq_init_lockdep(struct workqueue_struct *wq)
3465{
3466}
3467
3468static void wq_unregister_lockdep(struct workqueue_struct *wq)
3469{
3470}
3471
3472static void wq_free_lockdep(struct workqueue_struct *wq)
3473{
3474}
3475#endif
3476
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003477static void rcu_free_wq(struct rcu_head *rcu)
3478{
3479 struct workqueue_struct *wq =
3480 container_of(rcu, struct workqueue_struct, rcu);
3481
Bart Van Assche669de8b2019-02-14 15:00:54 -08003482 wq_free_lockdep(wq);
3483
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003484 if (!(wq->flags & WQ_UNBOUND))
3485 free_percpu(wq->cpu_pwqs);
3486 else
3487 free_workqueue_attrs(wq->unbound_attrs);
3488
3489 kfree(wq->rescuer);
3490 kfree(wq);
3491}
3492
Tejun Heo29c91e92013-03-12 11:30:03 -07003493static void rcu_free_pool(struct rcu_head *rcu)
3494{
3495 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3496
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003497 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003498 free_workqueue_attrs(pool->attrs);
3499 kfree(pool);
3500}
3501
3502/**
3503 * put_unbound_pool - put a worker_pool
3504 * @pool: worker_pool to put
3505 *
3506 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003507 * safe manner. get_unbound_pool() calls this function on its failure path
3508 * and this function should be able to release pools which went through,
3509 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003510 *
3511 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003512 */
3513static void put_unbound_pool(struct worker_pool *pool)
3514{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003515 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003516 struct worker *worker;
3517
Tejun Heoa892cac2013-04-01 11:23:32 -07003518 lockdep_assert_held(&wq_pool_mutex);
3519
3520 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003521 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003522
3523 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003524 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003525 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003526 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003527
3528 /* release id and unhash */
3529 if (pool->id >= 0)
3530 idr_remove(&worker_pool_idr, pool->id);
3531 hash_del(&pool->hash_node);
3532
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003533 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003534 * Become the manager and destroy all workers. This prevents
3535 * @pool's workers from blocking on attach_mutex. We're the last
3536 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003537 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003538 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003539 wait_event_lock_irq(wq_manager_wait,
3540 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3541 pool->flags |= POOL_MANAGER_ACTIVE;
3542
Lai Jiangshan1037de32014-05-22 16:44:07 +08003543 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003544 destroy_worker(worker);
3545 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003546 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003547
Tejun Heo1258fae2018-05-18 08:47:13 -07003548 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003549 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003550 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003551 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003552
3553 if (pool->detach_completion)
3554 wait_for_completion(pool->detach_completion);
3555
Tejun Heo29c91e92013-03-12 11:30:03 -07003556 /* shut down the timers */
3557 del_timer_sync(&pool->idle_timer);
3558 del_timer_sync(&pool->mayday_timer);
3559
3560 /* sched-RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003561 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003562}
3563
3564/**
3565 * get_unbound_pool - get a worker_pool with the specified attributes
3566 * @attrs: the attributes of the worker_pool to get
3567 *
3568 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3569 * reference count and return it. If there already is a matching
3570 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003571 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003572 *
3573 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003574 *
3575 * Return: On success, a worker_pool with the same attributes as @attrs.
3576 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003577 */
3578static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3579{
Tejun Heo29c91e92013-03-12 11:30:03 -07003580 u32 hash = wqattrs_hash(attrs);
3581 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003582 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003583 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003584
Tejun Heoa892cac2013-04-01 11:23:32 -07003585 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003586
3587 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003588 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3589 if (wqattrs_equal(pool->attrs, attrs)) {
3590 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003591 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003592 }
3593 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003594
Xunlei Pange22735842015-10-09 11:53:12 +08003595 /* if cpumask is contained inside a NUMA node, we belong to that node */
3596 if (wq_numa_enabled) {
3597 for_each_node(node) {
3598 if (cpumask_subset(attrs->cpumask,
3599 wq_numa_possible_cpumask[node])) {
3600 target_node = node;
3601 break;
3602 }
3603 }
3604 }
3605
Tejun Heo29c91e92013-03-12 11:30:03 -07003606 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003607 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003608 if (!pool || init_worker_pool(pool) < 0)
3609 goto fail;
3610
Tejun Heo8864b4e2013-03-12 11:30:04 -07003611 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003612 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003613 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003614
Shaohua Li2865a8f2013-08-01 09:56:36 +08003615 /*
3616 * no_numa isn't a worker_pool attribute, always clear it. See
3617 * 'struct workqueue_attrs' comments for detail.
3618 */
3619 pool->attrs->no_numa = false;
3620
Tejun Heo29c91e92013-03-12 11:30:03 -07003621 if (worker_pool_assign_id(pool) < 0)
3622 goto fail;
3623
3624 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003625 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003626 goto fail;
3627
Tejun Heo29c91e92013-03-12 11:30:03 -07003628 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003629 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003630
Tejun Heo29c91e92013-03-12 11:30:03 -07003631 return pool;
3632fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003633 if (pool)
3634 put_unbound_pool(pool);
3635 return NULL;
3636}
3637
Tejun Heo8864b4e2013-03-12 11:30:04 -07003638static void rcu_free_pwq(struct rcu_head *rcu)
3639{
3640 kmem_cache_free(pwq_cache,
3641 container_of(rcu, struct pool_workqueue, rcu));
3642}
3643
3644/*
3645 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3646 * and needs to be destroyed.
3647 */
3648static void pwq_unbound_release_workfn(struct work_struct *work)
3649{
3650 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3651 unbound_release_work);
3652 struct workqueue_struct *wq = pwq->wq;
3653 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003654 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003655
3656 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3657 return;
3658
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003659 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003660 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003661 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003662 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003663
Tejun Heoa892cac2013-04-01 11:23:32 -07003664 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003665 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003666 mutex_unlock(&wq_pool_mutex);
3667
Paul E. McKenney25b00772018-11-06 19:18:45 -08003668 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003669
3670 /*
3671 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003672 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003673 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003674 if (is_last) {
3675 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003676 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003677 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003678}
3679
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003680/**
Tejun Heo699ce092013-03-13 16:51:35 -07003681 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003682 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003683 *
Tejun Heo699ce092013-03-13 16:51:35 -07003684 * If @pwq isn't freezing, set @pwq->max_active to the associated
3685 * workqueue's saved_max_active and activate delayed work items
3686 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003687 */
Tejun Heo699ce092013-03-13 16:51:35 -07003688static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003689{
Tejun Heo699ce092013-03-13 16:51:35 -07003690 struct workqueue_struct *wq = pwq->wq;
3691 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003692 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003693
Tejun Heo699ce092013-03-13 16:51:35 -07003694 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003695 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003696
3697 /* fast exit for non-freezable wqs */
3698 if (!freezable && pwq->max_active == wq->saved_max_active)
3699 return;
3700
Tejun Heo3347fa02016-09-16 15:49:32 -04003701 /* this function can be called during early boot w/ irq disabled */
3702 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003703
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003704 /*
3705 * During [un]freezing, the caller is responsible for ensuring that
3706 * this function is called at least once after @workqueue_freezing
3707 * is updated and visible.
3708 */
3709 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003710 pwq->max_active = wq->saved_max_active;
3711
3712 while (!list_empty(&pwq->delayed_works) &&
3713 pwq->nr_active < pwq->max_active)
3714 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003715
3716 /*
3717 * Need to kick a worker after thawed or an unbound wq's
3718 * max_active is bumped. It's a slow path. Do it always.
3719 */
3720 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003721 } else {
3722 pwq->max_active = 0;
3723 }
3724
Tejun Heo3347fa02016-09-16 15:49:32 -04003725 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003726}
3727
Tejun Heoe50aba92013-04-01 11:23:35 -07003728/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003729static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3730 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003731{
3732 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3733
Tejun Heoe50aba92013-04-01 11:23:35 -07003734 memset(pwq, 0, sizeof(*pwq));
3735
Tejun Heod2c1d402013-03-12 11:30:04 -07003736 pwq->pool = pool;
3737 pwq->wq = wq;
3738 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003739 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003740 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003741 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003742 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003743 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003744}
Tejun Heod2c1d402013-03-12 11:30:04 -07003745
Tejun Heof147f292013-04-01 11:23:35 -07003746/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003747static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003748{
3749 struct workqueue_struct *wq = pwq->wq;
3750
3751 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003752
Tejun Heo1befcf32013-04-01 11:23:35 -07003753 /* may be called multiple times, ignore if already linked */
3754 if (!list_empty(&pwq->pwqs_node))
3755 return;
3756
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003757 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003758 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003759
3760 /* sync max_active to the current setting */
3761 pwq_adjust_max_active(pwq);
3762
3763 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003764 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003765}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003766
Tejun Heof147f292013-04-01 11:23:35 -07003767/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3768static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3769 const struct workqueue_attrs *attrs)
3770{
3771 struct worker_pool *pool;
3772 struct pool_workqueue *pwq;
3773
3774 lockdep_assert_held(&wq_pool_mutex);
3775
3776 pool = get_unbound_pool(attrs);
3777 if (!pool)
3778 return NULL;
3779
Tejun Heoe50aba92013-04-01 11:23:35 -07003780 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003781 if (!pwq) {
3782 put_unbound_pool(pool);
3783 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003784 }
Tejun Heo6029a912013-04-01 11:23:34 -07003785
Tejun Heof147f292013-04-01 11:23:35 -07003786 init_pwq(pwq, wq, pool);
3787 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003788}
3789
Tejun Heo4c16bd32013-04-01 11:23:36 -07003790/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003791 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003792 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003793 * @node: the target NUMA node
3794 * @cpu_going_down: if >= 0, the CPU to consider as offline
3795 * @cpumask: outarg, the resulting cpumask
3796 *
3797 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3798 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003799 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003800 *
3801 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3802 * enabled and @node has online CPUs requested by @attrs, the returned
3803 * cpumask is the intersection of the possible CPUs of @node and
3804 * @attrs->cpumask.
3805 *
3806 * The caller is responsible for ensuring that the cpumask of @node stays
3807 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003808 *
3809 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3810 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003811 */
3812static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3813 int cpu_going_down, cpumask_t *cpumask)
3814{
Tejun Heod55262c2013-04-01 11:23:38 -07003815 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003816 goto use_dfl;
3817
3818 /* does @node have any online CPUs @attrs wants? */
3819 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3820 if (cpu_going_down >= 0)
3821 cpumask_clear_cpu(cpu_going_down, cpumask);
3822
3823 if (cpumask_empty(cpumask))
3824 goto use_dfl;
3825
3826 /* yeap, return possible CPUs in @node that @attrs wants */
3827 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003828
3829 if (cpumask_empty(cpumask)) {
3830 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3831 "possible intersect\n");
3832 return false;
3833 }
3834
Tejun Heo4c16bd32013-04-01 11:23:36 -07003835 return !cpumask_equal(cpumask, attrs->cpumask);
3836
3837use_dfl:
3838 cpumask_copy(cpumask, attrs->cpumask);
3839 return false;
3840}
3841
Tejun Heo1befcf32013-04-01 11:23:35 -07003842/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3843static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3844 int node,
3845 struct pool_workqueue *pwq)
3846{
3847 struct pool_workqueue *old_pwq;
3848
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003849 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003850 lockdep_assert_held(&wq->mutex);
3851
3852 /* link_pwq() can handle duplicate calls */
3853 link_pwq(pwq);
3854
3855 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3856 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3857 return old_pwq;
3858}
3859
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003860/* context to store the prepared attrs & pwqs before applying */
3861struct apply_wqattrs_ctx {
3862 struct workqueue_struct *wq; /* target workqueue */
3863 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003864 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003865 struct pool_workqueue *dfl_pwq;
3866 struct pool_workqueue *pwq_tbl[];
3867};
3868
3869/* free the resources after success or abort */
3870static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3871{
3872 if (ctx) {
3873 int node;
3874
3875 for_each_node(node)
3876 put_pwq_unlocked(ctx->pwq_tbl[node]);
3877 put_pwq_unlocked(ctx->dfl_pwq);
3878
3879 free_workqueue_attrs(ctx->attrs);
3880
3881 kfree(ctx);
3882 }
3883}
3884
3885/* allocate the attrs and pwqs for later installation */
3886static struct apply_wqattrs_ctx *
3887apply_wqattrs_prepare(struct workqueue_struct *wq,
3888 const struct workqueue_attrs *attrs)
3889{
3890 struct apply_wqattrs_ctx *ctx;
3891 struct workqueue_attrs *new_attrs, *tmp_attrs;
3892 int node;
3893
3894 lockdep_assert_held(&wq_pool_mutex);
3895
Kees Cookacafe7e2018-05-08 13:45:50 -07003896 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003897
3898 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3899 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3900 if (!ctx || !new_attrs || !tmp_attrs)
3901 goto out_free;
3902
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003903 /*
3904 * Calculate the attrs of the default pwq.
3905 * If the user configured cpumask doesn't overlap with the
3906 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3907 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003908 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003909 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003910 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3911 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003912
3913 /*
3914 * We may create multiple pwqs with differing cpumasks. Make a
3915 * copy of @new_attrs which will be modified and used to obtain
3916 * pools.
3917 */
3918 copy_workqueue_attrs(tmp_attrs, new_attrs);
3919
3920 /*
3921 * If something goes wrong during CPU up/down, we'll fall back to
3922 * the default pwq covering whole @attrs->cpumask. Always create
3923 * it even if we don't use it immediately.
3924 */
3925 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3926 if (!ctx->dfl_pwq)
3927 goto out_free;
3928
3929 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003930 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003931 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3932 if (!ctx->pwq_tbl[node])
3933 goto out_free;
3934 } else {
3935 ctx->dfl_pwq->refcnt++;
3936 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3937 }
3938 }
3939
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003940 /* save the user configured attrs and sanitize it. */
3941 copy_workqueue_attrs(new_attrs, attrs);
3942 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003943 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003944
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003945 ctx->wq = wq;
3946 free_workqueue_attrs(tmp_attrs);
3947 return ctx;
3948
3949out_free:
3950 free_workqueue_attrs(tmp_attrs);
3951 free_workqueue_attrs(new_attrs);
3952 apply_wqattrs_cleanup(ctx);
3953 return NULL;
3954}
3955
3956/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3957static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3958{
3959 int node;
3960
3961 /* all pwqs have been created successfully, let's install'em */
3962 mutex_lock(&ctx->wq->mutex);
3963
3964 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3965
3966 /* save the previous pwq and install the new one */
3967 for_each_node(node)
3968 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3969 ctx->pwq_tbl[node]);
3970
3971 /* @dfl_pwq might not have been used, ensure it's linked */
3972 link_pwq(ctx->dfl_pwq);
3973 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3974
3975 mutex_unlock(&ctx->wq->mutex);
3976}
3977
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003978static void apply_wqattrs_lock(void)
3979{
3980 /* CPUs should stay stable across pwq creations and installations */
3981 get_online_cpus();
3982 mutex_lock(&wq_pool_mutex);
3983}
3984
3985static void apply_wqattrs_unlock(void)
3986{
3987 mutex_unlock(&wq_pool_mutex);
3988 put_online_cpus();
3989}
3990
3991static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3992 const struct workqueue_attrs *attrs)
3993{
3994 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003995
3996 /* only unbound workqueues can change attributes */
3997 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3998 return -EINVAL;
3999
4000 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004001 if (!list_empty(&wq->pwqs)) {
4002 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4003 return -EINVAL;
4004
4005 wq->flags &= ~__WQ_ORDERED;
4006 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004007
4008 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004009 if (!ctx)
4010 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004011
4012 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004013 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004014 apply_wqattrs_cleanup(ctx);
4015
wanghaibin62011712016-01-07 20:38:59 +08004016 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004017}
4018
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004019/**
4020 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4021 * @wq: the target workqueue
4022 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4023 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004024 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4025 * machines, this function maps a separate pwq to each NUMA node with
4026 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4027 * NUMA node it was issued on. Older pwqs are released as in-flight work
4028 * items finish. Note that a work item which repeatedly requeues itself
4029 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004030 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004031 * Performs GFP_KERNEL allocations.
4032 *
4033 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004034 */
4035int apply_workqueue_attrs(struct workqueue_struct *wq,
4036 const struct workqueue_attrs *attrs)
4037{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004038 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004039
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004040 apply_wqattrs_lock();
4041 ret = apply_workqueue_attrs_locked(wq, attrs);
4042 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004043
Tejun Heo48621252013-04-01 11:23:31 -07004044 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004045}
NeilBrown6106c0f2018-01-11 15:06:40 +11004046EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004047
Tejun Heo4c16bd32013-04-01 11:23:36 -07004048/**
4049 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4050 * @wq: the target workqueue
4051 * @cpu: the CPU coming up or going down
4052 * @online: whether @cpu is coming up or going down
4053 *
4054 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4055 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4056 * @wq accordingly.
4057 *
4058 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4059 * falls back to @wq->dfl_pwq which may not be optimal but is always
4060 * correct.
4061 *
4062 * Note that when the last allowed CPU of a NUMA node goes offline for a
4063 * workqueue with a cpumask spanning multiple nodes, the workers which were
4064 * already executing the work items for the workqueue will lose their CPU
4065 * affinity and may execute on any CPU. This is similar to how per-cpu
4066 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4067 * affinity, it's the user's responsibility to flush the work item from
4068 * CPU_DOWN_PREPARE.
4069 */
4070static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4071 bool online)
4072{
4073 int node = cpu_to_node(cpu);
4074 int cpu_off = online ? -1 : cpu;
4075 struct pool_workqueue *old_pwq = NULL, *pwq;
4076 struct workqueue_attrs *target_attrs;
4077 cpumask_t *cpumask;
4078
4079 lockdep_assert_held(&wq_pool_mutex);
4080
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004081 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4082 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004083 return;
4084
4085 /*
4086 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4087 * Let's use a preallocated one. The following buf is protected by
4088 * CPU hotplug exclusion.
4089 */
4090 target_attrs = wq_update_unbound_numa_attrs_buf;
4091 cpumask = target_attrs->cpumask;
4092
Tejun Heo4c16bd32013-04-01 11:23:36 -07004093 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4094 pwq = unbound_pwq_by_node(wq, node);
4095
4096 /*
4097 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004098 * different from the default pwq's, we need to compare it to @pwq's
4099 * and create a new one if they don't match. If the target cpumask
4100 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004101 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004102 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004103 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004104 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004105 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004106 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004107 }
4108
Tejun Heo4c16bd32013-04-01 11:23:36 -07004109 /* create a new pwq */
4110 pwq = alloc_unbound_pwq(wq, target_attrs);
4111 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004112 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4113 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004114 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004115 }
4116
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004117 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004118 mutex_lock(&wq->mutex);
4119 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4120 goto out_unlock;
4121
4122use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004123 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004124 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4125 get_pwq(wq->dfl_pwq);
4126 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4127 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4128out_unlock:
4129 mutex_unlock(&wq->mutex);
4130 put_pwq_unlocked(old_pwq);
4131}
4132
Tejun Heo30cdf2492013-03-12 11:29:57 -07004133static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004134{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004135 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004136 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004137
Tejun Heo30cdf2492013-03-12 11:29:57 -07004138 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004139 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4140 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004141 return -ENOMEM;
4142
4143 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004144 struct pool_workqueue *pwq =
4145 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004146 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004147 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004148
Tejun Heof147f292013-04-01 11:23:35 -07004149 init_pwq(pwq, wq, &cpu_pools[highpri]);
4150
4151 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004152 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004153 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004154 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004155 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004156 } else if (wq->flags & __WQ_ORDERED) {
4157 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4158 /* there should only be single pwq for ordering guarantee */
4159 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4160 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4161 "ordering guarantee broken for workqueue %s\n", wq->name);
4162 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07004163 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004164 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004165 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004166}
4167
Tejun Heof3421792010-07-02 10:03:51 +02004168static int wq_clamp_max_active(int max_active, unsigned int flags,
4169 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004170{
Tejun Heof3421792010-07-02 10:03:51 +02004171 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4172
4173 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004174 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4175 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004176
Tejun Heof3421792010-07-02 10:03:51 +02004177 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004178}
4179
Tejun Heo983c7512018-01-08 05:38:32 -08004180/*
4181 * Workqueues which may be used during memory reclaim should have a rescuer
4182 * to guarantee forward progress.
4183 */
4184static int init_rescuer(struct workqueue_struct *wq)
4185{
4186 struct worker *rescuer;
4187 int ret;
4188
4189 if (!(wq->flags & WQ_MEM_RECLAIM))
4190 return 0;
4191
4192 rescuer = alloc_worker(NUMA_NO_NODE);
4193 if (!rescuer)
4194 return -ENOMEM;
4195
4196 rescuer->rescue_wq = wq;
4197 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4198 ret = PTR_ERR_OR_ZERO(rescuer->task);
4199 if (ret) {
4200 kfree(rescuer);
4201 return ret;
4202 }
4203
4204 wq->rescuer = rescuer;
4205 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4206 wake_up_process(rescuer->task);
4207
4208 return 0;
4209}
4210
Bart Van Assche669de8b2019-02-14 15:00:54 -08004211struct workqueue_struct *alloc_workqueue(const char *fmt,
4212 unsigned int flags,
4213 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004214{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004215 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004216 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004217 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004218 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004219
Tejun Heo5c0338c2017-07-18 18:41:52 -04004220 /*
4221 * Unbound && max_active == 1 used to imply ordered, which is no
4222 * longer the case on NUMA machines due to per-node pools. While
4223 * alloc_ordered_workqueue() is the right way to create an ordered
4224 * workqueue, keep the previous behavior to avoid subtle breakages
4225 * on NUMA.
4226 */
4227 if ((flags & WQ_UNBOUND) && max_active == 1)
4228 flags |= __WQ_ORDERED;
4229
Viresh Kumarcee22a12013-04-08 16:45:40 +05304230 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4231 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4232 flags |= WQ_UNBOUND;
4233
Tejun Heoecf68812013-04-01 11:23:34 -07004234 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004235 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004236 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004237
4238 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004239 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004240 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004241
Tejun Heo6029a912013-04-01 11:23:34 -07004242 if (flags & WQ_UNBOUND) {
4243 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4244 if (!wq->unbound_attrs)
4245 goto err_free_wq;
4246 }
4247
Bart Van Assche669de8b2019-02-14 15:00:54 -08004248 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004249 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004250 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004251
Tejun Heod320c032010-06-29 10:07:14 +02004252 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004253 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004254
Tejun Heob196be82012-01-10 15:11:35 -08004255 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004256 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004257 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004258 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004259 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004260 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004261 INIT_LIST_HEAD(&wq->flusher_queue);
4262 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004263 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004264
Bart Van Assche669de8b2019-02-14 15:00:54 -08004265 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004266 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004267
Tejun Heo30cdf2492013-03-12 11:29:57 -07004268 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004269 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004270
Tejun Heo40c17f72018-01-08 05:38:37 -08004271 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004272 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004273
Tejun Heo226223a2013-03-12 11:30:05 -07004274 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4275 goto err_destroy;
4276
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004277 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004278 * wq_pool_mutex protects global freeze state and workqueues list.
4279 * Grab it, adjust max_active and add the new @wq to workqueues
4280 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004281 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004282 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004283
Lai Jiangshana357fc02013-03-25 16:57:19 -07004284 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004285 for_each_pwq(pwq, wq)
4286 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004287 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004288
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004289 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004290
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004291 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004292
Oleg Nesterov3af244332007-05-09 02:34:09 -07004293 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004294
Bart Van Assche82efcab2019-03-11 16:02:55 -07004295err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004296 wq_unregister_lockdep(wq);
4297 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004298err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004299 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004300 kfree(wq);
4301 return NULL;
4302err_destroy:
4303 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004304 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004305}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004306EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004307
4308/**
4309 * destroy_workqueue - safely terminate a workqueue
4310 * @wq: target workqueue
4311 *
4312 * Safely destroy a workqueue. All work currently pending will be done first.
4313 */
4314void destroy_workqueue(struct workqueue_struct *wq)
4315{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004316 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004317 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004318
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004319 /* drain it before proceeding with destruction */
4320 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004321
Tejun Heo6183c002013-03-12 11:29:57 -07004322 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004323 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004324 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004325 int i;
4326
Tejun Heo76af4d92013-03-12 11:30:00 -07004327 for (i = 0; i < WORK_NR_COLORS; i++) {
4328 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004329 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004330 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004331 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004332 }
4333 }
4334
Lai Jiangshan5c529592013-04-04 10:05:38 +08004335 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004336 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004337 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004338 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004339 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004340 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004341 }
Tejun Heo6183c002013-03-12 11:29:57 -07004342 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004343 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004344
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004345 /*
4346 * wq list is used to freeze wq, remove from list after
4347 * flushing is complete in case freeze races us.
4348 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004349 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004350 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004351 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004352
Tejun Heo226223a2013-03-12 11:30:05 -07004353 workqueue_sysfs_unregister(wq);
4354
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004355 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004356 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004357
Tejun Heo8864b4e2013-03-12 11:30:04 -07004358 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004359 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004360 /*
4361 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004362 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004363 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004364 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004365 } else {
4366 /*
4367 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004368 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4369 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004370 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004371 for_each_node(node) {
4372 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4373 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4374 put_pwq_unlocked(pwq);
4375 }
4376
4377 /*
4378 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4379 * put. Don't access it afterwards.
4380 */
4381 pwq = wq->dfl_pwq;
4382 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004383 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004384 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004385}
4386EXPORT_SYMBOL_GPL(destroy_workqueue);
4387
Tejun Heodcd989c2010-06-29 10:07:14 +02004388/**
4389 * workqueue_set_max_active - adjust max_active of a workqueue
4390 * @wq: target workqueue
4391 * @max_active: new max_active value.
4392 *
4393 * Set max_active of @wq to @max_active.
4394 *
4395 * CONTEXT:
4396 * Don't call from IRQ context.
4397 */
4398void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4399{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004400 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004401
Tejun Heo8719dce2013-03-12 11:30:04 -07004402 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004403 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004404 return;
4405
Tejun Heof3421792010-07-02 10:03:51 +02004406 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004407
Lai Jiangshana357fc02013-03-25 16:57:19 -07004408 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004409
Tejun Heo0a94efb2017-07-23 08:36:15 -04004410 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004411 wq->saved_max_active = max_active;
4412
Tejun Heo699ce092013-03-13 16:51:35 -07004413 for_each_pwq(pwq, wq)
4414 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004415
Lai Jiangshana357fc02013-03-25 16:57:19 -07004416 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004417}
4418EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4419
4420/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004421 * current_work - retrieve %current task's work struct
4422 *
4423 * Determine if %current task is a workqueue worker and what it's working on.
4424 * Useful to find out the context that the %current task is running in.
4425 *
4426 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4427 */
4428struct work_struct *current_work(void)
4429{
4430 struct worker *worker = current_wq_worker();
4431
4432 return worker ? worker->current_work : NULL;
4433}
4434EXPORT_SYMBOL(current_work);
4435
4436/**
Tejun Heoe62676162013-03-12 17:41:37 -07004437 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4438 *
4439 * Determine whether %current is a workqueue rescuer. Can be used from
4440 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004441 *
4442 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004443 */
4444bool current_is_workqueue_rescuer(void)
4445{
4446 struct worker *worker = current_wq_worker();
4447
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004448 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004449}
4450
4451/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004452 * workqueue_congested - test whether a workqueue is congested
4453 * @cpu: CPU in question
4454 * @wq: target workqueue
4455 *
4456 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4457 * no synchronization around this function and the test result is
4458 * unreliable and only useful as advisory hints or for debugging.
4459 *
Tejun Heod3251852013-05-10 11:10:17 -07004460 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4461 * Note that both per-cpu and unbound workqueues may be associated with
4462 * multiple pool_workqueues which have separate congested states. A
4463 * workqueue being congested on one CPU doesn't mean the workqueue is also
4464 * contested on other CPUs / NUMA nodes.
4465 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004466 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004467 * %true if congested, %false otherwise.
4468 */
Tejun Heod84ff052013-03-12 11:29:59 -07004469bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004470{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004471 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004472 bool ret;
4473
Lai Jiangshan88109452013-03-20 03:28:10 +08004474 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004475
Tejun Heod3251852013-05-10 11:10:17 -07004476 if (cpu == WORK_CPU_UNBOUND)
4477 cpu = smp_processor_id();
4478
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004479 if (!(wq->flags & WQ_UNBOUND))
4480 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4481 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004482 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004483
Tejun Heo76af4d92013-03-12 11:30:00 -07004484 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004485 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004486
4487 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004488}
4489EXPORT_SYMBOL_GPL(workqueue_congested);
4490
4491/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004492 * work_busy - test whether a work is currently pending or running
4493 * @work: the work to be tested
4494 *
4495 * Test whether @work is currently pending or running. There is no
4496 * synchronization around this function and the test result is
4497 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004498 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004499 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004500 * OR'd bitmask of WORK_BUSY_* bits.
4501 */
4502unsigned int work_busy(struct work_struct *work)
4503{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004504 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004505 unsigned long flags;
4506 unsigned int ret = 0;
4507
Tejun Heodcd989c2010-06-29 10:07:14 +02004508 if (work_pending(work))
4509 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004510
Tejun Heofa1b54e2013-03-12 11:30:00 -07004511 local_irq_save(flags);
4512 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004513 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004514 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004515 if (find_worker_executing_work(pool, work))
4516 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004517 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004518 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004519 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004520
4521 return ret;
4522}
4523EXPORT_SYMBOL_GPL(work_busy);
4524
Tejun Heo3d1cb202013-04-30 15:27:22 -07004525/**
4526 * set_worker_desc - set description for the current work item
4527 * @fmt: printf-style format string
4528 * @...: arguments for the format string
4529 *
4530 * This function can be called by a running work function to describe what
4531 * the work item is about. If the worker task gets dumped, this
4532 * information will be printed out together to help debugging. The
4533 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4534 */
4535void set_worker_desc(const char *fmt, ...)
4536{
4537 struct worker *worker = current_wq_worker();
4538 va_list args;
4539
4540 if (worker) {
4541 va_start(args, fmt);
4542 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4543 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004544 }
4545}
Steffen Maier5c750d52018-05-17 19:14:57 +02004546EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004547
4548/**
4549 * print_worker_info - print out worker information and description
4550 * @log_lvl: the log level to use when printing
4551 * @task: target task
4552 *
4553 * If @task is a worker and currently executing a work item, print out the
4554 * name of the workqueue being serviced and worker description set with
4555 * set_worker_desc() by the currently executing work item.
4556 *
4557 * This function can be safely called on any task as long as the
4558 * task_struct itself is accessible. While safe, this function isn't
4559 * synchronized and may print out mixups or garbages of limited length.
4560 */
4561void print_worker_info(const char *log_lvl, struct task_struct *task)
4562{
4563 work_func_t *fn = NULL;
4564 char name[WQ_NAME_LEN] = { };
4565 char desc[WORKER_DESC_LEN] = { };
4566 struct pool_workqueue *pwq = NULL;
4567 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004568 struct worker *worker;
4569
4570 if (!(task->flags & PF_WQ_WORKER))
4571 return;
4572
4573 /*
4574 * This function is called without any synchronization and @task
4575 * could be in any state. Be careful with dereferences.
4576 */
Petr Mladeke7005912016-10-11 13:55:17 -07004577 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004578
4579 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004580 * Carefully copy the associated workqueue's workfn, name and desc.
4581 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004582 */
4583 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4584 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4585 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4586 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004587 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004588
4589 if (fn || name[0] || desc[0]) {
4590 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004591 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004592 pr_cont(" (%s)", desc);
4593 pr_cont("\n");
4594 }
4595}
4596
Tejun Heo3494fc32015-03-09 09:22:28 -04004597static void pr_cont_pool_info(struct worker_pool *pool)
4598{
4599 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4600 if (pool->node != NUMA_NO_NODE)
4601 pr_cont(" node=%d", pool->node);
4602 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4603}
4604
4605static void pr_cont_work(bool comma, struct work_struct *work)
4606{
4607 if (work->func == wq_barrier_func) {
4608 struct wq_barrier *barr;
4609
4610 barr = container_of(work, struct wq_barrier, work);
4611
4612 pr_cont("%s BAR(%d)", comma ? "," : "",
4613 task_pid_nr(barr->task));
4614 } else {
4615 pr_cont("%s %pf", comma ? "," : "", work->func);
4616 }
4617}
4618
4619static void show_pwq(struct pool_workqueue *pwq)
4620{
4621 struct worker_pool *pool = pwq->pool;
4622 struct work_struct *work;
4623 struct worker *worker;
4624 bool has_in_flight = false, has_pending = false;
4625 int bkt;
4626
4627 pr_info(" pwq %d:", pool->id);
4628 pr_cont_pool_info(pool);
4629
4630 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4631 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4632
4633 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4634 if (worker->current_pwq == pwq) {
4635 has_in_flight = true;
4636 break;
4637 }
4638 }
4639 if (has_in_flight) {
4640 bool comma = false;
4641
4642 pr_info(" in-flight:");
4643 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4644 if (worker->current_pwq != pwq)
4645 continue;
4646
4647 pr_cont("%s %d%s:%pf", comma ? "," : "",
4648 task_pid_nr(worker->task),
4649 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4650 worker->current_func);
4651 list_for_each_entry(work, &worker->scheduled, entry)
4652 pr_cont_work(false, work);
4653 comma = true;
4654 }
4655 pr_cont("\n");
4656 }
4657
4658 list_for_each_entry(work, &pool->worklist, entry) {
4659 if (get_work_pwq(work) == pwq) {
4660 has_pending = true;
4661 break;
4662 }
4663 }
4664 if (has_pending) {
4665 bool comma = false;
4666
4667 pr_info(" pending:");
4668 list_for_each_entry(work, &pool->worklist, entry) {
4669 if (get_work_pwq(work) != pwq)
4670 continue;
4671
4672 pr_cont_work(comma, work);
4673 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4674 }
4675 pr_cont("\n");
4676 }
4677
4678 if (!list_empty(&pwq->delayed_works)) {
4679 bool comma = false;
4680
4681 pr_info(" delayed:");
4682 list_for_each_entry(work, &pwq->delayed_works, entry) {
4683 pr_cont_work(comma, work);
4684 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4685 }
4686 pr_cont("\n");
4687 }
4688}
4689
4690/**
4691 * show_workqueue_state - dump workqueue state
4692 *
Roger Lu7b776af2016-07-01 11:05:02 +08004693 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4694 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004695 */
4696void show_workqueue_state(void)
4697{
4698 struct workqueue_struct *wq;
4699 struct worker_pool *pool;
4700 unsigned long flags;
4701 int pi;
4702
4703 rcu_read_lock_sched();
4704
4705 pr_info("Showing busy workqueues and worker pools:\n");
4706
4707 list_for_each_entry_rcu(wq, &workqueues, list) {
4708 struct pool_workqueue *pwq;
4709 bool idle = true;
4710
4711 for_each_pwq(pwq, wq) {
4712 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4713 idle = false;
4714 break;
4715 }
4716 }
4717 if (idle)
4718 continue;
4719
4720 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4721
4722 for_each_pwq(pwq, wq) {
4723 spin_lock_irqsave(&pwq->pool->lock, flags);
4724 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4725 show_pwq(pwq);
4726 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004727 /*
4728 * We could be printing a lot from atomic context, e.g.
4729 * sysrq-t -> show_workqueue_state(). Avoid triggering
4730 * hard lockup.
4731 */
4732 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004733 }
4734 }
4735
4736 for_each_pool(pool, pi) {
4737 struct worker *worker;
4738 bool first = true;
4739
4740 spin_lock_irqsave(&pool->lock, flags);
4741 if (pool->nr_workers == pool->nr_idle)
4742 goto next_pool;
4743
4744 pr_info("pool %d:", pool->id);
4745 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004746 pr_cont(" hung=%us workers=%d",
4747 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4748 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004749 if (pool->manager)
4750 pr_cont(" manager: %d",
4751 task_pid_nr(pool->manager->task));
4752 list_for_each_entry(worker, &pool->idle_list, entry) {
4753 pr_cont(" %s%d", first ? "idle: " : "",
4754 task_pid_nr(worker->task));
4755 first = false;
4756 }
4757 pr_cont("\n");
4758 next_pool:
4759 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004760 /*
4761 * We could be printing a lot from atomic context, e.g.
4762 * sysrq-t -> show_workqueue_state(). Avoid triggering
4763 * hard lockup.
4764 */
4765 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004766 }
4767
4768 rcu_read_unlock_sched();
4769}
4770
Tejun Heo6b598082018-05-18 08:47:13 -07004771/* used to show worker information through /proc/PID/{comm,stat,status} */
4772void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4773{
Tejun Heo6b598082018-05-18 08:47:13 -07004774 int off;
4775
4776 /* always show the actual comm */
4777 off = strscpy(buf, task->comm, size);
4778 if (off < 0)
4779 return;
4780
Tejun Heo197f6ac2018-05-21 08:04:35 -07004781 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004782 mutex_lock(&wq_pool_attach_mutex);
4783
Tejun Heo197f6ac2018-05-21 08:04:35 -07004784 if (task->flags & PF_WQ_WORKER) {
4785 struct worker *worker = kthread_data(task);
4786 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004787
Tejun Heo197f6ac2018-05-21 08:04:35 -07004788 if (pool) {
4789 spin_lock_irq(&pool->lock);
4790 /*
4791 * ->desc tracks information (wq name or
4792 * set_worker_desc()) for the latest execution. If
4793 * current, prepend '+', otherwise '-'.
4794 */
4795 if (worker->desc[0] != '\0') {
4796 if (worker->current_work)
4797 scnprintf(buf + off, size - off, "+%s",
4798 worker->desc);
4799 else
4800 scnprintf(buf + off, size - off, "-%s",
4801 worker->desc);
4802 }
4803 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004804 }
Tejun Heo6b598082018-05-18 08:47:13 -07004805 }
4806
4807 mutex_unlock(&wq_pool_attach_mutex);
4808}
4809
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004810#ifdef CONFIG_SMP
4811
Tejun Heodb7bccf2010-06-29 10:07:12 +02004812/*
4813 * CPU hotplug.
4814 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004815 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004816 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004817 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004818 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004819 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004820 * blocked draining impractical.
4821 *
Tejun Heo24647572013-01-24 11:01:33 -08004822 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004823 * running as an unbound one and allowing it to be reattached later if the
4824 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004825 */
4826
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004827static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004828{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004829 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004830 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004831
Tejun Heof02ae732013-03-12 11:30:03 -07004832 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004833 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004834 spin_lock_irq(&pool->lock);
4835
4836 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004837 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004838 * unbound and set DISASSOCIATED. Before this, all workers
4839 * except for the ones which are still executing works from
4840 * before the last CPU down must be on the cpu. After
4841 * this, they may become diasporas.
4842 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004843 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004844 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004845
Tejun Heo24647572013-01-24 11:01:33 -08004846 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004847
Tejun Heo94cf58b2013-01-24 11:01:33 -08004848 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004849 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004850
Lai Jiangshaneb283422013-03-08 15:18:28 -08004851 /*
4852 * Call schedule() so that we cross rq->lock and thus can
4853 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4854 * This is necessary as scheduler callbacks may be invoked
4855 * from other cpus.
4856 */
4857 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004858
Lai Jiangshaneb283422013-03-08 15:18:28 -08004859 /*
4860 * Sched callbacks are disabled now. Zap nr_running.
4861 * After this, nr_running stays zero and need_more_worker()
4862 * and keep_working() are always true as long as the
4863 * worklist is not empty. This pool now behaves as an
4864 * unbound (in terms of concurrency management) pool which
4865 * are served by workers tied to the pool.
4866 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004867 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004868
4869 /*
4870 * With concurrency management just turned off, a busy
4871 * worker blocking could lead to lengthy stalls. Kick off
4872 * unbound chain execution of currently pending work items.
4873 */
4874 spin_lock_irq(&pool->lock);
4875 wake_up_worker(pool);
4876 spin_unlock_irq(&pool->lock);
4877 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004878}
4879
Tejun Heobd7c0892013-03-19 13:45:21 -07004880/**
4881 * rebind_workers - rebind all workers of a pool to the associated CPU
4882 * @pool: pool of interest
4883 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004884 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004885 */
4886static void rebind_workers(struct worker_pool *pool)
4887{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004888 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004889
Tejun Heo1258fae2018-05-18 08:47:13 -07004890 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004891
Tejun Heoa9ab7752013-03-19 13:45:21 -07004892 /*
4893 * Restore CPU affinity of all workers. As all idle workers should
4894 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304895 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004896 * of all workers first and then clear UNBOUND. As we're called
4897 * from CPU_ONLINE, the following shouldn't fail.
4898 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004899 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004900 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4901 pool->attrs->cpumask) < 0);
4902
4903 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004904
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004905 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004906
Lai Jiangshanda028462014-05-20 17:46:31 +08004907 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004908 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004909
4910 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004911 * A bound idle worker should actually be on the runqueue
4912 * of the associated CPU for local wake-ups targeting it to
4913 * work. Kick all idle workers so that they migrate to the
4914 * associated CPU. Doing this in the same loop as
4915 * replacing UNBOUND with REBOUND is safe as no worker will
4916 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004917 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004918 if (worker_flags & WORKER_IDLE)
4919 wake_up_process(worker->task);
4920
4921 /*
4922 * We want to clear UNBOUND but can't directly call
4923 * worker_clr_flags() or adjust nr_running. Atomically
4924 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4925 * @worker will clear REBOUND using worker_clr_flags() when
4926 * it initiates the next execution cycle thus restoring
4927 * concurrency management. Note that when or whether
4928 * @worker clears REBOUND doesn't affect correctness.
4929 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004930 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004931 * tested without holding any lock in
4932 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4933 * fail incorrectly leading to premature concurrency
4934 * management operations.
4935 */
4936 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4937 worker_flags |= WORKER_REBOUND;
4938 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004939 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004940 }
4941
Tejun Heoa9ab7752013-03-19 13:45:21 -07004942 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004943}
4944
Tejun Heo7dbc7252013-03-19 13:45:21 -07004945/**
4946 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4947 * @pool: unbound pool of interest
4948 * @cpu: the CPU which is coming up
4949 *
4950 * An unbound pool may end up with a cpumask which doesn't have any online
4951 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4952 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4953 * online CPU before, cpus_allowed of all its workers should be restored.
4954 */
4955static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4956{
4957 static cpumask_t cpumask;
4958 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004959
Tejun Heo1258fae2018-05-18 08:47:13 -07004960 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004961
4962 /* is @cpu allowed for @pool? */
4963 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4964 return;
4965
Tejun Heo7dbc7252013-03-19 13:45:21 -07004966 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004967
4968 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004969 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004970 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004971}
4972
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004973int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004974{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004975 struct worker_pool *pool;
4976
4977 for_each_cpu_worker_pool(pool, cpu) {
4978 if (pool->nr_workers)
4979 continue;
4980 if (!create_worker(pool))
4981 return -ENOMEM;
4982 }
4983 return 0;
4984}
4985
4986int workqueue_online_cpu(unsigned int cpu)
4987{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004988 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004989 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004990 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004991
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004992 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004993
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004994 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004995 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004996
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004997 if (pool->cpu == cpu)
4998 rebind_workers(pool);
4999 else if (pool->cpu < 0)
5000 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005001
Tejun Heo1258fae2018-05-18 08:47:13 -07005002 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005003 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005004
5005 /* update NUMA affinity of unbound workqueues */
5006 list_for_each_entry(wq, &workqueues, list)
5007 wq_update_unbound_numa(wq, cpu, true);
5008
5009 mutex_unlock(&wq_pool_mutex);
5010 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005011}
5012
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005013int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005014{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005015 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005016
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005017 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005018 if (WARN_ON(cpu != smp_processor_id()))
5019 return -1;
5020
5021 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005022
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005023 /* update NUMA affinity of unbound workqueues */
5024 mutex_lock(&wq_pool_mutex);
5025 list_for_each_entry(wq, &workqueues, list)
5026 wq_update_unbound_numa(wq, cpu, false);
5027 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005028
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005029 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005030}
5031
Rusty Russell2d3854a2008-11-05 13:39:10 +11005032struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005033 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005034 long (*fn)(void *);
5035 void *arg;
5036 long ret;
5037};
5038
Tejun Heoed48ece2012-09-18 12:48:43 -07005039static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005040{
Tejun Heoed48ece2012-09-18 12:48:43 -07005041 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5042
Rusty Russell2d3854a2008-11-05 13:39:10 +11005043 wfc->ret = wfc->fn(wfc->arg);
5044}
5045
5046/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005047 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005048 * @cpu: the cpu to run on
5049 * @fn: the function to run
5050 * @arg: the function arg
5051 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005052 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005053 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005054 *
5055 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005056 */
Tejun Heod84ff052013-03-12 11:29:59 -07005057long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005058{
Tejun Heoed48ece2012-09-18 12:48:43 -07005059 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005060
Tejun Heoed48ece2012-09-18 12:48:43 -07005061 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5062 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005063 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005064 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005065 return wfc.ret;
5066}
5067EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005068
5069/**
5070 * work_on_cpu_safe - run a function in thread context on a particular cpu
5071 * @cpu: the cpu to run on
5072 * @fn: the function to run
5073 * @arg: the function argument
5074 *
5075 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5076 * any locks which would prevent @fn from completing.
5077 *
5078 * Return: The value @fn returns.
5079 */
5080long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5081{
5082 long ret = -ENODEV;
5083
5084 get_online_cpus();
5085 if (cpu_online(cpu))
5086 ret = work_on_cpu(cpu, fn, arg);
5087 put_online_cpus();
5088 return ret;
5089}
5090EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005091#endif /* CONFIG_SMP */
5092
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005093#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305094
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005095/**
5096 * freeze_workqueues_begin - begin freezing workqueues
5097 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005098 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005099 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005100 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005101 *
5102 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005103 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005104 */
5105void freeze_workqueues_begin(void)
5106{
Tejun Heo24b8a842013-03-12 11:29:58 -07005107 struct workqueue_struct *wq;
5108 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005109
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005110 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005111
Tejun Heo6183c002013-03-12 11:29:57 -07005112 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005113 workqueue_freezing = true;
5114
Tejun Heo24b8a842013-03-12 11:29:58 -07005115 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005116 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005117 for_each_pwq(pwq, wq)
5118 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005119 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005120 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005121
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005122 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005123}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005124
5125/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005126 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005127 *
5128 * Check whether freezing is complete. This function must be called
5129 * between freeze_workqueues_begin() and thaw_workqueues().
5130 *
5131 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005132 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005133 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005134 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005135 * %true if some freezable workqueues are still busy. %false if freezing
5136 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005137 */
5138bool freeze_workqueues_busy(void)
5139{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005140 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005141 struct workqueue_struct *wq;
5142 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005143
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005144 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005145
Tejun Heo6183c002013-03-12 11:29:57 -07005146 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005147
Tejun Heo24b8a842013-03-12 11:29:58 -07005148 list_for_each_entry(wq, &workqueues, list) {
5149 if (!(wq->flags & WQ_FREEZABLE))
5150 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005151 /*
5152 * nr_active is monotonically decreasing. It's safe
5153 * to peek without lock.
5154 */
Lai Jiangshan88109452013-03-20 03:28:10 +08005155 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07005156 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005157 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005158 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005159 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08005160 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005161 goto out_unlock;
5162 }
5163 }
Lai Jiangshan88109452013-03-20 03:28:10 +08005164 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005165 }
5166out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005167 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005168 return busy;
5169}
5170
5171/**
5172 * thaw_workqueues - thaw workqueues
5173 *
5174 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005175 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005176 *
5177 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005178 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005179 */
5180void thaw_workqueues(void)
5181{
Tejun Heo24b8a842013-03-12 11:29:58 -07005182 struct workqueue_struct *wq;
5183 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005184
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005185 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005186
5187 if (!workqueue_freezing)
5188 goto out_unlock;
5189
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005190 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005191
Tejun Heo24b8a842013-03-12 11:29:58 -07005192 /* restore max_active and repopulate worklist */
5193 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005194 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005195 for_each_pwq(pwq, wq)
5196 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005197 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005198 }
5199
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005200out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005201 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005202}
5203#endif /* CONFIG_FREEZER */
5204
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005205static int workqueue_apply_unbound_cpumask(void)
5206{
5207 LIST_HEAD(ctxs);
5208 int ret = 0;
5209 struct workqueue_struct *wq;
5210 struct apply_wqattrs_ctx *ctx, *n;
5211
5212 lockdep_assert_held(&wq_pool_mutex);
5213
5214 list_for_each_entry(wq, &workqueues, list) {
5215 if (!(wq->flags & WQ_UNBOUND))
5216 continue;
5217 /* creating multiple pwqs breaks ordering guarantee */
5218 if (wq->flags & __WQ_ORDERED)
5219 continue;
5220
5221 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5222 if (!ctx) {
5223 ret = -ENOMEM;
5224 break;
5225 }
5226
5227 list_add_tail(&ctx->list, &ctxs);
5228 }
5229
5230 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5231 if (!ret)
5232 apply_wqattrs_commit(ctx);
5233 apply_wqattrs_cleanup(ctx);
5234 }
5235
5236 return ret;
5237}
5238
5239/**
5240 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5241 * @cpumask: the cpumask to set
5242 *
5243 * The low-level workqueues cpumask is a global cpumask that limits
5244 * the affinity of all unbound workqueues. This function check the @cpumask
5245 * and apply it to all unbound workqueues and updates all pwqs of them.
5246 *
5247 * Retun: 0 - Success
5248 * -EINVAL - Invalid @cpumask
5249 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5250 */
5251int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5252{
5253 int ret = -EINVAL;
5254 cpumask_var_t saved_cpumask;
5255
5256 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5257 return -ENOMEM;
5258
Tal Shorerc98a9802017-11-03 17:27:50 +02005259 /*
5260 * Not excluding isolated cpus on purpose.
5261 * If the user wishes to include them, we allow that.
5262 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005263 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5264 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005265 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005266
5267 /* save the old wq_unbound_cpumask. */
5268 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5269
5270 /* update wq_unbound_cpumask at first and apply it to wqs. */
5271 cpumask_copy(wq_unbound_cpumask, cpumask);
5272 ret = workqueue_apply_unbound_cpumask();
5273
5274 /* restore the wq_unbound_cpumask when failed. */
5275 if (ret < 0)
5276 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5277
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005278 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005279 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005280
5281 free_cpumask_var(saved_cpumask);
5282 return ret;
5283}
5284
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005285#ifdef CONFIG_SYSFS
5286/*
5287 * Workqueues with WQ_SYSFS flag set is visible to userland via
5288 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5289 * following attributes.
5290 *
5291 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5292 * max_active RW int : maximum number of in-flight work items
5293 *
5294 * Unbound workqueues have the following extra attributes.
5295 *
Wang Long9a19b462017-11-02 23:05:12 -04005296 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005297 * nice RW int : nice value of the workers
5298 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005299 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005300 */
5301struct wq_device {
5302 struct workqueue_struct *wq;
5303 struct device dev;
5304};
5305
5306static struct workqueue_struct *dev_to_wq(struct device *dev)
5307{
5308 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5309
5310 return wq_dev->wq;
5311}
5312
5313static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5314 char *buf)
5315{
5316 struct workqueue_struct *wq = dev_to_wq(dev);
5317
5318 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5319}
5320static DEVICE_ATTR_RO(per_cpu);
5321
5322static ssize_t max_active_show(struct device *dev,
5323 struct device_attribute *attr, char *buf)
5324{
5325 struct workqueue_struct *wq = dev_to_wq(dev);
5326
5327 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5328}
5329
5330static ssize_t max_active_store(struct device *dev,
5331 struct device_attribute *attr, const char *buf,
5332 size_t count)
5333{
5334 struct workqueue_struct *wq = dev_to_wq(dev);
5335 int val;
5336
5337 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5338 return -EINVAL;
5339
5340 workqueue_set_max_active(wq, val);
5341 return count;
5342}
5343static DEVICE_ATTR_RW(max_active);
5344
5345static struct attribute *wq_sysfs_attrs[] = {
5346 &dev_attr_per_cpu.attr,
5347 &dev_attr_max_active.attr,
5348 NULL,
5349};
5350ATTRIBUTE_GROUPS(wq_sysfs);
5351
5352static ssize_t wq_pool_ids_show(struct device *dev,
5353 struct device_attribute *attr, char *buf)
5354{
5355 struct workqueue_struct *wq = dev_to_wq(dev);
5356 const char *delim = "";
5357 int node, written = 0;
5358
5359 rcu_read_lock_sched();
5360 for_each_node(node) {
5361 written += scnprintf(buf + written, PAGE_SIZE - written,
5362 "%s%d:%d", delim, node,
5363 unbound_pwq_by_node(wq, node)->pool->id);
5364 delim = " ";
5365 }
5366 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5367 rcu_read_unlock_sched();
5368
5369 return written;
5370}
5371
5372static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5373 char *buf)
5374{
5375 struct workqueue_struct *wq = dev_to_wq(dev);
5376 int written;
5377
5378 mutex_lock(&wq->mutex);
5379 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5380 mutex_unlock(&wq->mutex);
5381
5382 return written;
5383}
5384
5385/* prepare workqueue_attrs for sysfs store operations */
5386static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5387{
5388 struct workqueue_attrs *attrs;
5389
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005390 lockdep_assert_held(&wq_pool_mutex);
5391
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005392 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5393 if (!attrs)
5394 return NULL;
5395
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005396 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005397 return attrs;
5398}
5399
5400static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5401 const char *buf, size_t count)
5402{
5403 struct workqueue_struct *wq = dev_to_wq(dev);
5404 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005405 int ret = -ENOMEM;
5406
5407 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005408
5409 attrs = wq_sysfs_prep_attrs(wq);
5410 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005411 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005412
5413 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5414 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005415 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005416 else
5417 ret = -EINVAL;
5418
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005419out_unlock:
5420 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005421 free_workqueue_attrs(attrs);
5422 return ret ?: count;
5423}
5424
5425static ssize_t wq_cpumask_show(struct device *dev,
5426 struct device_attribute *attr, 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, "%*pb\n",
5433 cpumask_pr_args(wq->unbound_attrs->cpumask));
5434 mutex_unlock(&wq->mutex);
5435 return written;
5436}
5437
5438static ssize_t wq_cpumask_store(struct device *dev,
5439 struct device_attribute *attr,
5440 const char *buf, size_t count)
5441{
5442 struct workqueue_struct *wq = dev_to_wq(dev);
5443 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005444 int ret = -ENOMEM;
5445
5446 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005447
5448 attrs = wq_sysfs_prep_attrs(wq);
5449 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005450 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005451
5452 ret = cpumask_parse(buf, attrs->cpumask);
5453 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005454 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005455
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005456out_unlock:
5457 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005458 free_workqueue_attrs(attrs);
5459 return ret ?: count;
5460}
5461
5462static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5463 char *buf)
5464{
5465 struct workqueue_struct *wq = dev_to_wq(dev);
5466 int written;
5467
5468 mutex_lock(&wq->mutex);
5469 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5470 !wq->unbound_attrs->no_numa);
5471 mutex_unlock(&wq->mutex);
5472
5473 return written;
5474}
5475
5476static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5477 const char *buf, size_t count)
5478{
5479 struct workqueue_struct *wq = dev_to_wq(dev);
5480 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005481 int v, ret = -ENOMEM;
5482
5483 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005484
5485 attrs = wq_sysfs_prep_attrs(wq);
5486 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005487 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005488
5489 ret = -EINVAL;
5490 if (sscanf(buf, "%d", &v) == 1) {
5491 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005492 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005493 }
5494
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005495out_unlock:
5496 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005497 free_workqueue_attrs(attrs);
5498 return ret ?: count;
5499}
5500
5501static struct device_attribute wq_sysfs_unbound_attrs[] = {
5502 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5503 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5504 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5505 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5506 __ATTR_NULL,
5507};
5508
5509static struct bus_type wq_subsys = {
5510 .name = "workqueue",
5511 .dev_groups = wq_sysfs_groups,
5512};
5513
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005514static ssize_t wq_unbound_cpumask_show(struct device *dev,
5515 struct device_attribute *attr, char *buf)
5516{
5517 int written;
5518
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005519 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005520 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5521 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005522 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005523
5524 return written;
5525}
5526
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005527static ssize_t wq_unbound_cpumask_store(struct device *dev,
5528 struct device_attribute *attr, const char *buf, size_t count)
5529{
5530 cpumask_var_t cpumask;
5531 int ret;
5532
5533 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5534 return -ENOMEM;
5535
5536 ret = cpumask_parse(buf, cpumask);
5537 if (!ret)
5538 ret = workqueue_set_unbound_cpumask(cpumask);
5539
5540 free_cpumask_var(cpumask);
5541 return ret ? ret : count;
5542}
5543
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005544static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005545 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5546 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005547
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005548static int __init wq_sysfs_init(void)
5549{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005550 int err;
5551
5552 err = subsys_virtual_register(&wq_subsys, NULL);
5553 if (err)
5554 return err;
5555
5556 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005557}
5558core_initcall(wq_sysfs_init);
5559
5560static void wq_device_release(struct device *dev)
5561{
5562 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5563
5564 kfree(wq_dev);
5565}
5566
5567/**
5568 * workqueue_sysfs_register - make a workqueue visible in sysfs
5569 * @wq: the workqueue to register
5570 *
5571 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5572 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5573 * which is the preferred method.
5574 *
5575 * Workqueue user should use this function directly iff it wants to apply
5576 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5577 * apply_workqueue_attrs() may race against userland updating the
5578 * attributes.
5579 *
5580 * Return: 0 on success, -errno on failure.
5581 */
5582int workqueue_sysfs_register(struct workqueue_struct *wq)
5583{
5584 struct wq_device *wq_dev;
5585 int ret;
5586
5587 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305588 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005589 * attributes breaks ordering guarantee. Disallow exposing ordered
5590 * workqueues.
5591 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005592 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005593 return -EINVAL;
5594
5595 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5596 if (!wq_dev)
5597 return -ENOMEM;
5598
5599 wq_dev->wq = wq;
5600 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005601 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005602 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005603
5604 /*
5605 * unbound_attrs are created separately. Suppress uevent until
5606 * everything is ready.
5607 */
5608 dev_set_uevent_suppress(&wq_dev->dev, true);
5609
5610 ret = device_register(&wq_dev->dev);
5611 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305612 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005613 wq->wq_dev = NULL;
5614 return ret;
5615 }
5616
5617 if (wq->flags & WQ_UNBOUND) {
5618 struct device_attribute *attr;
5619
5620 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5621 ret = device_create_file(&wq_dev->dev, attr);
5622 if (ret) {
5623 device_unregister(&wq_dev->dev);
5624 wq->wq_dev = NULL;
5625 return ret;
5626 }
5627 }
5628 }
5629
5630 dev_set_uevent_suppress(&wq_dev->dev, false);
5631 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5632 return 0;
5633}
5634
5635/**
5636 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5637 * @wq: the workqueue to unregister
5638 *
5639 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5640 */
5641static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5642{
5643 struct wq_device *wq_dev = wq->wq_dev;
5644
5645 if (!wq->wq_dev)
5646 return;
5647
5648 wq->wq_dev = NULL;
5649 device_unregister(&wq_dev->dev);
5650}
5651#else /* CONFIG_SYSFS */
5652static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5653#endif /* CONFIG_SYSFS */
5654
Tejun Heo82607adc2015-12-08 11:28:04 -05005655/*
5656 * Workqueue watchdog.
5657 *
5658 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5659 * flush dependency, a concurrency managed work item which stays RUNNING
5660 * indefinitely. Workqueue stalls can be very difficult to debug as the
5661 * usual warning mechanisms don't trigger and internal workqueue state is
5662 * largely opaque.
5663 *
5664 * Workqueue watchdog monitors all worker pools periodically and dumps
5665 * state if some pools failed to make forward progress for a while where
5666 * forward progress is defined as the first item on ->worklist changing.
5667 *
5668 * This mechanism is controlled through the kernel parameter
5669 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5670 * corresponding sysfs parameter file.
5671 */
5672#ifdef CONFIG_WQ_WATCHDOG
5673
Tejun Heo82607adc2015-12-08 11:28:04 -05005674static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005675static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005676
5677static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5678static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5679
5680static void wq_watchdog_reset_touched(void)
5681{
5682 int cpu;
5683
5684 wq_watchdog_touched = jiffies;
5685 for_each_possible_cpu(cpu)
5686 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5687}
5688
Kees Cook5cd79d62017-10-04 16:27:00 -07005689static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005690{
5691 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5692 bool lockup_detected = false;
5693 struct worker_pool *pool;
5694 int pi;
5695
5696 if (!thresh)
5697 return;
5698
5699 rcu_read_lock();
5700
5701 for_each_pool(pool, pi) {
5702 unsigned long pool_ts, touched, ts;
5703
5704 if (list_empty(&pool->worklist))
5705 continue;
5706
5707 /* get the latest of pool and touched timestamps */
5708 pool_ts = READ_ONCE(pool->watchdog_ts);
5709 touched = READ_ONCE(wq_watchdog_touched);
5710
5711 if (time_after(pool_ts, touched))
5712 ts = pool_ts;
5713 else
5714 ts = touched;
5715
5716 if (pool->cpu >= 0) {
5717 unsigned long cpu_touched =
5718 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5719 pool->cpu));
5720 if (time_after(cpu_touched, ts))
5721 ts = cpu_touched;
5722 }
5723
5724 /* did we stall? */
5725 if (time_after(jiffies, ts + thresh)) {
5726 lockup_detected = true;
5727 pr_emerg("BUG: workqueue lockup - pool");
5728 pr_cont_pool_info(pool);
5729 pr_cont(" stuck for %us!\n",
5730 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5731 }
5732 }
5733
5734 rcu_read_unlock();
5735
5736 if (lockup_detected)
5737 show_workqueue_state();
5738
5739 wq_watchdog_reset_touched();
5740 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5741}
5742
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005743notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005744{
5745 if (cpu >= 0)
5746 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5747 else
5748 wq_watchdog_touched = jiffies;
5749}
5750
5751static void wq_watchdog_set_thresh(unsigned long thresh)
5752{
5753 wq_watchdog_thresh = 0;
5754 del_timer_sync(&wq_watchdog_timer);
5755
5756 if (thresh) {
5757 wq_watchdog_thresh = thresh;
5758 wq_watchdog_reset_touched();
5759 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5760 }
5761}
5762
5763static int wq_watchdog_param_set_thresh(const char *val,
5764 const struct kernel_param *kp)
5765{
5766 unsigned long thresh;
5767 int ret;
5768
5769 ret = kstrtoul(val, 0, &thresh);
5770 if (ret)
5771 return ret;
5772
5773 if (system_wq)
5774 wq_watchdog_set_thresh(thresh);
5775 else
5776 wq_watchdog_thresh = thresh;
5777
5778 return 0;
5779}
5780
5781static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5782 .set = wq_watchdog_param_set_thresh,
5783 .get = param_get_ulong,
5784};
5785
5786module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5787 0644);
5788
5789static void wq_watchdog_init(void)
5790{
Kees Cook5cd79d62017-10-04 16:27:00 -07005791 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005792 wq_watchdog_set_thresh(wq_watchdog_thresh);
5793}
5794
5795#else /* CONFIG_WQ_WATCHDOG */
5796
5797static inline void wq_watchdog_init(void) { }
5798
5799#endif /* CONFIG_WQ_WATCHDOG */
5800
Tejun Heobce90382013-04-01 11:23:32 -07005801static void __init wq_numa_init(void)
5802{
5803 cpumask_var_t *tbl;
5804 int node, cpu;
5805
Tejun Heobce90382013-04-01 11:23:32 -07005806 if (num_possible_nodes() <= 1)
5807 return;
5808
Tejun Heod55262c2013-04-01 11:23:38 -07005809 if (wq_disable_numa) {
5810 pr_info("workqueue: NUMA affinity support disabled\n");
5811 return;
5812 }
5813
Tejun Heo4c16bd32013-04-01 11:23:36 -07005814 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5815 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5816
Tejun Heobce90382013-04-01 11:23:32 -07005817 /*
5818 * We want masks of possible CPUs of each node which isn't readily
5819 * available. Build one from cpu_to_node() which should have been
5820 * fully initialized by now.
5821 */
Kees Cook6396bb22018-06-12 14:03:40 -07005822 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005823 BUG_ON(!tbl);
5824
5825 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005826 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005827 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005828
5829 for_each_possible_cpu(cpu) {
5830 node = cpu_to_node(cpu);
5831 if (WARN_ON(node == NUMA_NO_NODE)) {
5832 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5833 /* happens iff arch is bonkers, let's just proceed */
5834 return;
5835 }
5836 cpumask_set_cpu(cpu, tbl[node]);
5837 }
5838
5839 wq_numa_possible_cpumask = tbl;
5840 wq_numa_enabled = true;
5841}
5842
Tejun Heo3347fa02016-09-16 15:49:32 -04005843/**
5844 * workqueue_init_early - early init for workqueue subsystem
5845 *
5846 * This is the first half of two-staged workqueue subsystem initialization
5847 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5848 * idr are up. It sets up all the data structures and system workqueues
5849 * and allows early boot code to create workqueues and queue/cancel work
5850 * items. Actual work item execution starts only after kthreads can be
5851 * created and scheduled right before early initcalls.
5852 */
5853int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005854{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005855 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005856 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005857 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005858
Tejun Heoe904e6c2013-03-12 11:29:57 -07005859 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5860
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005861 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005862 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005863
Tejun Heoe904e6c2013-03-12 11:29:57 -07005864 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5865
Tejun Heo706026c2013-01-24 11:01:34 -08005866 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005867 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005868 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005869
Tejun Heo7a4e3442013-03-12 11:30:00 -07005870 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005871 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005872 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005873 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005874 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005875 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005876 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005877
Tejun Heo9daf9e62013-01-24 11:01:33 -08005878 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005879 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005880 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005881 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005882 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005883 }
5884
Tejun Heo8a2b7532013-09-05 12:30:04 -04005885 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005886 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5887 struct workqueue_attrs *attrs;
5888
5889 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005890 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005891 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005892
5893 /*
5894 * An ordered wq should have only one pwq as ordering is
5895 * guaranteed by max_active which is enforced by pwqs.
5896 * Turn off NUMA so that dfl_pwq is used for all nodes.
5897 */
5898 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5899 attrs->nice = std_nice[i];
5900 attrs->no_numa = true;
5901 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005902 }
5903
Tejun Heod320c032010-06-29 10:07:14 +02005904 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005905 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005906 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005907 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5908 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005909 system_freezable_wq = alloc_workqueue("events_freezable",
5910 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305911 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5912 WQ_POWER_EFFICIENT, 0);
5913 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5914 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5915 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005916 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305917 !system_unbound_wq || !system_freezable_wq ||
5918 !system_power_efficient_wq ||
5919 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005920
Tejun Heo3347fa02016-09-16 15:49:32 -04005921 return 0;
5922}
5923
5924/**
5925 * workqueue_init - bring workqueue subsystem fully online
5926 *
5927 * This is the latter half of two-staged workqueue subsystem initialization
5928 * and invoked as soon as kthreads can be created and scheduled.
5929 * Workqueues have been created and work items queued on them, but there
5930 * are no kworkers executing the work items yet. Populate the worker pools
5931 * with the initial workers and enable future kworker creations.
5932 */
5933int __init workqueue_init(void)
5934{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005935 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005936 struct worker_pool *pool;
5937 int cpu, bkt;
5938
Tejun Heo2186d9f2016-10-19 12:01:27 -04005939 /*
5940 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5941 * CPU to node mapping may not be available that early on some
5942 * archs such as power and arm64. As per-cpu pools created
5943 * previously could be missing node hint and unbound pools NUMA
5944 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005945 *
5946 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005947 */
5948 wq_numa_init();
5949
5950 mutex_lock(&wq_pool_mutex);
5951
5952 for_each_possible_cpu(cpu) {
5953 for_each_cpu_worker_pool(pool, cpu) {
5954 pool->node = cpu_to_node(cpu);
5955 }
5956 }
5957
Tejun Heo40c17f72018-01-08 05:38:37 -08005958 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005959 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005960 WARN(init_rescuer(wq),
5961 "workqueue: failed to create early rescuer for %s",
5962 wq->name);
5963 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005964
5965 mutex_unlock(&wq_pool_mutex);
5966
Tejun Heo3347fa02016-09-16 15:49:32 -04005967 /* create the initial workers */
5968 for_each_online_cpu(cpu) {
5969 for_each_cpu_worker_pool(pool, cpu) {
5970 pool->flags &= ~POOL_DISASSOCIATED;
5971 BUG_ON(!create_worker(pool));
5972 }
5973 }
5974
5975 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5976 BUG_ON(!create_worker(pool));
5977
5978 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005979 wq_watchdog_init();
5980
Suresh Siddha6ee05782010-07-30 14:57:37 -07005981 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005982}