blob: 56180c9286f50e01eb3f4420d030161d6971ed5b [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 Heo794b18bc2013-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 Heo974271c42012-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 Heo974271c42012-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/**
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100844 * wq_worker_running - a worker is running again
Tejun Heoe22bee72010-06-29 10:07:14 +0200845 * @task: task waking up
Tejun Heoe22bee72010-06-29 10:07:14 +0200846 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100847 * This function is called when a worker returns from schedule()
Tejun Heoe22bee72010-06-29 10:07:14 +0200848 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100849void wq_worker_running(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200850{
851 struct worker *worker = kthread_data(task);
852
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100853 if (!worker->sleeping)
854 return;
855 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800856 atomic_inc(&worker->pool->nr_running);
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100857 worker->sleeping = 0;
Tejun Heoe22bee72010-06-29 10:07:14 +0200858}
859
860/**
861 * wq_worker_sleeping - a worker is going to sleep
862 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200863 *
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100864 * This function is called from schedule() when a busy worker is
865 * going to sleep.
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 */
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100867void wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200868{
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100869 struct worker *next, *worker = kthread_data(task);
Tejun Heo111c2252013-01-17 17:16:24 -0800870 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200871
Tejun Heo111c2252013-01-17 17:16:24 -0800872 /*
873 * Rescuers, which may not have all the fields set up like normal
874 * workers, also reach here, let's not access anything before
875 * checking NOT_RUNNING.
876 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500877 if (worker->flags & WORKER_NOT_RUNNING)
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100878 return;
Tejun Heoe22bee72010-06-29 10:07:14 +0200879
Tejun Heo111c2252013-01-17 17:16:24 -0800880 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800881
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100882 if (WARN_ON_ONCE(worker->sleeping))
883 return;
884
885 worker->sleeping = 1;
886 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200887
888 /*
889 * The counterpart of the following dec_and_test, implied mb,
890 * worklist not empty test sequence is in insert_work().
891 * Please read comment there.
892 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700893 * NOT_RUNNING is clear. This means that we're bound to and
894 * running on the local cpu w/ rq lock held and preemption
895 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800896 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700897 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200898 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800899 if (atomic_dec_and_test(&pool->nr_running) &&
Thomas Gleixner6d25be52019-03-13 17:55:48 +0100900 !list_empty(&pool->worklist)) {
901 next = first_idle_worker(pool);
902 if (next)
903 wake_up_process(next->task);
904 }
905 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +0200906}
907
908/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800909 * wq_worker_last_func - retrieve worker's last work function
910 *
911 * Determine the last function a worker executed. This is called from
912 * the scheduler to get a worker's last known identity.
913 *
914 * CONTEXT:
915 * spin_lock_irq(rq->lock)
916 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800917 * This function is called during schedule() when a kworker is going
918 * to sleep. It's used by psi to identify aggregation workers during
919 * dequeuing, to allow periodic aggregation to shut-off when that
920 * worker is the last task in the system or cgroup to go to sleep.
921 *
922 * As this function doesn't involve any workqueue-related locking, it
923 * only returns stable values when called from inside the scheduler's
924 * queuing and dequeuing paths, when @task, which must be a kworker,
925 * is guaranteed to not be processing any works.
926 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800927 * Return:
928 * The last work function %current executed as a worker, NULL if it
929 * hasn't executed any work yet.
930 */
931work_func_t wq_worker_last_func(struct task_struct *task)
932{
933 struct worker *worker = kthread_data(task);
934
935 return worker->last_func;
936}
937
938/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200939 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200940 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200941 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200942 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800943 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200944 *
Tejun Heocb444762010-07-02 10:03:50 +0200945 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800946 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200947 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800948static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200949{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700950 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200951
Tejun Heocb444762010-07-02 10:03:50 +0200952 WARN_ON_ONCE(worker->task != current);
953
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800954 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200955 if ((flags & WORKER_NOT_RUNNING) &&
956 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800957 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200958 }
959
Tejun Heod302f012010-06-29 10:07:13 +0200960 worker->flags |= flags;
961}
962
963/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200964 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200965 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200966 * @flags: flags to clear
967 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200968 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200969 *
Tejun Heocb444762010-07-02 10:03:50 +0200970 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800971 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200972 */
973static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
974{
Tejun Heo63d95a92012-07-12 14:46:37 -0700975 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200976 unsigned int oflags = worker->flags;
977
Tejun Heocb444762010-07-02 10:03:50 +0200978 WARN_ON_ONCE(worker->task != current);
979
Tejun Heod302f012010-06-29 10:07:13 +0200980 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200981
Tejun Heo42c025f2011-01-11 15:58:49 +0100982 /*
983 * If transitioning out of NOT_RUNNING, increment nr_running. Note
984 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
985 * of multiple flags, not a single flag.
986 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200987 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
988 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800989 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200990}
991
992/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200993 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800994 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200995 * @work: work to find worker for
996 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800997 * Find a worker which is executing @work on @pool by searching
998 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800999 * to match, its current execution should match the address of @work and
1000 * its work function. This is to avoid unwanted dependency between
1001 * unrelated work executions through a work item being recycled while still
1002 * being executed.
1003 *
1004 * This is a bit tricky. A work item may be freed once its execution
1005 * starts and nothing prevents the freed area from being recycled for
1006 * another work item. If the same work item address ends up being reused
1007 * before the original execution finishes, workqueue will identify the
1008 * recycled work item as currently executing and make it wait until the
1009 * current execution finishes, introducing an unwanted dependency.
1010 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001011 * This function checks the work item address and work function to avoid
1012 * false positives. Note that this isn't complete as one may construct a
1013 * work function which can introduce dependency onto itself through a
1014 * recycled work item. Well, if somebody wants to shoot oneself in the
1015 * foot that badly, there's only so much we can do, and if such deadlock
1016 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001017 *
1018 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001019 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001020 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001021 * Return:
1022 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001023 * otherwise.
1024 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001025static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001026 struct work_struct *work)
1027{
Sasha Levin42f85702012-12-17 10:01:23 -05001028 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001029
Sasha Levinb67bfe02013-02-27 17:06:00 -08001030 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001031 (unsigned long)work)
1032 if (worker->current_work == work &&
1033 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001034 return worker;
1035
1036 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001037}
1038
1039/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001040 * move_linked_works - move linked works to a list
1041 * @work: start of series of works to be scheduled
1042 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301043 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001044 *
1045 * Schedule linked works starting from @work to @head. Work series to
1046 * be scheduled starts at @work and includes any consecutive work with
1047 * WORK_STRUCT_LINKED set in its predecessor.
1048 *
1049 * If @nextp is not NULL, it's updated to point to the next work of
1050 * the last scheduled work. This allows move_linked_works() to be
1051 * nested inside outer list_for_each_entry_safe().
1052 *
1053 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001054 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001055 */
1056static void move_linked_works(struct work_struct *work, struct list_head *head,
1057 struct work_struct **nextp)
1058{
1059 struct work_struct *n;
1060
1061 /*
1062 * Linked worklist will always end before the end of the list,
1063 * use NULL for list head.
1064 */
1065 list_for_each_entry_safe_from(work, n, NULL, entry) {
1066 list_move_tail(&work->entry, head);
1067 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1068 break;
1069 }
1070
1071 /*
1072 * If we're already inside safe list traversal and have moved
1073 * multiple works to the scheduled queue, the next position
1074 * needs to be updated.
1075 */
1076 if (nextp)
1077 *nextp = n;
1078}
1079
Tejun Heo8864b4e2013-03-12 11:30:04 -07001080/**
1081 * get_pwq - get an extra reference on the specified pool_workqueue
1082 * @pwq: pool_workqueue to get
1083 *
1084 * Obtain an extra reference on @pwq. The caller should guarantee that
1085 * @pwq has positive refcnt and be holding the matching pool->lock.
1086 */
1087static void get_pwq(struct pool_workqueue *pwq)
1088{
1089 lockdep_assert_held(&pwq->pool->lock);
1090 WARN_ON_ONCE(pwq->refcnt <= 0);
1091 pwq->refcnt++;
1092}
1093
1094/**
1095 * put_pwq - put a pool_workqueue reference
1096 * @pwq: pool_workqueue to put
1097 *
1098 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1099 * destruction. The caller should be holding the matching pool->lock.
1100 */
1101static void put_pwq(struct pool_workqueue *pwq)
1102{
1103 lockdep_assert_held(&pwq->pool->lock);
1104 if (likely(--pwq->refcnt))
1105 return;
1106 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1107 return;
1108 /*
1109 * @pwq can't be released under pool->lock, bounce to
1110 * pwq_unbound_release_workfn(). This never recurses on the same
1111 * pool->lock as this path is taken only for unbound workqueues and
1112 * the release work item is scheduled on a per-cpu workqueue. To
1113 * avoid lockdep warning, unbound pool->locks are given lockdep
1114 * subclass of 1 in get_unbound_pool().
1115 */
1116 schedule_work(&pwq->unbound_release_work);
1117}
1118
Tejun Heodce90d42013-04-01 11:23:35 -07001119/**
1120 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1121 * @pwq: pool_workqueue to put (can be %NULL)
1122 *
1123 * put_pwq() with locking. This function also allows %NULL @pwq.
1124 */
1125static void put_pwq_unlocked(struct pool_workqueue *pwq)
1126{
1127 if (pwq) {
1128 /*
1129 * As both pwqs and pools are sched-RCU protected, the
1130 * following lock operations are safe.
1131 */
1132 spin_lock_irq(&pwq->pool->lock);
1133 put_pwq(pwq);
1134 spin_unlock_irq(&pwq->pool->lock);
1135 }
1136}
1137
Tejun Heo112202d2013-02-13 19:29:12 -08001138static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001139{
Tejun Heo112202d2013-02-13 19:29:12 -08001140 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001141
1142 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001143 if (list_empty(&pwq->pool->worklist))
1144 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001145 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001146 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001147 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001148}
1149
Tejun Heo112202d2013-02-13 19:29:12 -08001150static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001151{
Tejun Heo112202d2013-02-13 19:29:12 -08001152 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001153 struct work_struct, entry);
1154
Tejun Heo112202d2013-02-13 19:29:12 -08001155 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001156}
1157
Tejun Heobf4ede02012-08-03 10:30:46 -07001158/**
Tejun Heo112202d2013-02-13 19:29:12 -08001159 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1160 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001161 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001162 *
1163 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001164 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001165 *
1166 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001167 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001168 */
Tejun Heo112202d2013-02-13 19:29:12 -08001169static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001170{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001171 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001172 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001173 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001174
Tejun Heo112202d2013-02-13 19:29:12 -08001175 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001176
Tejun Heo112202d2013-02-13 19:29:12 -08001177 pwq->nr_active--;
1178 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001179 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001180 if (pwq->nr_active < pwq->max_active)
1181 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001182 }
1183
1184 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001185 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001186 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001187
1188 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001189 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001190 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001191
Tejun Heo112202d2013-02-13 19:29:12 -08001192 /* this pwq is done, clear flush_color */
1193 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001194
1195 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001196 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001197 * will handle the rest.
1198 */
Tejun Heo112202d2013-02-13 19:29:12 -08001199 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1200 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001201out_put:
1202 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001203}
1204
Tejun Heo36e227d2012-08-03 10:30:46 -07001205/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001206 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001207 * @work: work item to steal
1208 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001209 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001210 *
1211 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001212 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001213 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001214 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001215 * 1 if @work was pending and we successfully stole PENDING
1216 * 0 if @work was idle and we claimed PENDING
1217 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001218 * -ENOENT if someone else is canceling @work, this state may persist
1219 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001220 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001221 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001222 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001223 * interrupted while holding PENDING and @work off queue, irq must be
1224 * disabled on entry. This, combined with delayed_work->timer being
1225 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001226 *
1227 * On successful return, >= 0, irq is disabled and the caller is
1228 * responsible for releasing it using local_irq_restore(*@flags).
1229 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001230 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001231 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001232static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1233 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001234{
Tejun Heod565ed62013-01-24 11:01:33 -08001235 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001236 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001237
Tejun Heobbb68df2012-08-03 10:30:46 -07001238 local_irq_save(*flags);
1239
Tejun Heo36e227d2012-08-03 10:30:46 -07001240 /* try to steal the timer if it exists */
1241 if (is_dwork) {
1242 struct delayed_work *dwork = to_delayed_work(work);
1243
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001244 /*
1245 * dwork->timer is irqsafe. If del_timer() fails, it's
1246 * guaranteed that the timer is not queued anywhere and not
1247 * running on the local CPU.
1248 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001249 if (likely(del_timer(&dwork->timer)))
1250 return 1;
1251 }
1252
1253 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001254 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1255 return 0;
1256
1257 /*
1258 * The queueing is in progress, or it is already queued. Try to
1259 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1260 */
Tejun Heod565ed62013-01-24 11:01:33 -08001261 pool = get_work_pool(work);
1262 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001263 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001264
Tejun Heod565ed62013-01-24 11:01:33 -08001265 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001266 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001267 * work->data is guaranteed to point to pwq only while the work
1268 * item is queued on pwq->wq, and both updating work->data to point
1269 * to pwq on queueing and to pool on dequeueing are done under
1270 * pwq->pool->lock. This in turn guarantees that, if work->data
1271 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001272 * item is currently queued on that pool.
1273 */
Tejun Heo112202d2013-02-13 19:29:12 -08001274 pwq = get_work_pwq(work);
1275 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001276 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001277
Tejun Heo16062832013-02-06 18:04:53 -08001278 /*
1279 * A delayed work item cannot be grabbed directly because
1280 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001281 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001282 * management later on and cause stall. Make sure the work
1283 * item is activated before grabbing.
1284 */
1285 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001286 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001287
Tejun Heo16062832013-02-06 18:04:53 -08001288 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001289 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001290
Tejun Heo112202d2013-02-13 19:29:12 -08001291 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001292 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001293
Tejun Heo16062832013-02-06 18:04:53 -08001294 spin_unlock(&pool->lock);
1295 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001296 }
Tejun Heod565ed62013-01-24 11:01:33 -08001297 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001298fail:
1299 local_irq_restore(*flags);
1300 if (work_is_canceling(work))
1301 return -ENOENT;
1302 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001303 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001304}
1305
1306/**
Tejun Heo706026c2013-01-24 11:01:34 -08001307 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001308 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001309 * @work: work to insert
1310 * @head: insertion point
1311 * @extra_flags: extra WORK_STRUCT_* flags to set
1312 *
Tejun Heo112202d2013-02-13 19:29:12 -08001313 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001314 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001315 *
1316 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001317 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001318 */
Tejun Heo112202d2013-02-13 19:29:12 -08001319static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1320 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001321{
Tejun Heo112202d2013-02-13 19:29:12 -08001322 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001323
Tejun Heo4690c4a2010-06-29 10:07:10 +02001324 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001325 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001326 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001327 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001328
1329 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001330 * Ensure either wq_worker_sleeping() sees the above
1331 * list_add_tail() or we see zero nr_running to avoid workers lying
1332 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001333 */
1334 smp_mb();
1335
Tejun Heo63d95a92012-07-12 14:46:37 -07001336 if (__need_more_worker(pool))
1337 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001338}
1339
Tejun Heoc8efcc22010-12-20 19:32:04 +01001340/*
1341 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001342 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001343 */
1344static bool is_chained_work(struct workqueue_struct *wq)
1345{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001346 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001347
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001348 worker = current_wq_worker();
1349 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001350 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001351 * I'm @worker, it's safe to dereference it without locking.
1352 */
Tejun Heo112202d2013-02-13 19:29:12 -08001353 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001354}
1355
Mike Galbraithef5571802016-02-09 17:59:38 -05001356/*
1357 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1358 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1359 * avoid perturbing sensitive tasks.
1360 */
1361static int wq_select_unbound_cpu(int cpu)
1362{
Tejun Heof303fccb2016-02-09 17:59:38 -05001363 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001364 int new_cpu;
1365
Tejun Heof303fccb2016-02-09 17:59:38 -05001366 if (likely(!wq_debug_force_rr_cpu)) {
1367 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1368 return cpu;
1369 } else if (!printed_dbg_warning) {
1370 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1371 printed_dbg_warning = true;
1372 }
1373
Mike Galbraithef5571802016-02-09 17:59:38 -05001374 if (cpumask_empty(wq_unbound_cpumask))
1375 return cpu;
1376
1377 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1378 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1379 if (unlikely(new_cpu >= nr_cpu_ids)) {
1380 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1381 if (unlikely(new_cpu >= nr_cpu_ids))
1382 return cpu;
1383 }
1384 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1385
1386 return new_cpu;
1387}
1388
Tejun Heod84ff052013-03-12 11:29:59 -07001389static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 struct work_struct *work)
1391{
Tejun Heo112202d2013-02-13 19:29:12 -08001392 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001393 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001394 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001395 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001396 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001397
1398 /*
1399 * While a work item is PENDING && off queue, a task trying to
1400 * steal the PENDING will busy-loop waiting for it to either get
1401 * queued or lose PENDING. Grabbing PENDING and queueing should
1402 * happen with IRQ disabled.
1403 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001404 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001406 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001407
Li Bin9ef28a72013-09-09 13:13:58 +08001408 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001409 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001410 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001411 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001412retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001413 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001414 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001415
Tejun Heoc9178082013-03-12 11:30:04 -07001416 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001417 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001418 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001419 else
1420 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001421
Tejun Heoc9178082013-03-12 11:30:04 -07001422 /*
1423 * If @work was previously on a different pool, it might still be
1424 * running there, in which case the work needs to be queued on that
1425 * pool to guarantee non-reentrancy.
1426 */
1427 last_pool = get_work_pool(work);
1428 if (last_pool && last_pool != pwq->pool) {
1429 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001430
Tejun Heoc9178082013-03-12 11:30:04 -07001431 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001432
Tejun Heoc9178082013-03-12 11:30:04 -07001433 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001434
Tejun Heoc9178082013-03-12 11:30:04 -07001435 if (worker && worker->current_pwq->wq == wq) {
1436 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001437 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001438 /* meh... not running there, queue here */
1439 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001440 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001441 }
Tejun Heof3421792010-07-02 10:03:51 +02001442 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001443 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001444 }
1445
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001446 /*
1447 * pwq is determined and locked. For unbound pools, we could have
1448 * raced with pwq release and it could already be dead. If its
1449 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001450 * without another pwq replacing it in the numa_pwq_tbl or while
1451 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001452 * make forward-progress.
1453 */
1454 if (unlikely(!pwq->refcnt)) {
1455 if (wq->flags & WQ_UNBOUND) {
1456 spin_unlock(&pwq->pool->lock);
1457 cpu_relax();
1458 goto retry;
1459 }
1460 /* oops */
1461 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1462 wq->name, cpu);
1463 }
1464
Tejun Heo112202d2013-02-13 19:29:12 -08001465 /* pwq determined, queue */
1466 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001467
Dan Carpenterf5b25522012-04-13 22:06:58 +03001468 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001469 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001470 return;
1471 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001472
Tejun Heo112202d2013-02-13 19:29:12 -08001473 pwq->nr_in_flight[pwq->work_color]++;
1474 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001475
Tejun Heo112202d2013-02-13 19:29:12 -08001476 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001477 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001478 pwq->nr_active++;
1479 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001480 if (list_empty(worklist))
1481 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001482 } else {
1483 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001484 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001485 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001486
Tejun Heo112202d2013-02-13 19:29:12 -08001487 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001488
Tejun Heo112202d2013-02-13 19:29:12 -08001489 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490}
1491
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001492/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001493 * queue_work_on - queue work on specific cpu
1494 * @cpu: CPU number to execute work on
1495 * @wq: workqueue to use
1496 * @work: work to queue
1497 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001498 * We queue the work to a specific CPU, the caller must ensure it
1499 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001500 *
1501 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001502 */
Tejun Heod4283e92012-08-03 10:30:44 -07001503bool queue_work_on(int cpu, struct workqueue_struct *wq,
1504 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001505{
Tejun Heod4283e92012-08-03 10:30:44 -07001506 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001507 unsigned long flags;
1508
1509 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001510
Tejun Heo22df02b2010-06-29 10:07:10 +02001511 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001512 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001513 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001514 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001515
1516 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001517 return ret;
1518}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001519EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001520
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001521/**
1522 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1523 * @node: NUMA node ID that we want to select a CPU from
1524 *
1525 * This function will attempt to find a "random" cpu available on a given
1526 * node. If there are no CPUs available on the given node it will return
1527 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1528 * available CPU if we need to schedule this work.
1529 */
1530static int workqueue_select_cpu_near(int node)
1531{
1532 int cpu;
1533
1534 /* No point in doing this if NUMA isn't enabled for workqueues */
1535 if (!wq_numa_enabled)
1536 return WORK_CPU_UNBOUND;
1537
1538 /* Delay binding to CPU if node is not valid or online */
1539 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1540 return WORK_CPU_UNBOUND;
1541
1542 /* Use local node/cpu if we are already there */
1543 cpu = raw_smp_processor_id();
1544 if (node == cpu_to_node(cpu))
1545 return cpu;
1546
1547 /* Use "random" otherwise know as "first" online CPU of node */
1548 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1549
1550 /* If CPU is valid return that, otherwise just defer */
1551 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1552}
1553
1554/**
1555 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1556 * @node: NUMA node that we are targeting the work for
1557 * @wq: workqueue to use
1558 * @work: work to queue
1559 *
1560 * We queue the work to a "random" CPU within a given NUMA node. The basic
1561 * idea here is to provide a way to somehow associate work with a given
1562 * NUMA node.
1563 *
1564 * This function will only make a best effort attempt at getting this onto
1565 * the right NUMA node. If no node is requested or the requested node is
1566 * offline then we just fall back to standard queue_work behavior.
1567 *
1568 * Currently the "random" CPU ends up being the first available CPU in the
1569 * intersection of cpu_online_mask and the cpumask of the node, unless we
1570 * are running on the node. In that case we just use the current CPU.
1571 *
1572 * Return: %false if @work was already on a queue, %true otherwise.
1573 */
1574bool queue_work_node(int node, struct workqueue_struct *wq,
1575 struct work_struct *work)
1576{
1577 unsigned long flags;
1578 bool ret = false;
1579
1580 /*
1581 * This current implementation is specific to unbound workqueues.
1582 * Specifically we only return the first available CPU for a given
1583 * node instead of cycling through individual CPUs within the node.
1584 *
1585 * If this is used with a per-cpu workqueue then the logic in
1586 * workqueue_select_cpu_near would need to be updated to allow for
1587 * some round robin type logic.
1588 */
1589 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1590
1591 local_irq_save(flags);
1592
1593 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1594 int cpu = workqueue_select_cpu_near(node);
1595
1596 __queue_work(cpu, wq, work);
1597 ret = true;
1598 }
1599
1600 local_irq_restore(flags);
1601 return ret;
1602}
1603EXPORT_SYMBOL_GPL(queue_work_node);
1604
Kees Cook8c20feb2017-10-04 16:27:07 -07001605void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606{
Kees Cook8c20feb2017-10-04 16:27:07 -07001607 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001609 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001610 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001612EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001614static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1615 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001617 struct timer_list *timer = &dwork->timer;
1618 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Tejun Heo637fdba2017-03-06 15:33:42 -05001620 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001621 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001622 WARN_ON_ONCE(timer_pending(timer));
1623 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001624
Tejun Heo8852aac2012-12-01 16:23:42 -08001625 /*
1626 * If @delay is 0, queue @dwork->work immediately. This is for
1627 * both optimization and correctness. The earliest @timer can
1628 * expire is on the closest next tick and delayed_work users depend
1629 * on that there's no such delay when @delay is 0.
1630 */
1631 if (!delay) {
1632 __queue_work(cpu, wq, &dwork->work);
1633 return;
1634 }
1635
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001636 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001637 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001638 timer->expires = jiffies + delay;
1639
Tejun Heo041bd122016-02-09 16:11:26 -05001640 if (unlikely(cpu != WORK_CPU_UNBOUND))
1641 add_timer_on(timer, cpu);
1642 else
1643 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644}
1645
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001646/**
1647 * queue_delayed_work_on - queue work on specific CPU after delay
1648 * @cpu: CPU number to execute work on
1649 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001650 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001651 * @delay: number of jiffies to wait before queueing
1652 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001653 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001654 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1655 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001656 */
Tejun Heod4283e92012-08-03 10:30:44 -07001657bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1658 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001659{
David Howells52bad642006-11-22 14:54:01 +00001660 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001661 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001662 unsigned long flags;
1663
1664 /* read the comment in __queue_work() */
1665 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001666
Tejun Heo22df02b2010-06-29 10:07:10 +02001667 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001668 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001669 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001670 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001671
1672 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001673 return ret;
1674}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001675EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Tejun Heoc8e55f32010-06-29 10:07:12 +02001677/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001678 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1679 * @cpu: CPU number to execute work on
1680 * @wq: workqueue to use
1681 * @dwork: work to queue
1682 * @delay: number of jiffies to wait before queueing
1683 *
1684 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1685 * modify @dwork's timer so that it expires after @delay. If @delay is
1686 * zero, @work is guaranteed to be scheduled immediately regardless of its
1687 * current state.
1688 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001689 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001690 * pending and its timer was modified.
1691 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001692 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001693 * See try_to_grab_pending() for details.
1694 */
1695bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1696 struct delayed_work *dwork, unsigned long delay)
1697{
1698 unsigned long flags;
1699 int ret;
1700
1701 do {
1702 ret = try_to_grab_pending(&dwork->work, true, &flags);
1703 } while (unlikely(ret == -EAGAIN));
1704
1705 if (likely(ret >= 0)) {
1706 __queue_delayed_work(cpu, wq, dwork, delay);
1707 local_irq_restore(flags);
1708 }
1709
1710 /* -ENOENT from try_to_grab_pending() becomes %true */
1711 return ret;
1712}
1713EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1714
Tejun Heo05f0fe62018-03-14 12:45:13 -07001715static void rcu_work_rcufn(struct rcu_head *rcu)
1716{
1717 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1718
1719 /* read the comment in __queue_work() */
1720 local_irq_disable();
1721 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1722 local_irq_enable();
1723}
1724
1725/**
1726 * queue_rcu_work - queue work after a RCU grace period
1727 * @wq: workqueue to use
1728 * @rwork: work to queue
1729 *
1730 * Return: %false if @rwork was already pending, %true otherwise. Note
1731 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001732 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001733 * execution may happen before a full RCU grace period has passed.
1734 */
1735bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1736{
1737 struct work_struct *work = &rwork->work;
1738
1739 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1740 rwork->wq = wq;
1741 call_rcu(&rwork->rcu, rcu_work_rcufn);
1742 return true;
1743 }
1744
1745 return false;
1746}
1747EXPORT_SYMBOL(queue_rcu_work);
1748
Tejun Heo8376fe22012-08-03 10:30:47 -07001749/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001750 * worker_enter_idle - enter idle state
1751 * @worker: worker which is entering idle state
1752 *
1753 * @worker is entering idle state. Update stats and idle timer if
1754 * necessary.
1755 *
1756 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001757 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001758 */
1759static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001761 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
Tejun Heo6183c002013-03-12 11:29:57 -07001763 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1764 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1765 (worker->hentry.next || worker->hentry.pprev)))
1766 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
Lai Jiangshan051e1852014-07-22 13:03:02 +08001768 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001769 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001770 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001771 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001772
Tejun Heoc8e55f32010-06-29 10:07:12 +02001773 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001774 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001775
Tejun Heo628c78e2012-07-17 12:39:27 -07001776 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1777 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001778
Tejun Heo544ecf32012-05-14 15:04:50 -07001779 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001780 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001781 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001782 * nr_running, the warning may trigger spuriously. Check iff
1783 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001784 */
Tejun Heo24647572013-01-24 11:01:33 -08001785 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001786 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001787 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
1789
Tejun Heoc8e55f32010-06-29 10:07:12 +02001790/**
1791 * worker_leave_idle - leave idle state
1792 * @worker: worker which is leaving idle state
1793 *
1794 * @worker is leaving idle state. Update stats.
1795 *
1796 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001797 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001798 */
1799static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001801 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Tejun Heo6183c002013-03-12 11:29:57 -07001803 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1804 return;
Tejun Heod302f012010-06-29 10:07:13 +02001805 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001806 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001807 list_del_init(&worker->entry);
1808}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001810static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001811{
1812 struct worker *worker;
1813
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001814 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001815 if (worker) {
1816 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001817 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001818 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001819 /* on creation a worker is in !idle && prep state */
1820 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001821 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001822 return worker;
1823}
1824
1825/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001826 * worker_attach_to_pool() - attach a worker to a pool
1827 * @worker: worker to be attached
1828 * @pool: the target pool
1829 *
1830 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1831 * cpu-binding of @worker are kept coordinated with the pool across
1832 * cpu-[un]hotplugs.
1833 */
1834static void worker_attach_to_pool(struct worker *worker,
1835 struct worker_pool *pool)
1836{
Tejun Heo1258fae2018-05-18 08:47:13 -07001837 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001838
1839 /*
1840 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1841 * online CPUs. It'll be re-applied when any of the CPUs come up.
1842 */
1843 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1844
1845 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001846 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1847 * stable across this function. See the comments above the flag
1848 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001849 */
1850 if (pool->flags & POOL_DISASSOCIATED)
1851 worker->flags |= WORKER_UNBOUND;
1852
1853 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001854 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001855
Tejun Heo1258fae2018-05-18 08:47:13 -07001856 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001857}
1858
1859/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001860 * worker_detach_from_pool() - detach a worker from its pool
1861 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001862 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001863 * Undo the attaching which had been done in worker_attach_to_pool(). The
1864 * caller worker shouldn't access to the pool after detached except it has
1865 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001866 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001867static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001868{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001869 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001870 struct completion *detach_completion = NULL;
1871
Tejun Heo1258fae2018-05-18 08:47:13 -07001872 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001873
Lai Jiangshanda028462014-05-20 17:46:31 +08001874 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001875 worker->pool = NULL;
1876
Lai Jiangshanda028462014-05-20 17:46:31 +08001877 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001878 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001879 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001880
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001881 /* clear leftover flags without pool->lock after it is detached */
1882 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1883
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001884 if (detach_completion)
1885 complete(detach_completion);
1886}
1887
1888/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001889 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001890 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001891 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001892 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001893 *
1894 * CONTEXT:
1895 * Might sleep. Does GFP_KERNEL allocations.
1896 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001897 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001898 * Pointer to the newly created worker.
1899 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001900static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001901{
Tejun Heoc34056a2010-06-29 10:07:11 +02001902 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001903 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001904 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001905
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001906 /* ID is needed to determine kthread name */
1907 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001908 if (id < 0)
1909 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001910
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001911 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001912 if (!worker)
1913 goto fail;
1914
Tejun Heoc34056a2010-06-29 10:07:11 +02001915 worker->id = id;
1916
Tejun Heo29c91e92013-03-12 11:30:03 -07001917 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001918 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1919 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001920 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001921 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1922
Tejun Heof3f90ad2013-04-01 11:23:34 -07001923 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001924 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001925 if (IS_ERR(worker->task))
1926 goto fail;
1927
Oleg Nesterov91151222013-11-14 12:56:18 +01001928 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001929 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001930
Lai Jiangshanda028462014-05-20 17:46:31 +08001931 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001932 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001933
Lai Jiangshan051e1852014-07-22 13:03:02 +08001934 /* start the newly created worker */
1935 spin_lock_irq(&pool->lock);
1936 worker->pool->nr_workers++;
1937 worker_enter_idle(worker);
1938 wake_up_process(worker->task);
1939 spin_unlock_irq(&pool->lock);
1940
Tejun Heoc34056a2010-06-29 10:07:11 +02001941 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001942
Tejun Heoc34056a2010-06-29 10:07:11 +02001943fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001944 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001945 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001946 kfree(worker);
1947 return NULL;
1948}
1949
1950/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001951 * destroy_worker - destroy a workqueue worker
1952 * @worker: worker to be destroyed
1953 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001954 * Destroy @worker and adjust @pool stats accordingly. The worker should
1955 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001956 *
1957 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001958 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001959 */
1960static void destroy_worker(struct worker *worker)
1961{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001962 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001963
Tejun Heocd549682013-03-13 19:47:39 -07001964 lockdep_assert_held(&pool->lock);
1965
Tejun Heoc34056a2010-06-29 10:07:11 +02001966 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001967 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001968 WARN_ON(!list_empty(&worker->scheduled)) ||
1969 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001970 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001971
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001972 pool->nr_workers--;
1973 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001974
Tejun Heoc8e55f32010-06-29 10:07:12 +02001975 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001976 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001977 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001978}
1979
Kees Cook32a6c722017-10-16 15:58:25 -07001980static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001981{
Kees Cook32a6c722017-10-16 15:58:25 -07001982 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001983
Tejun Heod565ed62013-01-24 11:01:33 -08001984 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001985
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001986 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001987 struct worker *worker;
1988 unsigned long expires;
1989
1990 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001991 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001992 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1993
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001994 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001995 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001996 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001998
1999 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 }
2001
Tejun Heod565ed62013-01-24 11:01:33 -08002002 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002003}
2004
Tejun Heo493a1722013-03-12 11:29:59 -07002005static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002006{
Tejun Heo112202d2013-02-13 19:29:12 -08002007 struct pool_workqueue *pwq = get_work_pwq(work);
2008 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002009
Tejun Heo2e109a22013-03-13 19:47:40 -07002010 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002011
Tejun Heo493008a2013-03-12 11:30:03 -07002012 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002013 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002014
2015 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002016 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002017 /*
2018 * If @pwq is for an unbound wq, its base ref may be put at
2019 * any time due to an attribute change. Pin @pwq until the
2020 * rescuer is done with it.
2021 */
2022 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002023 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002024 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002025 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002026}
2027
Kees Cook32a6c722017-10-16 15:58:25 -07002028static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002029{
Kees Cook32a6c722017-10-16 15:58:25 -07002030 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002031 struct work_struct *work;
2032
Tejun Heob2d82902014-12-08 12:39:16 -05002033 spin_lock_irq(&pool->lock);
2034 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002035
Tejun Heo63d95a92012-07-12 14:46:37 -07002036 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002037 /*
2038 * We've been trying to create a new worker but
2039 * haven't been successful. We might be hitting an
2040 * allocation deadlock. Send distress signals to
2041 * rescuers.
2042 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002043 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002044 send_mayday(work);
2045 }
2046
Tejun Heob2d82902014-12-08 12:39:16 -05002047 spin_unlock(&wq_mayday_lock);
2048 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002049
Tejun Heo63d95a92012-07-12 14:46:37 -07002050 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002051}
2052
2053/**
2054 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002055 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002056 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002057 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002058 * have at least one idle worker on return from this function. If
2059 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002060 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002061 * possible allocation deadlock.
2062 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002063 * On return, need_to_create_worker() is guaranteed to be %false and
2064 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002065 *
2066 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08002067 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002068 * multiple times. Does GFP_KERNEL allocations. Called only from
2069 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002070 */
Tejun Heo29187a92015-01-16 14:21:16 -05002071static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002072__releases(&pool->lock)
2073__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002074{
Tejun Heoe22bee72010-06-29 10:07:14 +02002075restart:
Tejun Heod565ed62013-01-24 11:01:33 -08002076 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002077
Tejun Heoe22bee72010-06-29 10:07:14 +02002078 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002079 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002080
2081 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002082 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002083 break;
2084
Lai Jiangshane212f362014-06-03 15:32:17 +08002085 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002086
Tejun Heo63d95a92012-07-12 14:46:37 -07002087 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002088 break;
2089 }
2090
Tejun Heo63d95a92012-07-12 14:46:37 -07002091 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08002092 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002093 /*
2094 * This is necessary even after a new worker was just successfully
2095 * created as @pool->lock was dropped and the new worker might have
2096 * already become busy.
2097 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002098 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002099 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002100}
2101
2102/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002103 * manage_workers - manage worker pool
2104 * @worker: self
2105 *
Tejun Heo706026c2013-01-24 11:01:34 -08002106 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002107 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002108 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002109 *
2110 * The caller can safely start processing works on false return. On
2111 * true return, it's guaranteed that need_to_create_worker() is false
2112 * and may_start_working() is true.
2113 *
2114 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002115 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002116 * multiple times. Does GFP_KERNEL allocations.
2117 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002118 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002119 * %false if the pool doesn't need management and the caller can safely
2120 * start processing works, %true if management function was performed and
2121 * the conditions that the caller verified before calling the function may
2122 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002123 */
2124static bool manage_workers(struct worker *worker)
2125{
Tejun Heo63d95a92012-07-12 14:46:37 -07002126 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002127
Tejun Heo692b4822017-10-09 08:04:13 -07002128 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002129 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002130
2131 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002132 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002133
Tejun Heo29187a92015-01-16 14:21:16 -05002134 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002135
Tejun Heo2607d7a2015-03-09 09:22:28 -04002136 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002137 pool->flags &= ~POOL_MANAGER_ACTIVE;
2138 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002139 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002140}
2141
Tejun Heoa62428c2010-06-29 10:07:10 +02002142/**
2143 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002144 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002145 * @work: work to process
2146 *
2147 * Process @work. This function contains all the logics necessary to
2148 * process a single work including synchronization against and
2149 * interaction with other workers on the same cpu, queueing and
2150 * flushing. As long as context requirement is met, any worker can
2151 * call this function to process a work.
2152 *
2153 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002154 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002155 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002156static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002157__releases(&pool->lock)
2158__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002159{
Tejun Heo112202d2013-02-13 19:29:12 -08002160 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002161 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002162 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002163 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002164 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002165#ifdef CONFIG_LOCKDEP
2166 /*
2167 * It is permissible to free the struct work_struct from
2168 * inside the function that is called from it, this we need to
2169 * take into account for lockdep too. To avoid bogus "held
2170 * lock freed" warnings as well as problems when looking into
2171 * work->lockdep_map, make a copy and use that here.
2172 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002173 struct lockdep_map lockdep_map;
2174
2175 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002176#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002177 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002178 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002179 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002180
Tejun Heo7e116292010-06-29 10:07:13 +02002181 /*
2182 * A single work shouldn't be executed concurrently by
2183 * multiple workers on a single cpu. Check whether anyone is
2184 * already processing the work. If so, defer the work to the
2185 * currently executing one.
2186 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002187 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002188 if (unlikely(collision)) {
2189 move_linked_works(work, &collision->scheduled, NULL);
2190 return;
2191 }
2192
Tejun Heo8930cab2012-08-03 10:30:45 -07002193 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002194 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002195 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002196 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002197 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002198 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002199 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002200
Tejun Heo8bf89592018-05-18 08:47:13 -07002201 /*
2202 * Record wq name for cmdline and debug reporting, may get
2203 * overridden through set_worker_desc().
2204 */
2205 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2206
Tejun Heoa62428c2010-06-29 10:07:10 +02002207 list_del_init(&work->entry);
2208
Tejun Heo649027d2010-06-29 10:07:14 +02002209 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002210 * CPU intensive works don't participate in concurrency management.
2211 * They're the scheduler's responsibility. This takes @worker out
2212 * of concurrency management and the next code block will chain
2213 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002214 */
2215 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002216 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002217
Tejun Heo974271c42012-07-12 14:46:37 -07002218 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002219 * Wake up another worker if necessary. The condition is always
2220 * false for normal per-cpu workers since nr_running would always
2221 * be >= 1 at this point. This is used to chain execution of the
2222 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002223 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002224 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002225 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002226 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002227
Tejun Heo8930cab2012-08-03 10:30:45 -07002228 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002229 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002230 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002231 * PENDING and queued state changes happen together while IRQ is
2232 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002233 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002234 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002235
Tejun Heod565ed62013-01-24 11:01:33 -08002236 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002237
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002238 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002239 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002240 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002241 * Strictly speaking we should mark the invariant state without holding
2242 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002243 *
2244 * However, that would result in:
2245 *
2246 * A(W1)
2247 * WFC(C)
2248 * A(W1)
2249 * C(C)
2250 *
2251 * Which would create W1->C->W1 dependencies, even though there is no
2252 * actual deadlock possible. There are two solutions, using a
2253 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002254 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002255 * these locks.
2256 *
2257 * AFAICT there is no possible deadlock scenario between the
2258 * flush_work() and complete() primitives (except for single-threaded
2259 * workqueues), so hiding them isn't a problem.
2260 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002261 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002262 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002263 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002264 /*
2265 * While we must be careful to not use "work" after this, the trace
2266 * point will only record its address.
2267 */
2268 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002269 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002270 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002271
2272 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002273 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2274 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002275 current->comm, preempt_count(), task_pid_nr(current),
2276 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002277 debug_show_held_locks(current);
2278 dump_stack();
2279 }
2280
Tejun Heob22ce272013-08-28 17:33:37 -04002281 /*
2282 * The following prevents a kworker from hogging CPU on !PREEMPT
2283 * kernels, where a requeueing work item waiting for something to
2284 * happen could deadlock with stop_machine as such work item could
2285 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002286 * stop_machine. At the same time, report a quiescent RCU state so
2287 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002288 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002289 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002290
Tejun Heod565ed62013-01-24 11:01:33 -08002291 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002292
Tejun Heofb0e7be2010-06-29 10:07:15 +02002293 /* clear cpu intensive status */
2294 if (unlikely(cpu_intensive))
2295 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2296
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002297 /* tag the worker for identification in schedule() */
2298 worker->last_func = worker->current_func;
2299
Tejun Heoa62428c2010-06-29 10:07:10 +02002300 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002301 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002302 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002303 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002304 worker->current_pwq = NULL;
2305 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002306}
2307
Tejun Heoaffee4b2010-06-29 10:07:12 +02002308/**
2309 * process_scheduled_works - process scheduled works
2310 * @worker: self
2311 *
2312 * Process all scheduled works. Please note that the scheduled list
2313 * may change while processing a work, so this function repeatedly
2314 * fetches a work from the top and executes it.
2315 *
2316 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002317 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002318 * multiple times.
2319 */
2320static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002322 while (!list_empty(&worker->scheduled)) {
2323 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002325 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327}
2328
Tejun Heo197f6ac2018-05-21 08:04:35 -07002329static void set_pf_worker(bool val)
2330{
2331 mutex_lock(&wq_pool_attach_mutex);
2332 if (val)
2333 current->flags |= PF_WQ_WORKER;
2334 else
2335 current->flags &= ~PF_WQ_WORKER;
2336 mutex_unlock(&wq_pool_attach_mutex);
2337}
2338
Tejun Heo4690c4a2010-06-29 10:07:10 +02002339/**
2340 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002341 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002342 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002343 * The worker thread function. All workers belong to a worker_pool -
2344 * either a per-cpu one or dynamic unbound one. These workers process all
2345 * work items regardless of their specific target workqueue. The only
2346 * exception is work items which belong to workqueues with a rescuer which
2347 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002348 *
2349 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002350 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002351static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352{
Tejun Heoc34056a2010-06-29 10:07:11 +02002353 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002354 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355
Tejun Heoe22bee72010-06-29 10:07:14 +02002356 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002357 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002358woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002359 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002360
Tejun Heoa9ab7752013-03-19 13:45:21 -07002361 /* am I supposed to die? */
2362 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002363 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002364 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002365 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002366
2367 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002368 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002369 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002370 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002371 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002373
Tejun Heoc8e55f32010-06-29 10:07:12 +02002374 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002375recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002376 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002377 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002378 goto sleep;
2379
2380 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002381 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002382 goto recheck;
2383
Tejun Heoc8e55f32010-06-29 10:07:12 +02002384 /*
2385 * ->scheduled list can only be filled while a worker is
2386 * preparing to process a work or actually processing it.
2387 * Make sure nobody diddled with it while I was sleeping.
2388 */
Tejun Heo6183c002013-03-12 11:29:57 -07002389 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002390
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002392 * Finish PREP stage. We're guaranteed to have at least one idle
2393 * worker or that someone else has already assumed the manager
2394 * role. This is where @worker starts participating in concurrency
2395 * management if applicable and concurrency management is restored
2396 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002397 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002398 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002399
2400 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002401 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002402 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002403 struct work_struct, entry);
2404
Tejun Heo82607adc2015-12-08 11:28:04 -05002405 pool->watchdog_ts = jiffies;
2406
Tejun Heoc8e55f32010-06-29 10:07:12 +02002407 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2408 /* optimization path, not strictly necessary */
2409 process_one_work(worker, work);
2410 if (unlikely(!list_empty(&worker->scheduled)))
2411 process_scheduled_works(worker);
2412 } else {
2413 move_linked_works(work, &worker->scheduled, NULL);
2414 process_scheduled_works(worker);
2415 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002416 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002417
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002418 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002419sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002420 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002421 * pool->lock is held and there's no work to process and no need to
2422 * manage, sleep. Workers are woken up only while holding
2423 * pool->lock or from local cpu, so setting the current state
2424 * before releasing pool->lock is enough to prevent losing any
2425 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002426 */
2427 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002428 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002429 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002430 schedule();
2431 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432}
2433
Tejun Heoe22bee72010-06-29 10:07:14 +02002434/**
2435 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002436 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002437 *
2438 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002439 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002440 *
Tejun Heo706026c2013-01-24 11:01:34 -08002441 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002442 * worker which uses GFP_KERNEL allocation which has slight chance of
2443 * developing into deadlock if some works currently on the same queue
2444 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2445 * the problem rescuer solves.
2446 *
Tejun Heo706026c2013-01-24 11:01:34 -08002447 * When such condition is possible, the pool summons rescuers of all
2448 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002449 * those works so that forward progress can be guaranteed.
2450 *
2451 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002452 *
2453 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002454 */
Tejun Heo111c2252013-01-17 17:16:24 -08002455static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002456{
Tejun Heo111c2252013-01-17 17:16:24 -08002457 struct worker *rescuer = __rescuer;
2458 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002459 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002460 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002461
2462 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002463
2464 /*
2465 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2466 * doesn't participate in concurrency management.
2467 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002468 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002469repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002470 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002471
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002472 /*
2473 * By the time the rescuer is requested to stop, the workqueue
2474 * shouldn't have any work pending, but @wq->maydays may still have
2475 * pwq(s) queued. This can happen by non-rescuer workers consuming
2476 * all the work items before the rescuer got to them. Go through
2477 * @wq->maydays processing before acting on should_stop so that the
2478 * list is always empty on exit.
2479 */
2480 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002481
Tejun Heo493a1722013-03-12 11:29:59 -07002482 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002483 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002484
2485 while (!list_empty(&wq->maydays)) {
2486 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2487 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002488 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002489 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002490 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002491
2492 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002493 list_del_init(&pwq->mayday_node);
2494
Tejun Heo2e109a22013-03-13 19:47:40 -07002495 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002496
Lai Jiangshan51697d392014-05-20 17:46:36 +08002497 worker_attach_to_pool(rescuer, pool);
2498
2499 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002500
2501 /*
2502 * Slurp in all works issued via this workqueue and
2503 * process'em.
2504 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002505 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002506 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2507 if (get_work_pwq(work) == pwq) {
2508 if (first)
2509 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002510 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002511 }
2512 first = false;
2513 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002514
NeilBrown008847f2014-12-08 12:39:16 -05002515 if (!list_empty(scheduled)) {
2516 process_scheduled_works(rescuer);
2517
2518 /*
2519 * The above execution of rescued work items could
2520 * have created more to rescue through
2521 * pwq_activate_first_delayed() or chained
2522 * queueing. Let's put @pwq back on mayday list so
2523 * that such back-to-back work items, which may be
2524 * being used to relieve memory pressure, don't
2525 * incur MAYDAY_INTERVAL delay inbetween.
2526 */
2527 if (need_to_create_worker(pool)) {
2528 spin_lock(&wq_mayday_lock);
2529 get_pwq(pwq);
2530 list_move_tail(&pwq->mayday_node, &wq->maydays);
2531 spin_unlock(&wq_mayday_lock);
2532 }
2533 }
Tejun Heo75769582011-02-14 14:04:46 +01002534
2535 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002536 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002537 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002538 */
2539 put_pwq(pwq);
2540
2541 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002542 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002543 * regular worker; otherwise, we end up with 0 concurrency
2544 * and stalling the execution.
2545 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002546 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002547 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002548
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002549 spin_unlock_irq(&pool->lock);
2550
Tejun Heoa2d812a2018-05-18 08:47:13 -07002551 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002552
2553 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002554 }
2555
Tejun Heo2e109a22013-03-13 19:47:40 -07002556 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002557
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002558 if (should_stop) {
2559 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002560 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002561 return 0;
2562 }
2563
Tejun Heo111c2252013-01-17 17:16:24 -08002564 /* rescuers should never participate in concurrency management */
2565 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002566 schedule();
2567 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568}
2569
Tejun Heofca839c2015-12-07 10:58:57 -05002570/**
2571 * check_flush_dependency - check for flush dependency sanity
2572 * @target_wq: workqueue being flushed
2573 * @target_work: work item being flushed (NULL for workqueue flushes)
2574 *
2575 * %current is trying to flush the whole @target_wq or @target_work on it.
2576 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2577 * reclaiming memory or running on a workqueue which doesn't have
2578 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2579 * a deadlock.
2580 */
2581static void check_flush_dependency(struct workqueue_struct *target_wq,
2582 struct work_struct *target_work)
2583{
2584 work_func_t target_func = target_work ? target_work->func : NULL;
2585 struct worker *worker;
2586
2587 if (target_wq->flags & WQ_MEM_RECLAIM)
2588 return;
2589
2590 worker = current_wq_worker();
2591
2592 WARN_ONCE(current->flags & PF_MEMALLOC,
2593 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2594 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002595 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2596 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002597 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2598 worker->current_pwq->wq->name, worker->current_func,
2599 target_wq->name, target_func);
2600}
2601
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002602struct wq_barrier {
2603 struct work_struct work;
2604 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002605 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002606};
2607
2608static void wq_barrier_func(struct work_struct *work)
2609{
2610 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2611 complete(&barr->done);
2612}
2613
Tejun Heo4690c4a2010-06-29 10:07:10 +02002614/**
2615 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002616 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002617 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002618 * @target: target work to attach @barr to
2619 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002620 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002621 * @barr is linked to @target such that @barr is completed only after
2622 * @target finishes execution. Please note that the ordering
2623 * guarantee is observed only with respect to @target and on the local
2624 * cpu.
2625 *
2626 * Currently, a queued barrier can't be canceled. This is because
2627 * try_to_grab_pending() can't determine whether the work to be
2628 * grabbed is at the head of the queue and thus can't clear LINKED
2629 * flag of the previous work while there must be a valid next work
2630 * after a work with LINKED flag set.
2631 *
2632 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002633 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002634 *
2635 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002636 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002637 */
Tejun Heo112202d2013-02-13 19:29:12 -08002638static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002639 struct wq_barrier *barr,
2640 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002641{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002642 struct list_head *head;
2643 unsigned int linked = 0;
2644
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002645 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002646 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002647 * as we know for sure that this will not trigger any of the
2648 * checks and call back into the fixup functions where we
2649 * might deadlock.
2650 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002651 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002652 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002653
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002654 init_completion_map(&barr->done, &target->lockdep_map);
2655
Tejun Heo2607d7a2015-03-09 09:22:28 -04002656 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002657
Tejun Heoaffee4b2010-06-29 10:07:12 +02002658 /*
2659 * If @target is currently being executed, schedule the
2660 * barrier to the worker; otherwise, put it after @target.
2661 */
2662 if (worker)
2663 head = worker->scheduled.next;
2664 else {
2665 unsigned long *bits = work_data_bits(target);
2666
2667 head = target->entry.next;
2668 /* there can already be other linked works, inherit and set */
2669 linked = *bits & WORK_STRUCT_LINKED;
2670 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2671 }
2672
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002673 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002674 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002675 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002676}
2677
Tejun Heo73f53c42010-06-29 10:07:11 +02002678/**
Tejun Heo112202d2013-02-13 19:29:12 -08002679 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002680 * @wq: workqueue being flushed
2681 * @flush_color: new flush color, < 0 for no-op
2682 * @work_color: new work color, < 0 for no-op
2683 *
Tejun Heo112202d2013-02-13 19:29:12 -08002684 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002685 *
Tejun Heo112202d2013-02-13 19:29:12 -08002686 * If @flush_color is non-negative, flush_color on all pwqs should be
2687 * -1. If no pwq has in-flight commands at the specified color, all
2688 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2689 * has in flight commands, its pwq->flush_color is set to
2690 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002691 * wakeup logic is armed and %true is returned.
2692 *
2693 * The caller should have initialized @wq->first_flusher prior to
2694 * calling this function with non-negative @flush_color. If
2695 * @flush_color is negative, no flush color update is done and %false
2696 * is returned.
2697 *
Tejun Heo112202d2013-02-13 19:29:12 -08002698 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002699 * work_color which is previous to @work_color and all will be
2700 * advanced to @work_color.
2701 *
2702 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002703 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002704 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002705 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002706 * %true if @flush_color >= 0 and there's something to flush. %false
2707 * otherwise.
2708 */
Tejun Heo112202d2013-02-13 19:29:12 -08002709static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002710 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711{
Tejun Heo73f53c42010-06-29 10:07:11 +02002712 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002713 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002714
Tejun Heo73f53c42010-06-29 10:07:11 +02002715 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002716 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002717 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002718 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002719
Tejun Heo49e3cf42013-03-12 11:29:58 -07002720 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002721 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002722
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002723 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002724
2725 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002726 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002727
Tejun Heo112202d2013-02-13 19:29:12 -08002728 if (pwq->nr_in_flight[flush_color]) {
2729 pwq->flush_color = flush_color;
2730 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002731 wait = true;
2732 }
2733 }
2734
2735 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002736 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002737 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002738 }
2739
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002740 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002741 }
2742
Tejun Heo112202d2013-02-13 19:29:12 -08002743 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002744 complete(&wq->first_flusher->done);
2745
2746 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747}
2748
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002749/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002751 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002753 * This function sleeps until all work items which were queued on entry
2754 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002756void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757{
Tejun Heo73f53c42010-06-29 10:07:11 +02002758 struct wq_flusher this_flusher = {
2759 .list = LIST_HEAD_INIT(this_flusher.list),
2760 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002761 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002762 };
2763 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002764
Tejun Heo3347fa02016-09-16 15:49:32 -04002765 if (WARN_ON(!wq_online))
2766 return;
2767
Johannes Berg87915ad2018-08-22 11:49:04 +02002768 lock_map_acquire(&wq->lockdep_map);
2769 lock_map_release(&wq->lockdep_map);
2770
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002771 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002772
2773 /*
2774 * Start-to-wait phase
2775 */
2776 next_color = work_next_color(wq->work_color);
2777
2778 if (next_color != wq->flush_color) {
2779 /*
2780 * Color space is not full. The current work_color
2781 * becomes our flush_color and work_color is advanced
2782 * by one.
2783 */
Tejun Heo6183c002013-03-12 11:29:57 -07002784 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002785 this_flusher.flush_color = wq->work_color;
2786 wq->work_color = next_color;
2787
2788 if (!wq->first_flusher) {
2789 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002790 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002791
2792 wq->first_flusher = &this_flusher;
2793
Tejun Heo112202d2013-02-13 19:29:12 -08002794 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002795 wq->work_color)) {
2796 /* nothing to flush, done */
2797 wq->flush_color = next_color;
2798 wq->first_flusher = NULL;
2799 goto out_unlock;
2800 }
2801 } else {
2802 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002803 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002804 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002805 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002806 }
2807 } else {
2808 /*
2809 * Oops, color space is full, wait on overflow queue.
2810 * The next flush completion will assign us
2811 * flush_color and transfer to flusher_queue.
2812 */
2813 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2814 }
2815
Tejun Heofca839c2015-12-07 10:58:57 -05002816 check_flush_dependency(wq, NULL);
2817
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002818 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002819
2820 wait_for_completion(&this_flusher.done);
2821
2822 /*
2823 * Wake-up-and-cascade phase
2824 *
2825 * First flushers are responsible for cascading flushes and
2826 * handling overflow. Non-first flushers can simply return.
2827 */
2828 if (wq->first_flusher != &this_flusher)
2829 return;
2830
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002831 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002832
Tejun Heo4ce48b32010-07-02 10:03:51 +02002833 /* we might have raced, check again with mutex held */
2834 if (wq->first_flusher != &this_flusher)
2835 goto out_unlock;
2836
Tejun Heo73f53c42010-06-29 10:07:11 +02002837 wq->first_flusher = NULL;
2838
Tejun Heo6183c002013-03-12 11:29:57 -07002839 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2840 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002841
2842 while (true) {
2843 struct wq_flusher *next, *tmp;
2844
2845 /* complete all the flushers sharing the current flush color */
2846 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2847 if (next->flush_color != wq->flush_color)
2848 break;
2849 list_del_init(&next->list);
2850 complete(&next->done);
2851 }
2852
Tejun Heo6183c002013-03-12 11:29:57 -07002853 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2854 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002855
2856 /* this flush_color is finished, advance by one */
2857 wq->flush_color = work_next_color(wq->flush_color);
2858
2859 /* one color has been freed, handle overflow queue */
2860 if (!list_empty(&wq->flusher_overflow)) {
2861 /*
2862 * Assign the same color to all overflowed
2863 * flushers, advance work_color and append to
2864 * flusher_queue. This is the start-to-wait
2865 * phase for these overflowed flushers.
2866 */
2867 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2868 tmp->flush_color = wq->work_color;
2869
2870 wq->work_color = work_next_color(wq->work_color);
2871
2872 list_splice_tail_init(&wq->flusher_overflow,
2873 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002874 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002875 }
2876
2877 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002878 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002879 break;
2880 }
2881
2882 /*
2883 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002884 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002885 */
Tejun Heo6183c002013-03-12 11:29:57 -07002886 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2887 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002888
2889 list_del_init(&next->list);
2890 wq->first_flusher = next;
2891
Tejun Heo112202d2013-02-13 19:29:12 -08002892 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002893 break;
2894
2895 /*
2896 * Meh... this color is already done, clear first
2897 * flusher and repeat cascading.
2898 */
2899 wq->first_flusher = NULL;
2900 }
2901
2902out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002903 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002905EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002907/**
2908 * drain_workqueue - drain a workqueue
2909 * @wq: workqueue to drain
2910 *
2911 * Wait until the workqueue becomes empty. While draining is in progress,
2912 * only chain queueing is allowed. IOW, only currently pending or running
2913 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002914 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002915 * by the depth of chaining and should be relatively short. Whine if it
2916 * takes too long.
2917 */
2918void drain_workqueue(struct workqueue_struct *wq)
2919{
2920 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002921 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002922
2923 /*
2924 * __queue_work() needs to test whether there are drainers, is much
2925 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002926 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002927 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002928 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002929 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002930 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002931 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002932reflush:
2933 flush_workqueue(wq);
2934
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002935 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002936
Tejun Heo49e3cf42013-03-12 11:29:58 -07002937 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002938 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002939
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002940 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002941 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002942 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002943
2944 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002945 continue;
2946
2947 if (++flush_cnt == 10 ||
2948 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002949 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002950 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002951
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002952 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002953 goto reflush;
2954 }
2955
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002956 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002957 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002958 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002959}
2960EXPORT_SYMBOL_GPL(drain_workqueue);
2961
Johannes Bergd6e89782018-08-22 11:49:03 +02002962static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2963 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002964{
2965 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002966 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002967 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002968
2969 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002970
Tejun Heofa1b54e2013-03-12 11:30:00 -07002971 local_irq_disable();
2972 pool = get_work_pool(work);
2973 if (!pool) {
2974 local_irq_enable();
2975 return false;
2976 }
2977
2978 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002979 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002980 pwq = get_work_pwq(work);
2981 if (pwq) {
2982 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002983 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002984 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002985 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002986 if (!worker)
2987 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002988 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002989 }
Tejun Heobaf59022010-09-16 10:42:16 +02002990
Tejun Heofca839c2015-12-07 10:58:57 -05002991 check_flush_dependency(pwq->wq, work);
2992
Tejun Heo112202d2013-02-13 19:29:12 -08002993 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002994 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002995
Tejun Heoe159489b2011-01-09 23:32:15 +01002996 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002997 * Force a lock recursion deadlock when using flush_work() inside a
2998 * single-threaded or rescuer equipped workqueue.
2999 *
3000 * For single threaded workqueues the deadlock happens when the work
3001 * is after the work issuing the flush_work(). For rescuer equipped
3002 * workqueues the deadlock happens when the rescuer stalls, blocking
3003 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003004 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003005 if (!from_cancel &&
3006 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003007 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003008 lock_map_release(&pwq->wq->lockdep_map);
3009 }
Tejun Heoe159489b2011-01-09 23:32:15 +01003010
Tejun Heobaf59022010-09-16 10:42:16 +02003011 return true;
3012already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08003013 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003014 return false;
3015}
3016
Johannes Bergd6e89782018-08-22 11:49:03 +02003017static bool __flush_work(struct work_struct *work, bool from_cancel)
3018{
3019 struct wq_barrier barr;
3020
3021 if (WARN_ON(!wq_online))
3022 return false;
3023
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003024 if (WARN_ON(!work->func))
3025 return false;
3026
Johannes Berg87915ad2018-08-22 11:49:04 +02003027 if (!from_cancel) {
3028 lock_map_acquire(&work->lockdep_map);
3029 lock_map_release(&work->lockdep_map);
3030 }
3031
Johannes Bergd6e89782018-08-22 11:49:03 +02003032 if (start_flush_work(work, &barr, from_cancel)) {
3033 wait_for_completion(&barr.done);
3034 destroy_work_on_stack(&barr.work);
3035 return true;
3036 } else {
3037 return false;
3038 }
3039}
3040
Oleg Nesterovdb700892008-07-25 01:47:49 -07003041/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003042 * flush_work - wait for a work to finish executing the last queueing instance
3043 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003044 *
Tejun Heo606a5022012-08-20 14:51:23 -07003045 * Wait until @work has finished execution. @work is guaranteed to be idle
3046 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003047 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003048 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003049 * %true if flush_work() waited for the work to finish execution,
3050 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003051 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003052bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003053{
Johannes Bergd6e89782018-08-22 11:49:03 +02003054 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003055}
3056EXPORT_SYMBOL_GPL(flush_work);
3057
Tejun Heo8603e1b32015-03-05 08:04:13 -05003058struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003059 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003060 struct work_struct *work;
3061};
3062
Ingo Molnarac6424b2017-06-20 12:06:13 +02003063static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003064{
3065 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3066
3067 if (cwait->work != key)
3068 return 0;
3069 return autoremove_wake_function(wait, mode, sync, key);
3070}
3071
Tejun Heo36e227d2012-08-03 10:30:46 -07003072static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003073{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003074 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003075 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003076 int ret;
3077
3078 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003079 ret = try_to_grab_pending(work, is_dwork, &flags);
3080 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003081 * If someone else is already canceling, wait for it to
3082 * finish. flush_work() doesn't work for PREEMPT_NONE
3083 * because we may get scheduled between @work's completion
3084 * and the other canceling task resuming and clearing
3085 * CANCELING - flush_work() will return false immediately
3086 * as @work is no longer busy, try_to_grab_pending() will
3087 * return -ENOENT as @work is still being canceled and the
3088 * other canceling task won't be able to clear CANCELING as
3089 * we're hogging the CPU.
3090 *
3091 * Let's wait for completion using a waitqueue. As this
3092 * may lead to the thundering herd problem, use a custom
3093 * wake function which matches @work along with exclusive
3094 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003095 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003096 if (unlikely(ret == -ENOENT)) {
3097 struct cwt_wait cwait;
3098
3099 init_wait(&cwait.wait);
3100 cwait.wait.func = cwt_wakefn;
3101 cwait.work = work;
3102
3103 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3104 TASK_UNINTERRUPTIBLE);
3105 if (work_is_canceling(work))
3106 schedule();
3107 finish_wait(&cancel_waitq, &cwait.wait);
3108 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003109 } while (unlikely(ret < 0));
3110
Tejun Heobbb68df2012-08-03 10:30:46 -07003111 /* tell other tasks trying to grab @work to back off */
3112 mark_work_canceling(work);
3113 local_irq_restore(flags);
3114
Tejun Heo3347fa02016-09-16 15:49:32 -04003115 /*
3116 * This allows canceling during early boot. We know that @work
3117 * isn't executing.
3118 */
3119 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003120 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003121
Tejun Heo7a22ad72010-06-29 10:07:13 +02003122 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003123
3124 /*
3125 * Paired with prepare_to_wait() above so that either
3126 * waitqueue_active() is visible here or !work_is_canceling() is
3127 * visible there.
3128 */
3129 smp_mb();
3130 if (waitqueue_active(&cancel_waitq))
3131 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3132
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003133 return ret;
3134}
3135
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003136/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003137 * cancel_work_sync - cancel a work and wait for it to finish
3138 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003139 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003140 * Cancel @work and wait for its execution to finish. This function
3141 * can be used even if the work re-queues itself or migrates to
3142 * another workqueue. On return from this function, @work is
3143 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003144 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003145 * cancel_work_sync(&delayed_work->work) must not be used for
3146 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003147 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003148 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003149 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003150 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003151 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003152 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003153 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003154bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003155{
Tejun Heo36e227d2012-08-03 10:30:46 -07003156 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003157}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003158EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003159
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003160/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003161 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3162 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003163 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003164 * Delayed timer is cancelled and the pending work is queued for
3165 * immediate execution. Like flush_work(), this function only
3166 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003167 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003168 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003169 * %true if flush_work() waited for the work to finish execution,
3170 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003171 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003172bool flush_delayed_work(struct delayed_work *dwork)
3173{
Tejun Heo8930cab2012-08-03 10:30:45 -07003174 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003175 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003176 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003177 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003178 return flush_work(&dwork->work);
3179}
3180EXPORT_SYMBOL(flush_delayed_work);
3181
Tejun Heo05f0fe62018-03-14 12:45:13 -07003182/**
3183 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3184 * @rwork: the rcu work to flush
3185 *
3186 * Return:
3187 * %true if flush_rcu_work() waited for the work to finish execution,
3188 * %false if it was already idle.
3189 */
3190bool flush_rcu_work(struct rcu_work *rwork)
3191{
3192 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3193 rcu_barrier();
3194 flush_work(&rwork->work);
3195 return true;
3196 } else {
3197 return flush_work(&rwork->work);
3198 }
3199}
3200EXPORT_SYMBOL(flush_rcu_work);
3201
Jens Axboef72b8792016-08-24 15:51:50 -06003202static bool __cancel_work(struct work_struct *work, bool is_dwork)
3203{
3204 unsigned long flags;
3205 int ret;
3206
3207 do {
3208 ret = try_to_grab_pending(work, is_dwork, &flags);
3209 } while (unlikely(ret == -EAGAIN));
3210
3211 if (unlikely(ret < 0))
3212 return false;
3213
3214 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3215 local_irq_restore(flags);
3216 return ret;
3217}
3218
Tejun Heo401a8d02010-09-16 10:36:00 +02003219/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003220 * cancel_delayed_work - cancel a delayed work
3221 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003222 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003223 * Kill off a pending delayed_work.
3224 *
3225 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3226 * pending.
3227 *
3228 * Note:
3229 * The work callback function may still be running on return, unless
3230 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3231 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003232 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003233 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003234 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003235bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003236{
Jens Axboef72b8792016-08-24 15:51:50 -06003237 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003238}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003239EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003240
3241/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003242 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3243 * @dwork: the delayed work cancel
3244 *
3245 * This is cancel_work_sync() for delayed works.
3246 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003247 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003248 * %true if @dwork was pending, %false otherwise.
3249 */
3250bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003251{
Tejun Heo36e227d2012-08-03 10:30:46 -07003252 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003253}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003254EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003256/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003257 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003258 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003259 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003260 * schedule_on_each_cpu() executes @func on each online CPU using the
3261 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003262 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003263 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003264 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003265 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003266 */
David Howells65f27f32006-11-22 14:55:48 +00003267int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003268{
3269 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003270 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003271
Andrew Mortonb6136772006-06-25 05:47:49 -07003272 works = alloc_percpu(struct work_struct);
3273 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003274 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003275
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003276 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003277
Christoph Lameter15316ba82006-01-08 01:00:43 -08003278 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003279 struct work_struct *work = per_cpu_ptr(works, cpu);
3280
3281 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003282 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003283 }
Tejun Heo93981802009-11-17 14:06:20 -08003284
3285 for_each_online_cpu(cpu)
3286 flush_work(per_cpu_ptr(works, cpu));
3287
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003288 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003289 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003290 return 0;
3291}
3292
Alan Sterneef6a7d2010-02-12 17:39:21 +09003293/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003294 * execute_in_process_context - reliably execute the routine with user context
3295 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003296 * @ew: guaranteed storage for the execute work structure (must
3297 * be available when the work executes)
3298 *
3299 * Executes the function immediately if process context is available,
3300 * otherwise schedules the function for delayed execution.
3301 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003302 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003303 * 1 - function was scheduled for execution
3304 */
David Howells65f27f32006-11-22 14:55:48 +00003305int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003306{
3307 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003308 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003309 return 0;
3310 }
3311
David Howells65f27f32006-11-22 14:55:48 +00003312 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003313 schedule_work(&ew->work);
3314
3315 return 1;
3316}
3317EXPORT_SYMBOL_GPL(execute_in_process_context);
3318
Tejun Heo7a4e3442013-03-12 11:30:00 -07003319/**
3320 * free_workqueue_attrs - free a workqueue_attrs
3321 * @attrs: workqueue_attrs to free
3322 *
3323 * Undo alloc_workqueue_attrs().
3324 */
3325void free_workqueue_attrs(struct workqueue_attrs *attrs)
3326{
3327 if (attrs) {
3328 free_cpumask_var(attrs->cpumask);
3329 kfree(attrs);
3330 }
3331}
3332
3333/**
3334 * alloc_workqueue_attrs - allocate a workqueue_attrs
3335 * @gfp_mask: allocation mask to use
3336 *
3337 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003338 * return it.
3339 *
3340 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003341 */
3342struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3343{
3344 struct workqueue_attrs *attrs;
3345
3346 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3347 if (!attrs)
3348 goto fail;
3349 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3350 goto fail;
3351
Tejun Heo13e2e552013-04-01 11:23:31 -07003352 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003353 return attrs;
3354fail:
3355 free_workqueue_attrs(attrs);
3356 return NULL;
3357}
3358
Tejun Heo29c91e92013-03-12 11:30:03 -07003359static void copy_workqueue_attrs(struct workqueue_attrs *to,
3360 const struct workqueue_attrs *from)
3361{
3362 to->nice = from->nice;
3363 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003364 /*
3365 * Unlike hash and equality test, this function doesn't ignore
3366 * ->no_numa as it is used for both pool and wq attrs. Instead,
3367 * get_unbound_pool() explicitly clears ->no_numa after copying.
3368 */
3369 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003370}
3371
Tejun Heo29c91e92013-03-12 11:30:03 -07003372/* hash value of the content of @attr */
3373static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3374{
3375 u32 hash = 0;
3376
3377 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003378 hash = jhash(cpumask_bits(attrs->cpumask),
3379 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003380 return hash;
3381}
3382
3383/* content equality test */
3384static bool wqattrs_equal(const struct workqueue_attrs *a,
3385 const struct workqueue_attrs *b)
3386{
3387 if (a->nice != b->nice)
3388 return false;
3389 if (!cpumask_equal(a->cpumask, b->cpumask))
3390 return false;
3391 return true;
3392}
3393
Tejun Heo7a4e3442013-03-12 11:30:00 -07003394/**
3395 * init_worker_pool - initialize a newly zalloc'd worker_pool
3396 * @pool: worker_pool to initialize
3397 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303398 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003399 *
3400 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003401 * inside @pool proper are initialized and put_unbound_pool() can be called
3402 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003403 */
3404static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003405{
3406 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 pool->id = -1;
3408 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003409 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003410 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003411 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003412 INIT_LIST_HEAD(&pool->worklist);
3413 INIT_LIST_HEAD(&pool->idle_list);
3414 hash_init(pool->busy_hash);
3415
Kees Cook32a6c722017-10-16 15:58:25 -07003416 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003417
Kees Cook32a6c722017-10-16 15:58:25 -07003418 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003419
Lai Jiangshanda028462014-05-20 17:46:31 +08003420 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003421
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003422 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003423 INIT_HLIST_NODE(&pool->hash_node);
3424 pool->refcnt = 1;
3425
3426 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003427 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3428 if (!pool->attrs)
3429 return -ENOMEM;
3430 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003431}
3432
Bart Van Assche669de8b2019-02-14 15:00:54 -08003433#ifdef CONFIG_LOCKDEP
3434static void wq_init_lockdep(struct workqueue_struct *wq)
3435{
3436 char *lock_name;
3437
3438 lockdep_register_key(&wq->key);
3439 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3440 if (!lock_name)
3441 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003442
3443 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003444 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3445}
3446
3447static void wq_unregister_lockdep(struct workqueue_struct *wq)
3448{
3449 lockdep_unregister_key(&wq->key);
3450}
3451
3452static void wq_free_lockdep(struct workqueue_struct *wq)
3453{
3454 if (wq->lock_name != wq->name)
3455 kfree(wq->lock_name);
3456}
3457#else
3458static void wq_init_lockdep(struct workqueue_struct *wq)
3459{
3460}
3461
3462static void wq_unregister_lockdep(struct workqueue_struct *wq)
3463{
3464}
3465
3466static void wq_free_lockdep(struct workqueue_struct *wq)
3467{
3468}
3469#endif
3470
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003471static void rcu_free_wq(struct rcu_head *rcu)
3472{
3473 struct workqueue_struct *wq =
3474 container_of(rcu, struct workqueue_struct, rcu);
3475
Bart Van Assche669de8b2019-02-14 15:00:54 -08003476 wq_free_lockdep(wq);
3477
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003478 if (!(wq->flags & WQ_UNBOUND))
3479 free_percpu(wq->cpu_pwqs);
3480 else
3481 free_workqueue_attrs(wq->unbound_attrs);
3482
3483 kfree(wq->rescuer);
3484 kfree(wq);
3485}
3486
Tejun Heo29c91e92013-03-12 11:30:03 -07003487static void rcu_free_pool(struct rcu_head *rcu)
3488{
3489 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3490
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003491 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003492 free_workqueue_attrs(pool->attrs);
3493 kfree(pool);
3494}
3495
3496/**
3497 * put_unbound_pool - put a worker_pool
3498 * @pool: worker_pool to put
3499 *
3500 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003501 * safe manner. get_unbound_pool() calls this function on its failure path
3502 * and this function should be able to release pools which went through,
3503 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003504 *
3505 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003506 */
3507static void put_unbound_pool(struct worker_pool *pool)
3508{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003509 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003510 struct worker *worker;
3511
Tejun Heoa892cac2013-04-01 11:23:32 -07003512 lockdep_assert_held(&wq_pool_mutex);
3513
3514 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003515 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003516
3517 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003518 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003519 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003520 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003521
3522 /* release id and unhash */
3523 if (pool->id >= 0)
3524 idr_remove(&worker_pool_idr, pool->id);
3525 hash_del(&pool->hash_node);
3526
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003527 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003528 * Become the manager and destroy all workers. This prevents
3529 * @pool's workers from blocking on attach_mutex. We're the last
3530 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003531 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003532 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003533 wait_event_lock_irq(wq_manager_wait,
3534 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3535 pool->flags |= POOL_MANAGER_ACTIVE;
3536
Lai Jiangshan1037de32014-05-22 16:44:07 +08003537 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003538 destroy_worker(worker);
3539 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003540 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003541
Tejun Heo1258fae2018-05-18 08:47:13 -07003542 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003543 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003544 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003545 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003546
3547 if (pool->detach_completion)
3548 wait_for_completion(pool->detach_completion);
3549
Tejun Heo29c91e92013-03-12 11:30:03 -07003550 /* shut down the timers */
3551 del_timer_sync(&pool->idle_timer);
3552 del_timer_sync(&pool->mayday_timer);
3553
3554 /* sched-RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003555 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003556}
3557
3558/**
3559 * get_unbound_pool - get a worker_pool with the specified attributes
3560 * @attrs: the attributes of the worker_pool to get
3561 *
3562 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3563 * reference count and return it. If there already is a matching
3564 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003565 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003566 *
3567 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003568 *
3569 * Return: On success, a worker_pool with the same attributes as @attrs.
3570 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003571 */
3572static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3573{
Tejun Heo29c91e92013-03-12 11:30:03 -07003574 u32 hash = wqattrs_hash(attrs);
3575 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003576 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003577 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003578
Tejun Heoa892cac2013-04-01 11:23:32 -07003579 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003580
3581 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003582 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3583 if (wqattrs_equal(pool->attrs, attrs)) {
3584 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003585 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003586 }
3587 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003588
Xunlei Pange22735842015-10-09 11:53:12 +08003589 /* if cpumask is contained inside a NUMA node, we belong to that node */
3590 if (wq_numa_enabled) {
3591 for_each_node(node) {
3592 if (cpumask_subset(attrs->cpumask,
3593 wq_numa_possible_cpumask[node])) {
3594 target_node = node;
3595 break;
3596 }
3597 }
3598 }
3599
Tejun Heo29c91e92013-03-12 11:30:03 -07003600 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003601 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003602 if (!pool || init_worker_pool(pool) < 0)
3603 goto fail;
3604
Tejun Heo8864b4e2013-03-12 11:30:04 -07003605 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003606 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003607 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003608
Shaohua Li2865a8f2013-08-01 09:56:36 +08003609 /*
3610 * no_numa isn't a worker_pool attribute, always clear it. See
3611 * 'struct workqueue_attrs' comments for detail.
3612 */
3613 pool->attrs->no_numa = false;
3614
Tejun Heo29c91e92013-03-12 11:30:03 -07003615 if (worker_pool_assign_id(pool) < 0)
3616 goto fail;
3617
3618 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003619 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003620 goto fail;
3621
Tejun Heo29c91e92013-03-12 11:30:03 -07003622 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003623 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003624
Tejun Heo29c91e92013-03-12 11:30:03 -07003625 return pool;
3626fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003627 if (pool)
3628 put_unbound_pool(pool);
3629 return NULL;
3630}
3631
Tejun Heo8864b4e2013-03-12 11:30:04 -07003632static void rcu_free_pwq(struct rcu_head *rcu)
3633{
3634 kmem_cache_free(pwq_cache,
3635 container_of(rcu, struct pool_workqueue, rcu));
3636}
3637
3638/*
3639 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3640 * and needs to be destroyed.
3641 */
3642static void pwq_unbound_release_workfn(struct work_struct *work)
3643{
3644 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3645 unbound_release_work);
3646 struct workqueue_struct *wq = pwq->wq;
3647 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003648 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003649
3650 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3651 return;
3652
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003653 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003654 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003655 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003656 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003657
Tejun Heoa892cac2013-04-01 11:23:32 -07003658 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003659 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003660 mutex_unlock(&wq_pool_mutex);
3661
Paul E. McKenney25b00772018-11-06 19:18:45 -08003662 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003663
3664 /*
3665 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003666 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003667 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003668 if (is_last) {
3669 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003670 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003671 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003672}
3673
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003674/**
Tejun Heo699ce092013-03-13 16:51:35 -07003675 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003676 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003677 *
Tejun Heo699ce092013-03-13 16:51:35 -07003678 * If @pwq isn't freezing, set @pwq->max_active to the associated
3679 * workqueue's saved_max_active and activate delayed work items
3680 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003681 */
Tejun Heo699ce092013-03-13 16:51:35 -07003682static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003683{
Tejun Heo699ce092013-03-13 16:51:35 -07003684 struct workqueue_struct *wq = pwq->wq;
3685 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003686 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003687
Tejun Heo699ce092013-03-13 16:51:35 -07003688 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003689 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003690
3691 /* fast exit for non-freezable wqs */
3692 if (!freezable && pwq->max_active == wq->saved_max_active)
3693 return;
3694
Tejun Heo3347fa02016-09-16 15:49:32 -04003695 /* this function can be called during early boot w/ irq disabled */
3696 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003697
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003698 /*
3699 * During [un]freezing, the caller is responsible for ensuring that
3700 * this function is called at least once after @workqueue_freezing
3701 * is updated and visible.
3702 */
3703 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003704 pwq->max_active = wq->saved_max_active;
3705
3706 while (!list_empty(&pwq->delayed_works) &&
3707 pwq->nr_active < pwq->max_active)
3708 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003709
3710 /*
3711 * Need to kick a worker after thawed or an unbound wq's
3712 * max_active is bumped. It's a slow path. Do it always.
3713 */
3714 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003715 } else {
3716 pwq->max_active = 0;
3717 }
3718
Tejun Heo3347fa02016-09-16 15:49:32 -04003719 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003720}
3721
Tejun Heoe50aba92013-04-01 11:23:35 -07003722/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003723static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3724 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003725{
3726 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3727
Tejun Heoe50aba92013-04-01 11:23:35 -07003728 memset(pwq, 0, sizeof(*pwq));
3729
Tejun Heod2c1d402013-03-12 11:30:04 -07003730 pwq->pool = pool;
3731 pwq->wq = wq;
3732 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003733 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003734 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003735 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003736 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003737 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003738}
Tejun Heod2c1d402013-03-12 11:30:04 -07003739
Tejun Heof147f292013-04-01 11:23:35 -07003740/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003741static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003742{
3743 struct workqueue_struct *wq = pwq->wq;
3744
3745 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003746
Tejun Heo1befcf32013-04-01 11:23:35 -07003747 /* may be called multiple times, ignore if already linked */
3748 if (!list_empty(&pwq->pwqs_node))
3749 return;
3750
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003751 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003752 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003753
3754 /* sync max_active to the current setting */
3755 pwq_adjust_max_active(pwq);
3756
3757 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003758 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003759}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003760
Tejun Heof147f292013-04-01 11:23:35 -07003761/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3762static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3763 const struct workqueue_attrs *attrs)
3764{
3765 struct worker_pool *pool;
3766 struct pool_workqueue *pwq;
3767
3768 lockdep_assert_held(&wq_pool_mutex);
3769
3770 pool = get_unbound_pool(attrs);
3771 if (!pool)
3772 return NULL;
3773
Tejun Heoe50aba92013-04-01 11:23:35 -07003774 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003775 if (!pwq) {
3776 put_unbound_pool(pool);
3777 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003778 }
Tejun Heo6029a912013-04-01 11:23:34 -07003779
Tejun Heof147f292013-04-01 11:23:35 -07003780 init_pwq(pwq, wq, pool);
3781 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003782}
3783
Tejun Heo4c16bd32013-04-01 11:23:36 -07003784/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003785 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003786 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003787 * @node: the target NUMA node
3788 * @cpu_going_down: if >= 0, the CPU to consider as offline
3789 * @cpumask: outarg, the resulting cpumask
3790 *
3791 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3792 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003793 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003794 *
3795 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3796 * enabled and @node has online CPUs requested by @attrs, the returned
3797 * cpumask is the intersection of the possible CPUs of @node and
3798 * @attrs->cpumask.
3799 *
3800 * The caller is responsible for ensuring that the cpumask of @node stays
3801 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003802 *
3803 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3804 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003805 */
3806static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3807 int cpu_going_down, cpumask_t *cpumask)
3808{
Tejun Heod55262c2013-04-01 11:23:38 -07003809 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003810 goto use_dfl;
3811
3812 /* does @node have any online CPUs @attrs wants? */
3813 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3814 if (cpu_going_down >= 0)
3815 cpumask_clear_cpu(cpu_going_down, cpumask);
3816
3817 if (cpumask_empty(cpumask))
3818 goto use_dfl;
3819
3820 /* yeap, return possible CPUs in @node that @attrs wants */
3821 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003822
3823 if (cpumask_empty(cpumask)) {
3824 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3825 "possible intersect\n");
3826 return false;
3827 }
3828
Tejun Heo4c16bd32013-04-01 11:23:36 -07003829 return !cpumask_equal(cpumask, attrs->cpumask);
3830
3831use_dfl:
3832 cpumask_copy(cpumask, attrs->cpumask);
3833 return false;
3834}
3835
Tejun Heo1befcf32013-04-01 11:23:35 -07003836/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3837static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3838 int node,
3839 struct pool_workqueue *pwq)
3840{
3841 struct pool_workqueue *old_pwq;
3842
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003843 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003844 lockdep_assert_held(&wq->mutex);
3845
3846 /* link_pwq() can handle duplicate calls */
3847 link_pwq(pwq);
3848
3849 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3850 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3851 return old_pwq;
3852}
3853
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003854/* context to store the prepared attrs & pwqs before applying */
3855struct apply_wqattrs_ctx {
3856 struct workqueue_struct *wq; /* target workqueue */
3857 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003858 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003859 struct pool_workqueue *dfl_pwq;
3860 struct pool_workqueue *pwq_tbl[];
3861};
3862
3863/* free the resources after success or abort */
3864static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3865{
3866 if (ctx) {
3867 int node;
3868
3869 for_each_node(node)
3870 put_pwq_unlocked(ctx->pwq_tbl[node]);
3871 put_pwq_unlocked(ctx->dfl_pwq);
3872
3873 free_workqueue_attrs(ctx->attrs);
3874
3875 kfree(ctx);
3876 }
3877}
3878
3879/* allocate the attrs and pwqs for later installation */
3880static struct apply_wqattrs_ctx *
3881apply_wqattrs_prepare(struct workqueue_struct *wq,
3882 const struct workqueue_attrs *attrs)
3883{
3884 struct apply_wqattrs_ctx *ctx;
3885 struct workqueue_attrs *new_attrs, *tmp_attrs;
3886 int node;
3887
3888 lockdep_assert_held(&wq_pool_mutex);
3889
Kees Cookacafe7e2018-05-08 13:45:50 -07003890 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003891
3892 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3893 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3894 if (!ctx || !new_attrs || !tmp_attrs)
3895 goto out_free;
3896
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003897 /*
3898 * Calculate the attrs of the default pwq.
3899 * If the user configured cpumask doesn't overlap with the
3900 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3901 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003902 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003903 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003904 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3905 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003906
3907 /*
3908 * We may create multiple pwqs with differing cpumasks. Make a
3909 * copy of @new_attrs which will be modified and used to obtain
3910 * pools.
3911 */
3912 copy_workqueue_attrs(tmp_attrs, new_attrs);
3913
3914 /*
3915 * If something goes wrong during CPU up/down, we'll fall back to
3916 * the default pwq covering whole @attrs->cpumask. Always create
3917 * it even if we don't use it immediately.
3918 */
3919 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3920 if (!ctx->dfl_pwq)
3921 goto out_free;
3922
3923 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003924 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003925 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3926 if (!ctx->pwq_tbl[node])
3927 goto out_free;
3928 } else {
3929 ctx->dfl_pwq->refcnt++;
3930 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3931 }
3932 }
3933
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003934 /* save the user configured attrs and sanitize it. */
3935 copy_workqueue_attrs(new_attrs, attrs);
3936 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003937 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003938
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003939 ctx->wq = wq;
3940 free_workqueue_attrs(tmp_attrs);
3941 return ctx;
3942
3943out_free:
3944 free_workqueue_attrs(tmp_attrs);
3945 free_workqueue_attrs(new_attrs);
3946 apply_wqattrs_cleanup(ctx);
3947 return NULL;
3948}
3949
3950/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3951static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3952{
3953 int node;
3954
3955 /* all pwqs have been created successfully, let's install'em */
3956 mutex_lock(&ctx->wq->mutex);
3957
3958 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3959
3960 /* save the previous pwq and install the new one */
3961 for_each_node(node)
3962 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3963 ctx->pwq_tbl[node]);
3964
3965 /* @dfl_pwq might not have been used, ensure it's linked */
3966 link_pwq(ctx->dfl_pwq);
3967 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3968
3969 mutex_unlock(&ctx->wq->mutex);
3970}
3971
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003972static void apply_wqattrs_lock(void)
3973{
3974 /* CPUs should stay stable across pwq creations and installations */
3975 get_online_cpus();
3976 mutex_lock(&wq_pool_mutex);
3977}
3978
3979static void apply_wqattrs_unlock(void)
3980{
3981 mutex_unlock(&wq_pool_mutex);
3982 put_online_cpus();
3983}
3984
3985static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3986 const struct workqueue_attrs *attrs)
3987{
3988 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003989
3990 /* only unbound workqueues can change attributes */
3991 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3992 return -EINVAL;
3993
3994 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003995 if (!list_empty(&wq->pwqs)) {
3996 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3997 return -EINVAL;
3998
3999 wq->flags &= ~__WQ_ORDERED;
4000 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004001
4002 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004003 if (!ctx)
4004 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004005
4006 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004007 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004008 apply_wqattrs_cleanup(ctx);
4009
wanghaibin62011712016-01-07 20:38:59 +08004010 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004011}
4012
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004013/**
4014 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4015 * @wq: the target workqueue
4016 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4017 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004018 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4019 * machines, this function maps a separate pwq to each NUMA node with
4020 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4021 * NUMA node it was issued on. Older pwqs are released as in-flight work
4022 * items finish. Note that a work item which repeatedly requeues itself
4023 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004024 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004025 * Performs GFP_KERNEL allocations.
4026 *
4027 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004028 */
4029int apply_workqueue_attrs(struct workqueue_struct *wq,
4030 const struct workqueue_attrs *attrs)
4031{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004032 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004033
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004034 apply_wqattrs_lock();
4035 ret = apply_workqueue_attrs_locked(wq, attrs);
4036 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004037
Tejun Heo48621252013-04-01 11:23:31 -07004038 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004039}
NeilBrown6106c0f2018-01-11 15:06:40 +11004040EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004041
Tejun Heo4c16bd32013-04-01 11:23:36 -07004042/**
4043 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4044 * @wq: the target workqueue
4045 * @cpu: the CPU coming up or going down
4046 * @online: whether @cpu is coming up or going down
4047 *
4048 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4049 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4050 * @wq accordingly.
4051 *
4052 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4053 * falls back to @wq->dfl_pwq which may not be optimal but is always
4054 * correct.
4055 *
4056 * Note that when the last allowed CPU of a NUMA node goes offline for a
4057 * workqueue with a cpumask spanning multiple nodes, the workers which were
4058 * already executing the work items for the workqueue will lose their CPU
4059 * affinity and may execute on any CPU. This is similar to how per-cpu
4060 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4061 * affinity, it's the user's responsibility to flush the work item from
4062 * CPU_DOWN_PREPARE.
4063 */
4064static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4065 bool online)
4066{
4067 int node = cpu_to_node(cpu);
4068 int cpu_off = online ? -1 : cpu;
4069 struct pool_workqueue *old_pwq = NULL, *pwq;
4070 struct workqueue_attrs *target_attrs;
4071 cpumask_t *cpumask;
4072
4073 lockdep_assert_held(&wq_pool_mutex);
4074
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004075 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4076 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004077 return;
4078
4079 /*
4080 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4081 * Let's use a preallocated one. The following buf is protected by
4082 * CPU hotplug exclusion.
4083 */
4084 target_attrs = wq_update_unbound_numa_attrs_buf;
4085 cpumask = target_attrs->cpumask;
4086
Tejun Heo4c16bd32013-04-01 11:23:36 -07004087 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4088 pwq = unbound_pwq_by_node(wq, node);
4089
4090 /*
4091 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004092 * different from the default pwq's, we need to compare it to @pwq's
4093 * and create a new one if they don't match. If the target cpumask
4094 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004095 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004096 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004097 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004098 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004099 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004100 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004101 }
4102
Tejun Heo4c16bd32013-04-01 11:23:36 -07004103 /* create a new pwq */
4104 pwq = alloc_unbound_pwq(wq, target_attrs);
4105 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004106 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4107 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004108 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004109 }
4110
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004111 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004112 mutex_lock(&wq->mutex);
4113 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4114 goto out_unlock;
4115
4116use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004117 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004118 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4119 get_pwq(wq->dfl_pwq);
4120 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4121 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4122out_unlock:
4123 mutex_unlock(&wq->mutex);
4124 put_pwq_unlocked(old_pwq);
4125}
4126
Tejun Heo30cdf2492013-03-12 11:29:57 -07004127static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004128{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004129 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004130 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004131
Tejun Heo30cdf2492013-03-12 11:29:57 -07004132 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004133 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4134 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004135 return -ENOMEM;
4136
4137 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004138 struct pool_workqueue *pwq =
4139 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004140 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004141 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004142
Tejun Heof147f292013-04-01 11:23:35 -07004143 init_pwq(pwq, wq, &cpu_pools[highpri]);
4144
4145 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004146 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004147 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004148 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004149 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004150 } else if (wq->flags & __WQ_ORDERED) {
4151 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4152 /* there should only be single pwq for ordering guarantee */
4153 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4154 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4155 "ordering guarantee broken for workqueue %s\n", wq->name);
4156 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07004157 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004158 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004159 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004160}
4161
Tejun Heof3421792010-07-02 10:03:51 +02004162static int wq_clamp_max_active(int max_active, unsigned int flags,
4163 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004164{
Tejun Heof3421792010-07-02 10:03:51 +02004165 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4166
4167 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004168 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4169 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004170
Tejun Heof3421792010-07-02 10:03:51 +02004171 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004172}
4173
Tejun Heo983c7512018-01-08 05:38:32 -08004174/*
4175 * Workqueues which may be used during memory reclaim should have a rescuer
4176 * to guarantee forward progress.
4177 */
4178static int init_rescuer(struct workqueue_struct *wq)
4179{
4180 struct worker *rescuer;
4181 int ret;
4182
4183 if (!(wq->flags & WQ_MEM_RECLAIM))
4184 return 0;
4185
4186 rescuer = alloc_worker(NUMA_NO_NODE);
4187 if (!rescuer)
4188 return -ENOMEM;
4189
4190 rescuer->rescue_wq = wq;
4191 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4192 ret = PTR_ERR_OR_ZERO(rescuer->task);
4193 if (ret) {
4194 kfree(rescuer);
4195 return ret;
4196 }
4197
4198 wq->rescuer = rescuer;
4199 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4200 wake_up_process(rescuer->task);
4201
4202 return 0;
4203}
4204
Bart Van Assche669de8b2019-02-14 15:00:54 -08004205struct workqueue_struct *alloc_workqueue(const char *fmt,
4206 unsigned int flags,
4207 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004208{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004209 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004210 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004211 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004212 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004213
Tejun Heo5c0338c2017-07-18 18:41:52 -04004214 /*
4215 * Unbound && max_active == 1 used to imply ordered, which is no
4216 * longer the case on NUMA machines due to per-node pools. While
4217 * alloc_ordered_workqueue() is the right way to create an ordered
4218 * workqueue, keep the previous behavior to avoid subtle breakages
4219 * on NUMA.
4220 */
4221 if ((flags & WQ_UNBOUND) && max_active == 1)
4222 flags |= __WQ_ORDERED;
4223
Viresh Kumarcee22a12013-04-08 16:45:40 +05304224 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4225 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4226 flags |= WQ_UNBOUND;
4227
Tejun Heoecf68812013-04-01 11:23:34 -07004228 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004229 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004230 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004231
4232 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004233 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004234 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004235
Tejun Heo6029a912013-04-01 11:23:34 -07004236 if (flags & WQ_UNBOUND) {
4237 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4238 if (!wq->unbound_attrs)
4239 goto err_free_wq;
4240 }
4241
Bart Van Assche669de8b2019-02-14 15:00:54 -08004242 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004243 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004244 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004245
Tejun Heod320c032010-06-29 10:07:14 +02004246 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004247 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004248
Tejun Heob196be82012-01-10 15:11:35 -08004249 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004250 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004251 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004252 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004253 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004254 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004255 INIT_LIST_HEAD(&wq->flusher_queue);
4256 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004257 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004258
Bart Van Assche669de8b2019-02-14 15:00:54 -08004259 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004260 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004261
Tejun Heo30cdf2492013-03-12 11:29:57 -07004262 if (alloc_and_link_pwqs(wq) < 0)
Bart Van Assche82efcab2019-03-11 16:02:55 -07004263 goto err_unreg_lockdep;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004264
Tejun Heo40c17f72018-01-08 05:38:37 -08004265 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004266 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004267
Tejun Heo226223a2013-03-12 11:30:05 -07004268 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4269 goto err_destroy;
4270
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004271 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004272 * wq_pool_mutex protects global freeze state and workqueues list.
4273 * Grab it, adjust max_active and add the new @wq to workqueues
4274 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004275 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004276 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004277
Lai Jiangshana357fc02013-03-25 16:57:19 -07004278 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004279 for_each_pwq(pwq, wq)
4280 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004281 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004282
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004283 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004284
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004285 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004286
Oleg Nesterov3af244332007-05-09 02:34:09 -07004287 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004288
Bart Van Assche82efcab2019-03-11 16:02:55 -07004289err_unreg_lockdep:
Bart Van Assche009bb422019-03-03 14:00:46 -08004290 wq_unregister_lockdep(wq);
4291 wq_free_lockdep(wq);
Bart Van Assche82efcab2019-03-11 16:02:55 -07004292err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004293 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004294 kfree(wq);
4295 return NULL;
4296err_destroy:
4297 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004298 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004299}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004300EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004301
4302/**
4303 * destroy_workqueue - safely terminate a workqueue
4304 * @wq: target workqueue
4305 *
4306 * Safely destroy a workqueue. All work currently pending will be done first.
4307 */
4308void destroy_workqueue(struct workqueue_struct *wq)
4309{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004310 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004311 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004312
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004313 /* drain it before proceeding with destruction */
4314 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004315
Tejun Heo6183c002013-03-12 11:29:57 -07004316 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004317 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004318 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004319 int i;
4320
Tejun Heo76af4d92013-03-12 11:30:00 -07004321 for (i = 0; i < WORK_NR_COLORS; i++) {
4322 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004323 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004324 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004325 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004326 }
4327 }
4328
Lai Jiangshan5c529592013-04-04 10:05:38 +08004329 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004330 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004331 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004332 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004333 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004334 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004335 }
Tejun Heo6183c002013-03-12 11:29:57 -07004336 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004337 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004338
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004339 /*
4340 * wq list is used to freeze wq, remove from list after
4341 * flushing is complete in case freeze races us.
4342 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004343 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004344 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004345 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004346
Tejun Heo226223a2013-03-12 11:30:05 -07004347 workqueue_sysfs_unregister(wq);
4348
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004349 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004350 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004351
Tejun Heo8864b4e2013-03-12 11:30:04 -07004352 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004353 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004354 /*
4355 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004356 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004357 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004358 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004359 } else {
4360 /*
4361 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004362 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4363 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004364 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004365 for_each_node(node) {
4366 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4367 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4368 put_pwq_unlocked(pwq);
4369 }
4370
4371 /*
4372 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4373 * put. Don't access it afterwards.
4374 */
4375 pwq = wq->dfl_pwq;
4376 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004377 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004378 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004379}
4380EXPORT_SYMBOL_GPL(destroy_workqueue);
4381
Tejun Heodcd989c2010-06-29 10:07:14 +02004382/**
4383 * workqueue_set_max_active - adjust max_active of a workqueue
4384 * @wq: target workqueue
4385 * @max_active: new max_active value.
4386 *
4387 * Set max_active of @wq to @max_active.
4388 *
4389 * CONTEXT:
4390 * Don't call from IRQ context.
4391 */
4392void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4393{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004394 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004395
Tejun Heo8719dce2013-03-12 11:30:04 -07004396 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004397 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004398 return;
4399
Tejun Heof3421792010-07-02 10:03:51 +02004400 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004401
Lai Jiangshana357fc02013-03-25 16:57:19 -07004402 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004403
Tejun Heo0a94efb2017-07-23 08:36:15 -04004404 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004405 wq->saved_max_active = max_active;
4406
Tejun Heo699ce092013-03-13 16:51:35 -07004407 for_each_pwq(pwq, wq)
4408 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004409
Lai Jiangshana357fc02013-03-25 16:57:19 -07004410 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004411}
4412EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4413
4414/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004415 * current_work - retrieve %current task's work struct
4416 *
4417 * Determine if %current task is a workqueue worker and what it's working on.
4418 * Useful to find out the context that the %current task is running in.
4419 *
4420 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4421 */
4422struct work_struct *current_work(void)
4423{
4424 struct worker *worker = current_wq_worker();
4425
4426 return worker ? worker->current_work : NULL;
4427}
4428EXPORT_SYMBOL(current_work);
4429
4430/**
Tejun Heoe62676162013-03-12 17:41:37 -07004431 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4432 *
4433 * Determine whether %current is a workqueue rescuer. Can be used from
4434 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004435 *
4436 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004437 */
4438bool current_is_workqueue_rescuer(void)
4439{
4440 struct worker *worker = current_wq_worker();
4441
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004442 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004443}
4444
4445/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004446 * workqueue_congested - test whether a workqueue is congested
4447 * @cpu: CPU in question
4448 * @wq: target workqueue
4449 *
4450 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4451 * no synchronization around this function and the test result is
4452 * unreliable and only useful as advisory hints or for debugging.
4453 *
Tejun Heod3251852013-05-10 11:10:17 -07004454 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4455 * Note that both per-cpu and unbound workqueues may be associated with
4456 * multiple pool_workqueues which have separate congested states. A
4457 * workqueue being congested on one CPU doesn't mean the workqueue is also
4458 * contested on other CPUs / NUMA nodes.
4459 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004460 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004461 * %true if congested, %false otherwise.
4462 */
Tejun Heod84ff052013-03-12 11:29:59 -07004463bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004464{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004465 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004466 bool ret;
4467
Lai Jiangshan88109452013-03-20 03:28:10 +08004468 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004469
Tejun Heod3251852013-05-10 11:10:17 -07004470 if (cpu == WORK_CPU_UNBOUND)
4471 cpu = smp_processor_id();
4472
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004473 if (!(wq->flags & WQ_UNBOUND))
4474 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4475 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004476 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004477
Tejun Heo76af4d92013-03-12 11:30:00 -07004478 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004479 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004480
4481 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004482}
4483EXPORT_SYMBOL_GPL(workqueue_congested);
4484
4485/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004486 * work_busy - test whether a work is currently pending or running
4487 * @work: the work to be tested
4488 *
4489 * Test whether @work is currently pending or running. There is no
4490 * synchronization around this function and the test result is
4491 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004492 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004493 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004494 * OR'd bitmask of WORK_BUSY_* bits.
4495 */
4496unsigned int work_busy(struct work_struct *work)
4497{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004498 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004499 unsigned long flags;
4500 unsigned int ret = 0;
4501
Tejun Heodcd989c2010-06-29 10:07:14 +02004502 if (work_pending(work))
4503 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004504
Tejun Heofa1b54e2013-03-12 11:30:00 -07004505 local_irq_save(flags);
4506 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004507 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004508 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004509 if (find_worker_executing_work(pool, work))
4510 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004511 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004512 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004513 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004514
4515 return ret;
4516}
4517EXPORT_SYMBOL_GPL(work_busy);
4518
Tejun Heo3d1cb202013-04-30 15:27:22 -07004519/**
4520 * set_worker_desc - set description for the current work item
4521 * @fmt: printf-style format string
4522 * @...: arguments for the format string
4523 *
4524 * This function can be called by a running work function to describe what
4525 * the work item is about. If the worker task gets dumped, this
4526 * information will be printed out together to help debugging. The
4527 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4528 */
4529void set_worker_desc(const char *fmt, ...)
4530{
4531 struct worker *worker = current_wq_worker();
4532 va_list args;
4533
4534 if (worker) {
4535 va_start(args, fmt);
4536 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4537 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004538 }
4539}
Steffen Maier5c750d52018-05-17 19:14:57 +02004540EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004541
4542/**
4543 * print_worker_info - print out worker information and description
4544 * @log_lvl: the log level to use when printing
4545 * @task: target task
4546 *
4547 * If @task is a worker and currently executing a work item, print out the
4548 * name of the workqueue being serviced and worker description set with
4549 * set_worker_desc() by the currently executing work item.
4550 *
4551 * This function can be safely called on any task as long as the
4552 * task_struct itself is accessible. While safe, this function isn't
4553 * synchronized and may print out mixups or garbages of limited length.
4554 */
4555void print_worker_info(const char *log_lvl, struct task_struct *task)
4556{
4557 work_func_t *fn = NULL;
4558 char name[WQ_NAME_LEN] = { };
4559 char desc[WORKER_DESC_LEN] = { };
4560 struct pool_workqueue *pwq = NULL;
4561 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004562 struct worker *worker;
4563
4564 if (!(task->flags & PF_WQ_WORKER))
4565 return;
4566
4567 /*
4568 * This function is called without any synchronization and @task
4569 * could be in any state. Be careful with dereferences.
4570 */
Petr Mladeke7005912016-10-11 13:55:17 -07004571 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004572
4573 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004574 * Carefully copy the associated workqueue's workfn, name and desc.
4575 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004576 */
4577 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4578 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4579 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4580 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004581 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004582
4583 if (fn || name[0] || desc[0]) {
4584 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004585 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004586 pr_cont(" (%s)", desc);
4587 pr_cont("\n");
4588 }
4589}
4590
Tejun Heo3494fc32015-03-09 09:22:28 -04004591static void pr_cont_pool_info(struct worker_pool *pool)
4592{
4593 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4594 if (pool->node != NUMA_NO_NODE)
4595 pr_cont(" node=%d", pool->node);
4596 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4597}
4598
4599static void pr_cont_work(bool comma, struct work_struct *work)
4600{
4601 if (work->func == wq_barrier_func) {
4602 struct wq_barrier *barr;
4603
4604 barr = container_of(work, struct wq_barrier, work);
4605
4606 pr_cont("%s BAR(%d)", comma ? "," : "",
4607 task_pid_nr(barr->task));
4608 } else {
4609 pr_cont("%s %pf", comma ? "," : "", work->func);
4610 }
4611}
4612
4613static void show_pwq(struct pool_workqueue *pwq)
4614{
4615 struct worker_pool *pool = pwq->pool;
4616 struct work_struct *work;
4617 struct worker *worker;
4618 bool has_in_flight = false, has_pending = false;
4619 int bkt;
4620
4621 pr_info(" pwq %d:", pool->id);
4622 pr_cont_pool_info(pool);
4623
4624 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4625 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4626
4627 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4628 if (worker->current_pwq == pwq) {
4629 has_in_flight = true;
4630 break;
4631 }
4632 }
4633 if (has_in_flight) {
4634 bool comma = false;
4635
4636 pr_info(" in-flight:");
4637 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4638 if (worker->current_pwq != pwq)
4639 continue;
4640
4641 pr_cont("%s %d%s:%pf", comma ? "," : "",
4642 task_pid_nr(worker->task),
4643 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4644 worker->current_func);
4645 list_for_each_entry(work, &worker->scheduled, entry)
4646 pr_cont_work(false, work);
4647 comma = true;
4648 }
4649 pr_cont("\n");
4650 }
4651
4652 list_for_each_entry(work, &pool->worklist, entry) {
4653 if (get_work_pwq(work) == pwq) {
4654 has_pending = true;
4655 break;
4656 }
4657 }
4658 if (has_pending) {
4659 bool comma = false;
4660
4661 pr_info(" pending:");
4662 list_for_each_entry(work, &pool->worklist, entry) {
4663 if (get_work_pwq(work) != pwq)
4664 continue;
4665
4666 pr_cont_work(comma, work);
4667 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4668 }
4669 pr_cont("\n");
4670 }
4671
4672 if (!list_empty(&pwq->delayed_works)) {
4673 bool comma = false;
4674
4675 pr_info(" delayed:");
4676 list_for_each_entry(work, &pwq->delayed_works, entry) {
4677 pr_cont_work(comma, work);
4678 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4679 }
4680 pr_cont("\n");
4681 }
4682}
4683
4684/**
4685 * show_workqueue_state - dump workqueue state
4686 *
Roger Lu7b776af2016-07-01 11:05:02 +08004687 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4688 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004689 */
4690void show_workqueue_state(void)
4691{
4692 struct workqueue_struct *wq;
4693 struct worker_pool *pool;
4694 unsigned long flags;
4695 int pi;
4696
4697 rcu_read_lock_sched();
4698
4699 pr_info("Showing busy workqueues and worker pools:\n");
4700
4701 list_for_each_entry_rcu(wq, &workqueues, list) {
4702 struct pool_workqueue *pwq;
4703 bool idle = true;
4704
4705 for_each_pwq(pwq, wq) {
4706 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4707 idle = false;
4708 break;
4709 }
4710 }
4711 if (idle)
4712 continue;
4713
4714 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4715
4716 for_each_pwq(pwq, wq) {
4717 spin_lock_irqsave(&pwq->pool->lock, flags);
4718 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4719 show_pwq(pwq);
4720 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004721 /*
4722 * We could be printing a lot from atomic context, e.g.
4723 * sysrq-t -> show_workqueue_state(). Avoid triggering
4724 * hard lockup.
4725 */
4726 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004727 }
4728 }
4729
4730 for_each_pool(pool, pi) {
4731 struct worker *worker;
4732 bool first = true;
4733
4734 spin_lock_irqsave(&pool->lock, flags);
4735 if (pool->nr_workers == pool->nr_idle)
4736 goto next_pool;
4737
4738 pr_info("pool %d:", pool->id);
4739 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004740 pr_cont(" hung=%us workers=%d",
4741 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4742 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004743 if (pool->manager)
4744 pr_cont(" manager: %d",
4745 task_pid_nr(pool->manager->task));
4746 list_for_each_entry(worker, &pool->idle_list, entry) {
4747 pr_cont(" %s%d", first ? "idle: " : "",
4748 task_pid_nr(worker->task));
4749 first = false;
4750 }
4751 pr_cont("\n");
4752 next_pool:
4753 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004754 /*
4755 * We could be printing a lot from atomic context, e.g.
4756 * sysrq-t -> show_workqueue_state(). Avoid triggering
4757 * hard lockup.
4758 */
4759 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004760 }
4761
4762 rcu_read_unlock_sched();
4763}
4764
Tejun Heo6b598082018-05-18 08:47:13 -07004765/* used to show worker information through /proc/PID/{comm,stat,status} */
4766void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4767{
Tejun Heo6b598082018-05-18 08:47:13 -07004768 int off;
4769
4770 /* always show the actual comm */
4771 off = strscpy(buf, task->comm, size);
4772 if (off < 0)
4773 return;
4774
Tejun Heo197f6ac2018-05-21 08:04:35 -07004775 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004776 mutex_lock(&wq_pool_attach_mutex);
4777
Tejun Heo197f6ac2018-05-21 08:04:35 -07004778 if (task->flags & PF_WQ_WORKER) {
4779 struct worker *worker = kthread_data(task);
4780 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004781
Tejun Heo197f6ac2018-05-21 08:04:35 -07004782 if (pool) {
4783 spin_lock_irq(&pool->lock);
4784 /*
4785 * ->desc tracks information (wq name or
4786 * set_worker_desc()) for the latest execution. If
4787 * current, prepend '+', otherwise '-'.
4788 */
4789 if (worker->desc[0] != '\0') {
4790 if (worker->current_work)
4791 scnprintf(buf + off, size - off, "+%s",
4792 worker->desc);
4793 else
4794 scnprintf(buf + off, size - off, "-%s",
4795 worker->desc);
4796 }
4797 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004798 }
Tejun Heo6b598082018-05-18 08:47:13 -07004799 }
4800
4801 mutex_unlock(&wq_pool_attach_mutex);
4802}
4803
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004804#ifdef CONFIG_SMP
4805
Tejun Heodb7bccf2010-06-29 10:07:12 +02004806/*
4807 * CPU hotplug.
4808 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004809 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004810 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004811 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004812 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004813 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004814 * blocked draining impractical.
4815 *
Tejun Heo24647572013-01-24 11:01:33 -08004816 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004817 * running as an unbound one and allowing it to be reattached later if the
4818 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004819 */
4820
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004821static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004822{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004823 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004824 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004825
Tejun Heof02ae732013-03-12 11:30:03 -07004826 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004827 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004828 spin_lock_irq(&pool->lock);
4829
4830 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004831 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004832 * unbound and set DISASSOCIATED. Before this, all workers
4833 * except for the ones which are still executing works from
4834 * before the last CPU down must be on the cpu. After
4835 * this, they may become diasporas.
4836 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004837 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004838 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004839
Tejun Heo24647572013-01-24 11:01:33 -08004840 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004841
Tejun Heo94cf58b2013-01-24 11:01:33 -08004842 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004843 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004844
Lai Jiangshaneb283422013-03-08 15:18:28 -08004845 /*
4846 * Call schedule() so that we cross rq->lock and thus can
4847 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4848 * This is necessary as scheduler callbacks may be invoked
4849 * from other cpus.
4850 */
4851 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004852
Lai Jiangshaneb283422013-03-08 15:18:28 -08004853 /*
4854 * Sched callbacks are disabled now. Zap nr_running.
4855 * After this, nr_running stays zero and need_more_worker()
4856 * and keep_working() are always true as long as the
4857 * worklist is not empty. This pool now behaves as an
4858 * unbound (in terms of concurrency management) pool which
4859 * are served by workers tied to the pool.
4860 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004861 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004862
4863 /*
4864 * With concurrency management just turned off, a busy
4865 * worker blocking could lead to lengthy stalls. Kick off
4866 * unbound chain execution of currently pending work items.
4867 */
4868 spin_lock_irq(&pool->lock);
4869 wake_up_worker(pool);
4870 spin_unlock_irq(&pool->lock);
4871 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004872}
4873
Tejun Heobd7c0892013-03-19 13:45:21 -07004874/**
4875 * rebind_workers - rebind all workers of a pool to the associated CPU
4876 * @pool: pool of interest
4877 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004878 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004879 */
4880static void rebind_workers(struct worker_pool *pool)
4881{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004882 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004883
Tejun Heo1258fae2018-05-18 08:47:13 -07004884 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004885
Tejun Heoa9ab7752013-03-19 13:45:21 -07004886 /*
4887 * Restore CPU affinity of all workers. As all idle workers should
4888 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304889 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004890 * of all workers first and then clear UNBOUND. As we're called
4891 * from CPU_ONLINE, the following shouldn't fail.
4892 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004893 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004894 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4895 pool->attrs->cpumask) < 0);
4896
4897 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004898
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004899 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004900
Lai Jiangshanda028462014-05-20 17:46:31 +08004901 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004902 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004903
4904 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004905 * A bound idle worker should actually be on the runqueue
4906 * of the associated CPU for local wake-ups targeting it to
4907 * work. Kick all idle workers so that they migrate to the
4908 * associated CPU. Doing this in the same loop as
4909 * replacing UNBOUND with REBOUND is safe as no worker will
4910 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004911 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004912 if (worker_flags & WORKER_IDLE)
4913 wake_up_process(worker->task);
4914
4915 /*
4916 * We want to clear UNBOUND but can't directly call
4917 * worker_clr_flags() or adjust nr_running. Atomically
4918 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4919 * @worker will clear REBOUND using worker_clr_flags() when
4920 * it initiates the next execution cycle thus restoring
4921 * concurrency management. Note that when or whether
4922 * @worker clears REBOUND doesn't affect correctness.
4923 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004924 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004925 * tested without holding any lock in
Thomas Gleixner6d25be52019-03-13 17:55:48 +01004926 * wq_worker_running(). Without it, NOT_RUNNING test may
Tejun Heoa9ab7752013-03-19 13:45:21 -07004927 * fail incorrectly leading to premature concurrency
4928 * management operations.
4929 */
4930 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4931 worker_flags |= WORKER_REBOUND;
4932 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004933 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004934 }
4935
Tejun Heoa9ab7752013-03-19 13:45:21 -07004936 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004937}
4938
Tejun Heo7dbc7252013-03-19 13:45:21 -07004939/**
4940 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4941 * @pool: unbound pool of interest
4942 * @cpu: the CPU which is coming up
4943 *
4944 * An unbound pool may end up with a cpumask which doesn't have any online
4945 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4946 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4947 * online CPU before, cpus_allowed of all its workers should be restored.
4948 */
4949static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4950{
4951 static cpumask_t cpumask;
4952 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004953
Tejun Heo1258fae2018-05-18 08:47:13 -07004954 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004955
4956 /* is @cpu allowed for @pool? */
4957 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4958 return;
4959
Tejun Heo7dbc7252013-03-19 13:45:21 -07004960 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004961
4962 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004963 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004964 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004965}
4966
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004967int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004968{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004969 struct worker_pool *pool;
4970
4971 for_each_cpu_worker_pool(pool, cpu) {
4972 if (pool->nr_workers)
4973 continue;
4974 if (!create_worker(pool))
4975 return -ENOMEM;
4976 }
4977 return 0;
4978}
4979
4980int workqueue_online_cpu(unsigned int cpu)
4981{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004982 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004983 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004984 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004985
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004986 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004987
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004988 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004989 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004990
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004991 if (pool->cpu == cpu)
4992 rebind_workers(pool);
4993 else if (pool->cpu < 0)
4994 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004995
Tejun Heo1258fae2018-05-18 08:47:13 -07004996 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004997 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004998
4999 /* update NUMA affinity of unbound workqueues */
5000 list_for_each_entry(wq, &workqueues, list)
5001 wq_update_unbound_numa(wq, cpu, true);
5002
5003 mutex_unlock(&wq_pool_mutex);
5004 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005005}
5006
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005007int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005008{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005009 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005010
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005011 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005012 if (WARN_ON(cpu != smp_processor_id()))
5013 return -1;
5014
5015 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005016
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005017 /* update NUMA affinity of unbound workqueues */
5018 mutex_lock(&wq_pool_mutex);
5019 list_for_each_entry(wq, &workqueues, list)
5020 wq_update_unbound_numa(wq, cpu, false);
5021 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005022
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005023 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005024}
5025
Rusty Russell2d3854a2008-11-05 13:39:10 +11005026struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005027 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005028 long (*fn)(void *);
5029 void *arg;
5030 long ret;
5031};
5032
Tejun Heoed48ece2012-09-18 12:48:43 -07005033static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005034{
Tejun Heoed48ece2012-09-18 12:48:43 -07005035 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5036
Rusty Russell2d3854a2008-11-05 13:39:10 +11005037 wfc->ret = wfc->fn(wfc->arg);
5038}
5039
5040/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005041 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005042 * @cpu: the cpu to run on
5043 * @fn: the function to run
5044 * @arg: the function arg
5045 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005046 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005047 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005048 *
5049 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005050 */
Tejun Heod84ff052013-03-12 11:29:59 -07005051long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005052{
Tejun Heoed48ece2012-09-18 12:48:43 -07005053 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005054
Tejun Heoed48ece2012-09-18 12:48:43 -07005055 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5056 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005057 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005058 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005059 return wfc.ret;
5060}
5061EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005062
5063/**
5064 * work_on_cpu_safe - run a function in thread context on a particular cpu
5065 * @cpu: the cpu to run on
5066 * @fn: the function to run
5067 * @arg: the function argument
5068 *
5069 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5070 * any locks which would prevent @fn from completing.
5071 *
5072 * Return: The value @fn returns.
5073 */
5074long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5075{
5076 long ret = -ENODEV;
5077
5078 get_online_cpus();
5079 if (cpu_online(cpu))
5080 ret = work_on_cpu(cpu, fn, arg);
5081 put_online_cpus();
5082 return ret;
5083}
5084EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005085#endif /* CONFIG_SMP */
5086
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005087#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305088
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005089/**
5090 * freeze_workqueues_begin - begin freezing workqueues
5091 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005092 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005093 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005094 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005095 *
5096 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005097 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005098 */
5099void freeze_workqueues_begin(void)
5100{
Tejun Heo24b8a842013-03-12 11:29:58 -07005101 struct workqueue_struct *wq;
5102 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005103
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005104 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005105
Tejun Heo6183c002013-03-12 11:29:57 -07005106 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005107 workqueue_freezing = true;
5108
Tejun Heo24b8a842013-03-12 11:29:58 -07005109 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005110 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005111 for_each_pwq(pwq, wq)
5112 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005113 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005114 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005115
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005116 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005117}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005118
5119/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005120 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005121 *
5122 * Check whether freezing is complete. This function must be called
5123 * between freeze_workqueues_begin() and thaw_workqueues().
5124 *
5125 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005126 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005127 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005128 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005129 * %true if some freezable workqueues are still busy. %false if freezing
5130 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005131 */
5132bool freeze_workqueues_busy(void)
5133{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005134 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005135 struct workqueue_struct *wq;
5136 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005137
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005138 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005139
Tejun Heo6183c002013-03-12 11:29:57 -07005140 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005141
Tejun Heo24b8a842013-03-12 11:29:58 -07005142 list_for_each_entry(wq, &workqueues, list) {
5143 if (!(wq->flags & WQ_FREEZABLE))
5144 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005145 /*
5146 * nr_active is monotonically decreasing. It's safe
5147 * to peek without lock.
5148 */
Lai Jiangshan88109452013-03-20 03:28:10 +08005149 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07005150 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005151 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005152 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005153 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08005154 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005155 goto out_unlock;
5156 }
5157 }
Lai Jiangshan88109452013-03-20 03:28:10 +08005158 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005159 }
5160out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005161 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005162 return busy;
5163}
5164
5165/**
5166 * thaw_workqueues - thaw workqueues
5167 *
5168 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005169 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005170 *
5171 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005172 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005173 */
5174void thaw_workqueues(void)
5175{
Tejun Heo24b8a842013-03-12 11:29:58 -07005176 struct workqueue_struct *wq;
5177 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005178
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005179 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005180
5181 if (!workqueue_freezing)
5182 goto out_unlock;
5183
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005184 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005185
Tejun Heo24b8a842013-03-12 11:29:58 -07005186 /* restore max_active and repopulate worklist */
5187 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005188 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005189 for_each_pwq(pwq, wq)
5190 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005191 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005192 }
5193
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005194out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005195 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005196}
5197#endif /* CONFIG_FREEZER */
5198
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005199static int workqueue_apply_unbound_cpumask(void)
5200{
5201 LIST_HEAD(ctxs);
5202 int ret = 0;
5203 struct workqueue_struct *wq;
5204 struct apply_wqattrs_ctx *ctx, *n;
5205
5206 lockdep_assert_held(&wq_pool_mutex);
5207
5208 list_for_each_entry(wq, &workqueues, list) {
5209 if (!(wq->flags & WQ_UNBOUND))
5210 continue;
5211 /* creating multiple pwqs breaks ordering guarantee */
5212 if (wq->flags & __WQ_ORDERED)
5213 continue;
5214
5215 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5216 if (!ctx) {
5217 ret = -ENOMEM;
5218 break;
5219 }
5220
5221 list_add_tail(&ctx->list, &ctxs);
5222 }
5223
5224 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5225 if (!ret)
5226 apply_wqattrs_commit(ctx);
5227 apply_wqattrs_cleanup(ctx);
5228 }
5229
5230 return ret;
5231}
5232
5233/**
5234 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5235 * @cpumask: the cpumask to set
5236 *
5237 * The low-level workqueues cpumask is a global cpumask that limits
5238 * the affinity of all unbound workqueues. This function check the @cpumask
5239 * and apply it to all unbound workqueues and updates all pwqs of them.
5240 *
5241 * Retun: 0 - Success
5242 * -EINVAL - Invalid @cpumask
5243 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5244 */
5245int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5246{
5247 int ret = -EINVAL;
5248 cpumask_var_t saved_cpumask;
5249
5250 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5251 return -ENOMEM;
5252
Tal Shorerc98a9802017-11-03 17:27:50 +02005253 /*
5254 * Not excluding isolated cpus on purpose.
5255 * If the user wishes to include them, we allow that.
5256 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005257 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5258 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005259 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005260
5261 /* save the old wq_unbound_cpumask. */
5262 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5263
5264 /* update wq_unbound_cpumask at first and apply it to wqs. */
5265 cpumask_copy(wq_unbound_cpumask, cpumask);
5266 ret = workqueue_apply_unbound_cpumask();
5267
5268 /* restore the wq_unbound_cpumask when failed. */
5269 if (ret < 0)
5270 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5271
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005272 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005273 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005274
5275 free_cpumask_var(saved_cpumask);
5276 return ret;
5277}
5278
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005279#ifdef CONFIG_SYSFS
5280/*
5281 * Workqueues with WQ_SYSFS flag set is visible to userland via
5282 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5283 * following attributes.
5284 *
5285 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5286 * max_active RW int : maximum number of in-flight work items
5287 *
5288 * Unbound workqueues have the following extra attributes.
5289 *
Wang Long9a19b462017-11-02 23:05:12 -04005290 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005291 * nice RW int : nice value of the workers
5292 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005293 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005294 */
5295struct wq_device {
5296 struct workqueue_struct *wq;
5297 struct device dev;
5298};
5299
5300static struct workqueue_struct *dev_to_wq(struct device *dev)
5301{
5302 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5303
5304 return wq_dev->wq;
5305}
5306
5307static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5308 char *buf)
5309{
5310 struct workqueue_struct *wq = dev_to_wq(dev);
5311
5312 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5313}
5314static DEVICE_ATTR_RO(per_cpu);
5315
5316static ssize_t max_active_show(struct device *dev,
5317 struct device_attribute *attr, char *buf)
5318{
5319 struct workqueue_struct *wq = dev_to_wq(dev);
5320
5321 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5322}
5323
5324static ssize_t max_active_store(struct device *dev,
5325 struct device_attribute *attr, const char *buf,
5326 size_t count)
5327{
5328 struct workqueue_struct *wq = dev_to_wq(dev);
5329 int val;
5330
5331 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5332 return -EINVAL;
5333
5334 workqueue_set_max_active(wq, val);
5335 return count;
5336}
5337static DEVICE_ATTR_RW(max_active);
5338
5339static struct attribute *wq_sysfs_attrs[] = {
5340 &dev_attr_per_cpu.attr,
5341 &dev_attr_max_active.attr,
5342 NULL,
5343};
5344ATTRIBUTE_GROUPS(wq_sysfs);
5345
5346static ssize_t wq_pool_ids_show(struct device *dev,
5347 struct device_attribute *attr, char *buf)
5348{
5349 struct workqueue_struct *wq = dev_to_wq(dev);
5350 const char *delim = "";
5351 int node, written = 0;
5352
5353 rcu_read_lock_sched();
5354 for_each_node(node) {
5355 written += scnprintf(buf + written, PAGE_SIZE - written,
5356 "%s%d:%d", delim, node,
5357 unbound_pwq_by_node(wq, node)->pool->id);
5358 delim = " ";
5359 }
5360 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5361 rcu_read_unlock_sched();
5362
5363 return written;
5364}
5365
5366static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5367 char *buf)
5368{
5369 struct workqueue_struct *wq = dev_to_wq(dev);
5370 int written;
5371
5372 mutex_lock(&wq->mutex);
5373 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5374 mutex_unlock(&wq->mutex);
5375
5376 return written;
5377}
5378
5379/* prepare workqueue_attrs for sysfs store operations */
5380static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5381{
5382 struct workqueue_attrs *attrs;
5383
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005384 lockdep_assert_held(&wq_pool_mutex);
5385
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005386 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5387 if (!attrs)
5388 return NULL;
5389
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005390 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005391 return attrs;
5392}
5393
5394static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5395 const char *buf, size_t count)
5396{
5397 struct workqueue_struct *wq = dev_to_wq(dev);
5398 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005399 int ret = -ENOMEM;
5400
5401 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005402
5403 attrs = wq_sysfs_prep_attrs(wq);
5404 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005405 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005406
5407 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5408 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005409 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005410 else
5411 ret = -EINVAL;
5412
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005413out_unlock:
5414 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005415 free_workqueue_attrs(attrs);
5416 return ret ?: count;
5417}
5418
5419static ssize_t wq_cpumask_show(struct device *dev,
5420 struct device_attribute *attr, char *buf)
5421{
5422 struct workqueue_struct *wq = dev_to_wq(dev);
5423 int written;
5424
5425 mutex_lock(&wq->mutex);
5426 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5427 cpumask_pr_args(wq->unbound_attrs->cpumask));
5428 mutex_unlock(&wq->mutex);
5429 return written;
5430}
5431
5432static ssize_t wq_cpumask_store(struct device *dev,
5433 struct device_attribute *attr,
5434 const char *buf, size_t count)
5435{
5436 struct workqueue_struct *wq = dev_to_wq(dev);
5437 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005438 int ret = -ENOMEM;
5439
5440 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005441
5442 attrs = wq_sysfs_prep_attrs(wq);
5443 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005444 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005445
5446 ret = cpumask_parse(buf, attrs->cpumask);
5447 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005448 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005449
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005450out_unlock:
5451 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005452 free_workqueue_attrs(attrs);
5453 return ret ?: count;
5454}
5455
5456static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5457 char *buf)
5458{
5459 struct workqueue_struct *wq = dev_to_wq(dev);
5460 int written;
5461
5462 mutex_lock(&wq->mutex);
5463 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5464 !wq->unbound_attrs->no_numa);
5465 mutex_unlock(&wq->mutex);
5466
5467 return written;
5468}
5469
5470static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5471 const char *buf, size_t count)
5472{
5473 struct workqueue_struct *wq = dev_to_wq(dev);
5474 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005475 int v, ret = -ENOMEM;
5476
5477 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005478
5479 attrs = wq_sysfs_prep_attrs(wq);
5480 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005481 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005482
5483 ret = -EINVAL;
5484 if (sscanf(buf, "%d", &v) == 1) {
5485 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005486 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005487 }
5488
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005489out_unlock:
5490 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005491 free_workqueue_attrs(attrs);
5492 return ret ?: count;
5493}
5494
5495static struct device_attribute wq_sysfs_unbound_attrs[] = {
5496 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5497 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5498 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5499 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5500 __ATTR_NULL,
5501};
5502
5503static struct bus_type wq_subsys = {
5504 .name = "workqueue",
5505 .dev_groups = wq_sysfs_groups,
5506};
5507
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005508static ssize_t wq_unbound_cpumask_show(struct device *dev,
5509 struct device_attribute *attr, char *buf)
5510{
5511 int written;
5512
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005513 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005514 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5515 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005516 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005517
5518 return written;
5519}
5520
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005521static ssize_t wq_unbound_cpumask_store(struct device *dev,
5522 struct device_attribute *attr, const char *buf, size_t count)
5523{
5524 cpumask_var_t cpumask;
5525 int ret;
5526
5527 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5528 return -ENOMEM;
5529
5530 ret = cpumask_parse(buf, cpumask);
5531 if (!ret)
5532 ret = workqueue_set_unbound_cpumask(cpumask);
5533
5534 free_cpumask_var(cpumask);
5535 return ret ? ret : count;
5536}
5537
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005538static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005539 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5540 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005541
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005542static int __init wq_sysfs_init(void)
5543{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005544 int err;
5545
5546 err = subsys_virtual_register(&wq_subsys, NULL);
5547 if (err)
5548 return err;
5549
5550 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005551}
5552core_initcall(wq_sysfs_init);
5553
5554static void wq_device_release(struct device *dev)
5555{
5556 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5557
5558 kfree(wq_dev);
5559}
5560
5561/**
5562 * workqueue_sysfs_register - make a workqueue visible in sysfs
5563 * @wq: the workqueue to register
5564 *
5565 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5566 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5567 * which is the preferred method.
5568 *
5569 * Workqueue user should use this function directly iff it wants to apply
5570 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5571 * apply_workqueue_attrs() may race against userland updating the
5572 * attributes.
5573 *
5574 * Return: 0 on success, -errno on failure.
5575 */
5576int workqueue_sysfs_register(struct workqueue_struct *wq)
5577{
5578 struct wq_device *wq_dev;
5579 int ret;
5580
5581 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305582 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005583 * attributes breaks ordering guarantee. Disallow exposing ordered
5584 * workqueues.
5585 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005586 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005587 return -EINVAL;
5588
5589 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5590 if (!wq_dev)
5591 return -ENOMEM;
5592
5593 wq_dev->wq = wq;
5594 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005595 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005596 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005597
5598 /*
5599 * unbound_attrs are created separately. Suppress uevent until
5600 * everything is ready.
5601 */
5602 dev_set_uevent_suppress(&wq_dev->dev, true);
5603
5604 ret = device_register(&wq_dev->dev);
5605 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305606 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005607 wq->wq_dev = NULL;
5608 return ret;
5609 }
5610
5611 if (wq->flags & WQ_UNBOUND) {
5612 struct device_attribute *attr;
5613
5614 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5615 ret = device_create_file(&wq_dev->dev, attr);
5616 if (ret) {
5617 device_unregister(&wq_dev->dev);
5618 wq->wq_dev = NULL;
5619 return ret;
5620 }
5621 }
5622 }
5623
5624 dev_set_uevent_suppress(&wq_dev->dev, false);
5625 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5626 return 0;
5627}
5628
5629/**
5630 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5631 * @wq: the workqueue to unregister
5632 *
5633 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5634 */
5635static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5636{
5637 struct wq_device *wq_dev = wq->wq_dev;
5638
5639 if (!wq->wq_dev)
5640 return;
5641
5642 wq->wq_dev = NULL;
5643 device_unregister(&wq_dev->dev);
5644}
5645#else /* CONFIG_SYSFS */
5646static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5647#endif /* CONFIG_SYSFS */
5648
Tejun Heo82607adc2015-12-08 11:28:04 -05005649/*
5650 * Workqueue watchdog.
5651 *
5652 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5653 * flush dependency, a concurrency managed work item which stays RUNNING
5654 * indefinitely. Workqueue stalls can be very difficult to debug as the
5655 * usual warning mechanisms don't trigger and internal workqueue state is
5656 * largely opaque.
5657 *
5658 * Workqueue watchdog monitors all worker pools periodically and dumps
5659 * state if some pools failed to make forward progress for a while where
5660 * forward progress is defined as the first item on ->worklist changing.
5661 *
5662 * This mechanism is controlled through the kernel parameter
5663 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5664 * corresponding sysfs parameter file.
5665 */
5666#ifdef CONFIG_WQ_WATCHDOG
5667
Tejun Heo82607adc2015-12-08 11:28:04 -05005668static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005669static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005670
5671static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5672static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5673
5674static void wq_watchdog_reset_touched(void)
5675{
5676 int cpu;
5677
5678 wq_watchdog_touched = jiffies;
5679 for_each_possible_cpu(cpu)
5680 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5681}
5682
Kees Cook5cd79d62017-10-04 16:27:00 -07005683static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005684{
5685 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5686 bool lockup_detected = false;
5687 struct worker_pool *pool;
5688 int pi;
5689
5690 if (!thresh)
5691 return;
5692
5693 rcu_read_lock();
5694
5695 for_each_pool(pool, pi) {
5696 unsigned long pool_ts, touched, ts;
5697
5698 if (list_empty(&pool->worklist))
5699 continue;
5700
5701 /* get the latest of pool and touched timestamps */
5702 pool_ts = READ_ONCE(pool->watchdog_ts);
5703 touched = READ_ONCE(wq_watchdog_touched);
5704
5705 if (time_after(pool_ts, touched))
5706 ts = pool_ts;
5707 else
5708 ts = touched;
5709
5710 if (pool->cpu >= 0) {
5711 unsigned long cpu_touched =
5712 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5713 pool->cpu));
5714 if (time_after(cpu_touched, ts))
5715 ts = cpu_touched;
5716 }
5717
5718 /* did we stall? */
5719 if (time_after(jiffies, ts + thresh)) {
5720 lockup_detected = true;
5721 pr_emerg("BUG: workqueue lockup - pool");
5722 pr_cont_pool_info(pool);
5723 pr_cont(" stuck for %us!\n",
5724 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5725 }
5726 }
5727
5728 rcu_read_unlock();
5729
5730 if (lockup_detected)
5731 show_workqueue_state();
5732
5733 wq_watchdog_reset_touched();
5734 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5735}
5736
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005737notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005738{
5739 if (cpu >= 0)
5740 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5741 else
5742 wq_watchdog_touched = jiffies;
5743}
5744
5745static void wq_watchdog_set_thresh(unsigned long thresh)
5746{
5747 wq_watchdog_thresh = 0;
5748 del_timer_sync(&wq_watchdog_timer);
5749
5750 if (thresh) {
5751 wq_watchdog_thresh = thresh;
5752 wq_watchdog_reset_touched();
5753 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5754 }
5755}
5756
5757static int wq_watchdog_param_set_thresh(const char *val,
5758 const struct kernel_param *kp)
5759{
5760 unsigned long thresh;
5761 int ret;
5762
5763 ret = kstrtoul(val, 0, &thresh);
5764 if (ret)
5765 return ret;
5766
5767 if (system_wq)
5768 wq_watchdog_set_thresh(thresh);
5769 else
5770 wq_watchdog_thresh = thresh;
5771
5772 return 0;
5773}
5774
5775static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5776 .set = wq_watchdog_param_set_thresh,
5777 .get = param_get_ulong,
5778};
5779
5780module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5781 0644);
5782
5783static void wq_watchdog_init(void)
5784{
Kees Cook5cd79d62017-10-04 16:27:00 -07005785 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005786 wq_watchdog_set_thresh(wq_watchdog_thresh);
5787}
5788
5789#else /* CONFIG_WQ_WATCHDOG */
5790
5791static inline void wq_watchdog_init(void) { }
5792
5793#endif /* CONFIG_WQ_WATCHDOG */
5794
Tejun Heobce90382013-04-01 11:23:32 -07005795static void __init wq_numa_init(void)
5796{
5797 cpumask_var_t *tbl;
5798 int node, cpu;
5799
Tejun Heobce90382013-04-01 11:23:32 -07005800 if (num_possible_nodes() <= 1)
5801 return;
5802
Tejun Heod55262c2013-04-01 11:23:38 -07005803 if (wq_disable_numa) {
5804 pr_info("workqueue: NUMA affinity support disabled\n");
5805 return;
5806 }
5807
Tejun Heo4c16bd32013-04-01 11:23:36 -07005808 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5809 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5810
Tejun Heobce90382013-04-01 11:23:32 -07005811 /*
5812 * We want masks of possible CPUs of each node which isn't readily
5813 * available. Build one from cpu_to_node() which should have been
5814 * fully initialized by now.
5815 */
Kees Cook6396bb22018-06-12 14:03:40 -07005816 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005817 BUG_ON(!tbl);
5818
5819 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005820 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005821 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005822
5823 for_each_possible_cpu(cpu) {
5824 node = cpu_to_node(cpu);
5825 if (WARN_ON(node == NUMA_NO_NODE)) {
5826 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5827 /* happens iff arch is bonkers, let's just proceed */
5828 return;
5829 }
5830 cpumask_set_cpu(cpu, tbl[node]);
5831 }
5832
5833 wq_numa_possible_cpumask = tbl;
5834 wq_numa_enabled = true;
5835}
5836
Tejun Heo3347fa02016-09-16 15:49:32 -04005837/**
5838 * workqueue_init_early - early init for workqueue subsystem
5839 *
5840 * This is the first half of two-staged workqueue subsystem initialization
5841 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5842 * idr are up. It sets up all the data structures and system workqueues
5843 * and allows early boot code to create workqueues and queue/cancel work
5844 * items. Actual work item execution starts only after kthreads can be
5845 * created and scheduled right before early initcalls.
5846 */
5847int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005848{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005849 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005850 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005851 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005852
Tejun Heoe904e6c2013-03-12 11:29:57 -07005853 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5854
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005855 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005856 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005857
Tejun Heoe904e6c2013-03-12 11:29:57 -07005858 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5859
Tejun Heo706026c2013-01-24 11:01:34 -08005860 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005861 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005862 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005863
Tejun Heo7a4e3442013-03-12 11:30:00 -07005864 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005865 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005866 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005867 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005868 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005869 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005870 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005871
Tejun Heo9daf9e62013-01-24 11:01:33 -08005872 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005873 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005874 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005875 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005876 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005877 }
5878
Tejun Heo8a2b7532013-09-05 12:30:04 -04005879 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005880 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5881 struct workqueue_attrs *attrs;
5882
5883 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005884 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005885 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005886
5887 /*
5888 * An ordered wq should have only one pwq as ordering is
5889 * guaranteed by max_active which is enforced by pwqs.
5890 * Turn off NUMA so that dfl_pwq is used for all nodes.
5891 */
5892 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5893 attrs->nice = std_nice[i];
5894 attrs->no_numa = true;
5895 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005896 }
5897
Tejun Heod320c032010-06-29 10:07:14 +02005898 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005899 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005900 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005901 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5902 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005903 system_freezable_wq = alloc_workqueue("events_freezable",
5904 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305905 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5906 WQ_POWER_EFFICIENT, 0);
5907 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5908 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5909 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005910 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305911 !system_unbound_wq || !system_freezable_wq ||
5912 !system_power_efficient_wq ||
5913 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005914
Tejun Heo3347fa02016-09-16 15:49:32 -04005915 return 0;
5916}
5917
5918/**
5919 * workqueue_init - bring workqueue subsystem fully online
5920 *
5921 * This is the latter half of two-staged workqueue subsystem initialization
5922 * and invoked as soon as kthreads can be created and scheduled.
5923 * Workqueues have been created and work items queued on them, but there
5924 * are no kworkers executing the work items yet. Populate the worker pools
5925 * with the initial workers and enable future kworker creations.
5926 */
5927int __init workqueue_init(void)
5928{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005929 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005930 struct worker_pool *pool;
5931 int cpu, bkt;
5932
Tejun Heo2186d9f2016-10-19 12:01:27 -04005933 /*
5934 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5935 * CPU to node mapping may not be available that early on some
5936 * archs such as power and arm64. As per-cpu pools created
5937 * previously could be missing node hint and unbound pools NUMA
5938 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005939 *
5940 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005941 */
5942 wq_numa_init();
5943
5944 mutex_lock(&wq_pool_mutex);
5945
5946 for_each_possible_cpu(cpu) {
5947 for_each_cpu_worker_pool(pool, cpu) {
5948 pool->node = cpu_to_node(cpu);
5949 }
5950 }
5951
Tejun Heo40c17f72018-01-08 05:38:37 -08005952 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005953 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005954 WARN(init_rescuer(wq),
5955 "workqueue: failed to create early rescuer for %s",
5956 wq->name);
5957 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005958
5959 mutex_unlock(&wq_pool_mutex);
5960
Tejun Heo3347fa02016-09-16 15:49:32 -04005961 /* create the initial workers */
5962 for_each_online_cpu(cpu) {
5963 for_each_cpu_worker_pool(pool, cpu) {
5964 pool->flags &= ~POOL_DISASSOCIATED;
5965 BUG_ON(!create_worker(pool));
5966 }
5967 }
5968
5969 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5970 BUG_ON(!create_worker(pool));
5971
5972 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005973 wq_watchdog_init();
5974
Suresh Siddha6ee05782010-07-30 14:57:37 -07005975 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005976}