blob: e163e7a7f5e5c5980c17df64d914e49bd475b7b0 [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
651 * reordering can lead to a missed execution on attempt to qeueue
652 * 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/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 * wq_worker_waking_up - a worker is waking up
845 * @task: task waking up
846 * @cpu: CPU @task is waking up to
847 *
848 * This function is called during try_to_wake_up() when a worker is
849 * being awoken.
850 *
851 * CONTEXT:
852 * spin_lock_irq(rq->lock)
853 */
Tejun Heod84ff052013-03-12 11:29:59 -0700854void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200855{
856 struct worker *worker = kthread_data(task);
857
Joonsoo Kim36576002012-10-26 23:03:49 +0900858 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800859 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800860 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900861 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200862}
863
864/**
865 * wq_worker_sleeping - a worker is going to sleep
866 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200867 *
868 * This function is called during schedule() when a busy worker is
869 * going to sleep. Worker on the same cpu can be woken up by
870 * returning pointer to its task.
871 *
872 * CONTEXT:
873 * spin_lock_irq(rq->lock)
874 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700875 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200876 * Worker task on @cpu to wake up, %NULL if none.
877 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100878struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200879{
880 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800881 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200882
Tejun Heo111c2252013-01-17 17:16:24 -0800883 /*
884 * Rescuers, which may not have all the fields set up like normal
885 * workers, also reach here, let's not access anything before
886 * checking NOT_RUNNING.
887 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500888 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200889 return NULL;
890
Tejun Heo111c2252013-01-17 17:16:24 -0800891 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800892
Tejun Heoe22bee72010-06-29 10:07:14 +0200893 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100894 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700895 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200896
897 /*
898 * The counterpart of the following dec_and_test, implied mb,
899 * worklist not empty test sequence is in insert_work().
900 * Please read comment there.
901 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700902 * NOT_RUNNING is clear. This means that we're bound to and
903 * running on the local cpu w/ rq lock held and preemption
904 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800905 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700906 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200907 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800908 if (atomic_dec_and_test(&pool->nr_running) &&
909 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800910 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 return to_wakeup ? to_wakeup->task : NULL;
912}
913
914/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800915 * wq_worker_last_func - retrieve worker's last work function
916 *
917 * Determine the last function a worker executed. This is called from
918 * the scheduler to get a worker's last known identity.
919 *
920 * CONTEXT:
921 * spin_lock_irq(rq->lock)
922 *
923 * Return:
924 * The last work function %current executed as a worker, NULL if it
925 * hasn't executed any work yet.
926 */
927work_func_t wq_worker_last_func(struct task_struct *task)
928{
929 struct worker *worker = kthread_data(task);
930
931 return worker->last_func;
932}
933
934/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200935 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200936 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200937 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200938 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800939 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200940 *
Tejun Heocb444762010-07-02 10:03:50 +0200941 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800942 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200943 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800944static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200945{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700946 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200947
Tejun Heocb444762010-07-02 10:03:50 +0200948 WARN_ON_ONCE(worker->task != current);
949
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800950 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200951 if ((flags & WORKER_NOT_RUNNING) &&
952 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800953 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200954 }
955
Tejun Heod302f012010-06-29 10:07:13 +0200956 worker->flags |= flags;
957}
958
959/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200960 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200961 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200962 * @flags: flags to clear
963 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200964 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200965 *
Tejun Heocb444762010-07-02 10:03:50 +0200966 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800967 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200968 */
969static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
970{
Tejun Heo63d95a92012-07-12 14:46:37 -0700971 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200972 unsigned int oflags = worker->flags;
973
Tejun Heocb444762010-07-02 10:03:50 +0200974 WARN_ON_ONCE(worker->task != current);
975
Tejun Heod302f012010-06-29 10:07:13 +0200976 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200977
Tejun Heo42c025f2011-01-11 15:58:49 +0100978 /*
979 * If transitioning out of NOT_RUNNING, increment nr_running. Note
980 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
981 * of multiple flags, not a single flag.
982 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200983 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
984 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800985 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200986}
987
988/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200989 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800990 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200991 * @work: work to find worker for
992 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800993 * Find a worker which is executing @work on @pool by searching
994 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800995 * to match, its current execution should match the address of @work and
996 * its work function. This is to avoid unwanted dependency between
997 * unrelated work executions through a work item being recycled while still
998 * being executed.
999 *
1000 * This is a bit tricky. A work item may be freed once its execution
1001 * starts and nothing prevents the freed area from being recycled for
1002 * another work item. If the same work item address ends up being reused
1003 * before the original execution finishes, workqueue will identify the
1004 * recycled work item as currently executing and make it wait until the
1005 * current execution finishes, introducing an unwanted dependency.
1006 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001007 * This function checks the work item address and work function to avoid
1008 * false positives. Note that this isn't complete as one may construct a
1009 * work function which can introduce dependency onto itself through a
1010 * recycled work item. Well, if somebody wants to shoot oneself in the
1011 * foot that badly, there's only so much we can do, and if such deadlock
1012 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001013 *
1014 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001015 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001016 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001017 * Return:
1018 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001019 * otherwise.
1020 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001021static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001022 struct work_struct *work)
1023{
Sasha Levin42f85702012-12-17 10:01:23 -05001024 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001025
Sasha Levinb67bfe02013-02-27 17:06:00 -08001026 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001027 (unsigned long)work)
1028 if (worker->current_work == work &&
1029 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001030 return worker;
1031
1032 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001033}
1034
1035/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001036 * move_linked_works - move linked works to a list
1037 * @work: start of series of works to be scheduled
1038 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301039 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001040 *
1041 * Schedule linked works starting from @work to @head. Work series to
1042 * be scheduled starts at @work and includes any consecutive work with
1043 * WORK_STRUCT_LINKED set in its predecessor.
1044 *
1045 * If @nextp is not NULL, it's updated to point to the next work of
1046 * the last scheduled work. This allows move_linked_works() to be
1047 * nested inside outer list_for_each_entry_safe().
1048 *
1049 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001050 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001051 */
1052static void move_linked_works(struct work_struct *work, struct list_head *head,
1053 struct work_struct **nextp)
1054{
1055 struct work_struct *n;
1056
1057 /*
1058 * Linked worklist will always end before the end of the list,
1059 * use NULL for list head.
1060 */
1061 list_for_each_entry_safe_from(work, n, NULL, entry) {
1062 list_move_tail(&work->entry, head);
1063 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1064 break;
1065 }
1066
1067 /*
1068 * If we're already inside safe list traversal and have moved
1069 * multiple works to the scheduled queue, the next position
1070 * needs to be updated.
1071 */
1072 if (nextp)
1073 *nextp = n;
1074}
1075
Tejun Heo8864b4e2013-03-12 11:30:04 -07001076/**
1077 * get_pwq - get an extra reference on the specified pool_workqueue
1078 * @pwq: pool_workqueue to get
1079 *
1080 * Obtain an extra reference on @pwq. The caller should guarantee that
1081 * @pwq has positive refcnt and be holding the matching pool->lock.
1082 */
1083static void get_pwq(struct pool_workqueue *pwq)
1084{
1085 lockdep_assert_held(&pwq->pool->lock);
1086 WARN_ON_ONCE(pwq->refcnt <= 0);
1087 pwq->refcnt++;
1088}
1089
1090/**
1091 * put_pwq - put a pool_workqueue reference
1092 * @pwq: pool_workqueue to put
1093 *
1094 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1095 * destruction. The caller should be holding the matching pool->lock.
1096 */
1097static void put_pwq(struct pool_workqueue *pwq)
1098{
1099 lockdep_assert_held(&pwq->pool->lock);
1100 if (likely(--pwq->refcnt))
1101 return;
1102 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1103 return;
1104 /*
1105 * @pwq can't be released under pool->lock, bounce to
1106 * pwq_unbound_release_workfn(). This never recurses on the same
1107 * pool->lock as this path is taken only for unbound workqueues and
1108 * the release work item is scheduled on a per-cpu workqueue. To
1109 * avoid lockdep warning, unbound pool->locks are given lockdep
1110 * subclass of 1 in get_unbound_pool().
1111 */
1112 schedule_work(&pwq->unbound_release_work);
1113}
1114
Tejun Heodce90d42013-04-01 11:23:35 -07001115/**
1116 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1117 * @pwq: pool_workqueue to put (can be %NULL)
1118 *
1119 * put_pwq() with locking. This function also allows %NULL @pwq.
1120 */
1121static void put_pwq_unlocked(struct pool_workqueue *pwq)
1122{
1123 if (pwq) {
1124 /*
1125 * As both pwqs and pools are sched-RCU protected, the
1126 * following lock operations are safe.
1127 */
1128 spin_lock_irq(&pwq->pool->lock);
1129 put_pwq(pwq);
1130 spin_unlock_irq(&pwq->pool->lock);
1131 }
1132}
1133
Tejun Heo112202d2013-02-13 19:29:12 -08001134static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001135{
Tejun Heo112202d2013-02-13 19:29:12 -08001136 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001137
1138 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001139 if (list_empty(&pwq->pool->worklist))
1140 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001141 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001142 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001143 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001144}
1145
Tejun Heo112202d2013-02-13 19:29:12 -08001146static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001147{
Tejun Heo112202d2013-02-13 19:29:12 -08001148 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001149 struct work_struct, entry);
1150
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001152}
1153
Tejun Heobf4ede02012-08-03 10:30:46 -07001154/**
Tejun Heo112202d2013-02-13 19:29:12 -08001155 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1156 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001157 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001158 *
1159 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001160 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001161 *
1162 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001163 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001164 */
Tejun Heo112202d2013-02-13 19:29:12 -08001165static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001166{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001167 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001168 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001169 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001170
Tejun Heo112202d2013-02-13 19:29:12 -08001171 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001172
Tejun Heo112202d2013-02-13 19:29:12 -08001173 pwq->nr_active--;
1174 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001175 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001176 if (pwq->nr_active < pwq->max_active)
1177 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001178 }
1179
1180 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001181 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001182 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001183
1184 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001185 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001186 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001187
Tejun Heo112202d2013-02-13 19:29:12 -08001188 /* this pwq is done, clear flush_color */
1189 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001190
1191 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001192 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001193 * will handle the rest.
1194 */
Tejun Heo112202d2013-02-13 19:29:12 -08001195 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1196 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001197out_put:
1198 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001199}
1200
Tejun Heo36e227d2012-08-03 10:30:46 -07001201/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001202 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001203 * @work: work item to steal
1204 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001205 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001206 *
1207 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001208 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001209 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001210 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001211 * 1 if @work was pending and we successfully stole PENDING
1212 * 0 if @work was idle and we claimed PENDING
1213 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001214 * -ENOENT if someone else is canceling @work, this state may persist
1215 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001216 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001217 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001218 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001219 * interrupted while holding PENDING and @work off queue, irq must be
1220 * disabled on entry. This, combined with delayed_work->timer being
1221 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001222 *
1223 * On successful return, >= 0, irq is disabled and the caller is
1224 * responsible for releasing it using local_irq_restore(*@flags).
1225 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001226 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001227 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001228static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1229 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001230{
Tejun Heod565ed62013-01-24 11:01:33 -08001231 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001232 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001233
Tejun Heobbb68df2012-08-03 10:30:46 -07001234 local_irq_save(*flags);
1235
Tejun Heo36e227d2012-08-03 10:30:46 -07001236 /* try to steal the timer if it exists */
1237 if (is_dwork) {
1238 struct delayed_work *dwork = to_delayed_work(work);
1239
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001240 /*
1241 * dwork->timer is irqsafe. If del_timer() fails, it's
1242 * guaranteed that the timer is not queued anywhere and not
1243 * running on the local CPU.
1244 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001245 if (likely(del_timer(&dwork->timer)))
1246 return 1;
1247 }
1248
1249 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001250 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1251 return 0;
1252
1253 /*
1254 * The queueing is in progress, or it is already queued. Try to
1255 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1256 */
Tejun Heod565ed62013-01-24 11:01:33 -08001257 pool = get_work_pool(work);
1258 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001259 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001260
Tejun Heod565ed62013-01-24 11:01:33 -08001261 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001262 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001263 * work->data is guaranteed to point to pwq only while the work
1264 * item is queued on pwq->wq, and both updating work->data to point
1265 * to pwq on queueing and to pool on dequeueing are done under
1266 * pwq->pool->lock. This in turn guarantees that, if work->data
1267 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001268 * item is currently queued on that pool.
1269 */
Tejun Heo112202d2013-02-13 19:29:12 -08001270 pwq = get_work_pwq(work);
1271 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001272 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001273
Tejun Heo16062832013-02-06 18:04:53 -08001274 /*
1275 * A delayed work item cannot be grabbed directly because
1276 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001277 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001278 * management later on and cause stall. Make sure the work
1279 * item is activated before grabbing.
1280 */
1281 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001282 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001283
Tejun Heo16062832013-02-06 18:04:53 -08001284 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001285 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001286
Tejun Heo112202d2013-02-13 19:29:12 -08001287 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001288 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001289
Tejun Heo16062832013-02-06 18:04:53 -08001290 spin_unlock(&pool->lock);
1291 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001292 }
Tejun Heod565ed62013-01-24 11:01:33 -08001293 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001294fail:
1295 local_irq_restore(*flags);
1296 if (work_is_canceling(work))
1297 return -ENOENT;
1298 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001299 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001300}
1301
1302/**
Tejun Heo706026c2013-01-24 11:01:34 -08001303 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001304 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001305 * @work: work to insert
1306 * @head: insertion point
1307 * @extra_flags: extra WORK_STRUCT_* flags to set
1308 *
Tejun Heo112202d2013-02-13 19:29:12 -08001309 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001310 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001311 *
1312 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001313 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001314 */
Tejun Heo112202d2013-02-13 19:29:12 -08001315static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1316 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001317{
Tejun Heo112202d2013-02-13 19:29:12 -08001318 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001319
Tejun Heo4690c4a2010-06-29 10:07:10 +02001320 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001321 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001322 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001323 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001324
1325 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001326 * Ensure either wq_worker_sleeping() sees the above
1327 * list_add_tail() or we see zero nr_running to avoid workers lying
1328 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001329 */
1330 smp_mb();
1331
Tejun Heo63d95a92012-07-12 14:46:37 -07001332 if (__need_more_worker(pool))
1333 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001334}
1335
Tejun Heoc8efcc22010-12-20 19:32:04 +01001336/*
1337 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001338 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001339 */
1340static bool is_chained_work(struct workqueue_struct *wq)
1341{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001342 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001343
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001344 worker = current_wq_worker();
1345 /*
1346 * Return %true iff I'm a worker execuing a work item on @wq. If
1347 * I'm @worker, it's safe to dereference it without locking.
1348 */
Tejun Heo112202d2013-02-13 19:29:12 -08001349 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001350}
1351
Mike Galbraithef5571802016-02-09 17:59:38 -05001352/*
1353 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1354 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1355 * avoid perturbing sensitive tasks.
1356 */
1357static int wq_select_unbound_cpu(int cpu)
1358{
Tejun Heof303fccb2016-02-09 17:59:38 -05001359 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001360 int new_cpu;
1361
Tejun Heof303fccb2016-02-09 17:59:38 -05001362 if (likely(!wq_debug_force_rr_cpu)) {
1363 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1364 return cpu;
1365 } else if (!printed_dbg_warning) {
1366 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1367 printed_dbg_warning = true;
1368 }
1369
Mike Galbraithef5571802016-02-09 17:59:38 -05001370 if (cpumask_empty(wq_unbound_cpumask))
1371 return cpu;
1372
1373 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1374 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1375 if (unlikely(new_cpu >= nr_cpu_ids)) {
1376 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1377 if (unlikely(new_cpu >= nr_cpu_ids))
1378 return cpu;
1379 }
1380 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1381
1382 return new_cpu;
1383}
1384
Tejun Heod84ff052013-03-12 11:29:59 -07001385static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 struct work_struct *work)
1387{
Tejun Heo112202d2013-02-13 19:29:12 -08001388 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001389 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001390 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001391 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001392 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001393
1394 /*
1395 * While a work item is PENDING && off queue, a task trying to
1396 * steal the PENDING will busy-loop waiting for it to either get
1397 * queued or lose PENDING. Grabbing PENDING and queueing should
1398 * happen with IRQ disabled.
1399 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001400 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001402 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001403
Li Bin9ef28a72013-09-09 13:13:58 +08001404 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001405 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001406 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001407 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001408retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001409 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001410 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001411
Tejun Heoc9178082013-03-12 11:30:04 -07001412 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001413 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001414 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001415 else
1416 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001417
Tejun Heoc9178082013-03-12 11:30:04 -07001418 /*
1419 * If @work was previously on a different pool, it might still be
1420 * running there, in which case the work needs to be queued on that
1421 * pool to guarantee non-reentrancy.
1422 */
1423 last_pool = get_work_pool(work);
1424 if (last_pool && last_pool != pwq->pool) {
1425 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001426
Tejun Heoc9178082013-03-12 11:30:04 -07001427 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001428
Tejun Heoc9178082013-03-12 11:30:04 -07001429 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001430
Tejun Heoc9178082013-03-12 11:30:04 -07001431 if (worker && worker->current_pwq->wq == wq) {
1432 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001433 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001434 /* meh... not running there, queue here */
1435 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001436 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001437 }
Tejun Heof3421792010-07-02 10:03:51 +02001438 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001439 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001440 }
1441
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001442 /*
1443 * pwq is determined and locked. For unbound pools, we could have
1444 * raced with pwq release and it could already be dead. If its
1445 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001446 * without another pwq replacing it in the numa_pwq_tbl or while
1447 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001448 * make forward-progress.
1449 */
1450 if (unlikely(!pwq->refcnt)) {
1451 if (wq->flags & WQ_UNBOUND) {
1452 spin_unlock(&pwq->pool->lock);
1453 cpu_relax();
1454 goto retry;
1455 }
1456 /* oops */
1457 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1458 wq->name, cpu);
1459 }
1460
Tejun Heo112202d2013-02-13 19:29:12 -08001461 /* pwq determined, queue */
1462 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001463
Dan Carpenterf5b25522012-04-13 22:06:58 +03001464 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001465 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001466 return;
1467 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001468
Tejun Heo112202d2013-02-13 19:29:12 -08001469 pwq->nr_in_flight[pwq->work_color]++;
1470 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001471
Tejun Heo112202d2013-02-13 19:29:12 -08001472 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001473 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001474 pwq->nr_active++;
1475 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001476 if (list_empty(worklist))
1477 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001478 } else {
1479 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001480 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001481 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001482
Tejun Heo112202d2013-02-13 19:29:12 -08001483 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001484
Tejun Heo112202d2013-02-13 19:29:12 -08001485 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486}
1487
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001488/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001489 * queue_work_on - queue work on specific cpu
1490 * @cpu: CPU number to execute work on
1491 * @wq: workqueue to use
1492 * @work: work to queue
1493 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494 * We queue the work to a specific CPU, the caller must ensure it
1495 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001496 *
1497 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001498 */
Tejun Heod4283e92012-08-03 10:30:44 -07001499bool queue_work_on(int cpu, struct workqueue_struct *wq,
1500 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001501{
Tejun Heod4283e92012-08-03 10:30:44 -07001502 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001503 unsigned long flags;
1504
1505 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001506
Tejun Heo22df02b2010-06-29 10:07:10 +02001507 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001508 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001509 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001510 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001511
1512 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001513 return ret;
1514}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001515EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001516
Kees Cook8c20feb2017-10-04 16:27:07 -07001517void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518{
Kees Cook8c20feb2017-10-04 16:27:07 -07001519 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001521 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001522 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001524EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001526static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1527 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001529 struct timer_list *timer = &dwork->timer;
1530 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Tejun Heo637fdba2017-03-06 15:33:42 -05001532 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001533 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001534 WARN_ON_ONCE(timer_pending(timer));
1535 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001536
Tejun Heo8852aac2012-12-01 16:23:42 -08001537 /*
1538 * If @delay is 0, queue @dwork->work immediately. This is for
1539 * both optimization and correctness. The earliest @timer can
1540 * expire is on the closest next tick and delayed_work users depend
1541 * on that there's no such delay when @delay is 0.
1542 */
1543 if (!delay) {
1544 __queue_work(cpu, wq, &dwork->work);
1545 return;
1546 }
1547
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001548 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001549 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001550 timer->expires = jiffies + delay;
1551
Tejun Heo041bd122016-02-09 16:11:26 -05001552 if (unlikely(cpu != WORK_CPU_UNBOUND))
1553 add_timer_on(timer, cpu);
1554 else
1555 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556}
1557
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001558/**
1559 * queue_delayed_work_on - queue work on specific CPU after delay
1560 * @cpu: CPU number to execute work on
1561 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001562 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001563 * @delay: number of jiffies to wait before queueing
1564 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001565 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001566 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1567 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001568 */
Tejun Heod4283e92012-08-03 10:30:44 -07001569bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1570 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001571{
David Howells52bad642006-11-22 14:54:01 +00001572 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001573 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001574 unsigned long flags;
1575
1576 /* read the comment in __queue_work() */
1577 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001578
Tejun Heo22df02b2010-06-29 10:07:10 +02001579 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001580 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001581 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001582 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001583
1584 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001585 return ret;
1586}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001587EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Tejun Heoc8e55f32010-06-29 10:07:12 +02001589/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001590 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1591 * @cpu: CPU number to execute work on
1592 * @wq: workqueue to use
1593 * @dwork: work to queue
1594 * @delay: number of jiffies to wait before queueing
1595 *
1596 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1597 * modify @dwork's timer so that it expires after @delay. If @delay is
1598 * zero, @work is guaranteed to be scheduled immediately regardless of its
1599 * current state.
1600 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001601 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001602 * pending and its timer was modified.
1603 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001604 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001605 * See try_to_grab_pending() for details.
1606 */
1607bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1608 struct delayed_work *dwork, unsigned long delay)
1609{
1610 unsigned long flags;
1611 int ret;
1612
1613 do {
1614 ret = try_to_grab_pending(&dwork->work, true, &flags);
1615 } while (unlikely(ret == -EAGAIN));
1616
1617 if (likely(ret >= 0)) {
1618 __queue_delayed_work(cpu, wq, dwork, delay);
1619 local_irq_restore(flags);
1620 }
1621
1622 /* -ENOENT from try_to_grab_pending() becomes %true */
1623 return ret;
1624}
1625EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1626
Tejun Heo05f0fe62018-03-14 12:45:13 -07001627static void rcu_work_rcufn(struct rcu_head *rcu)
1628{
1629 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1630
1631 /* read the comment in __queue_work() */
1632 local_irq_disable();
1633 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1634 local_irq_enable();
1635}
1636
1637/**
1638 * queue_rcu_work - queue work after a RCU grace period
1639 * @wq: workqueue to use
1640 * @rwork: work to queue
1641 *
1642 * Return: %false if @rwork was already pending, %true otherwise. Note
1643 * that a full RCU grace period is guaranteed only after a %true return.
1644 * While @rwork is guarnateed to be executed after a %false return, the
1645 * execution may happen before a full RCU grace period has passed.
1646 */
1647bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1648{
1649 struct work_struct *work = &rwork->work;
1650
1651 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1652 rwork->wq = wq;
1653 call_rcu(&rwork->rcu, rcu_work_rcufn);
1654 return true;
1655 }
1656
1657 return false;
1658}
1659EXPORT_SYMBOL(queue_rcu_work);
1660
Tejun Heo8376fe22012-08-03 10:30:47 -07001661/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001662 * worker_enter_idle - enter idle state
1663 * @worker: worker which is entering idle state
1664 *
1665 * @worker is entering idle state. Update stats and idle timer if
1666 * necessary.
1667 *
1668 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001669 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001670 */
1671static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001673 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674
Tejun Heo6183c002013-03-12 11:29:57 -07001675 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1676 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1677 (worker->hentry.next || worker->hentry.pprev)))
1678 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
Lai Jiangshan051e1852014-07-22 13:03:02 +08001680 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001681 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001682 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001683 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001684
Tejun Heoc8e55f32010-06-29 10:07:12 +02001685 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001686 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001687
Tejun Heo628c78e2012-07-17 12:39:27 -07001688 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1689 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001690
Tejun Heo544ecf32012-05-14 15:04:50 -07001691 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001692 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001693 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001694 * nr_running, the warning may trigger spuriously. Check iff
1695 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001696 */
Tejun Heo24647572013-01-24 11:01:33 -08001697 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001698 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001699 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700}
1701
Tejun Heoc8e55f32010-06-29 10:07:12 +02001702/**
1703 * worker_leave_idle - leave idle state
1704 * @worker: worker which is leaving idle state
1705 *
1706 * @worker is leaving idle state. Update stats.
1707 *
1708 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001709 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001710 */
1711static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001713 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
Tejun Heo6183c002013-03-12 11:29:57 -07001715 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1716 return;
Tejun Heod302f012010-06-29 10:07:13 +02001717 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001718 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001719 list_del_init(&worker->entry);
1720}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001722static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001723{
1724 struct worker *worker;
1725
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001726 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001727 if (worker) {
1728 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001729 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001730 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001731 /* on creation a worker is in !idle && prep state */
1732 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001733 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001734 return worker;
1735}
1736
1737/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001738 * worker_attach_to_pool() - attach a worker to a pool
1739 * @worker: worker to be attached
1740 * @pool: the target pool
1741 *
1742 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1743 * cpu-binding of @worker are kept coordinated with the pool across
1744 * cpu-[un]hotplugs.
1745 */
1746static void worker_attach_to_pool(struct worker *worker,
1747 struct worker_pool *pool)
1748{
Tejun Heo1258fae2018-05-18 08:47:13 -07001749 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001750
1751 /*
1752 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1753 * online CPUs. It'll be re-applied when any of the CPUs come up.
1754 */
1755 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1756
1757 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001758 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1759 * stable across this function. See the comments above the flag
1760 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001761 */
1762 if (pool->flags & POOL_DISASSOCIATED)
1763 worker->flags |= WORKER_UNBOUND;
1764
1765 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001766 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001767
Tejun Heo1258fae2018-05-18 08:47:13 -07001768 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001769}
1770
1771/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001772 * worker_detach_from_pool() - detach a worker from its pool
1773 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001774 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001775 * Undo the attaching which had been done in worker_attach_to_pool(). The
1776 * caller worker shouldn't access to the pool after detached except it has
1777 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001778 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001779static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001780{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001781 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001782 struct completion *detach_completion = NULL;
1783
Tejun Heo1258fae2018-05-18 08:47:13 -07001784 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001785
Lai Jiangshanda028462014-05-20 17:46:31 +08001786 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001787 worker->pool = NULL;
1788
Lai Jiangshanda028462014-05-20 17:46:31 +08001789 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001790 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001791 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001792
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001793 /* clear leftover flags without pool->lock after it is detached */
1794 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1795
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001796 if (detach_completion)
1797 complete(detach_completion);
1798}
1799
1800/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001802 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001804 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001805 *
1806 * CONTEXT:
1807 * Might sleep. Does GFP_KERNEL allocations.
1808 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001809 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001810 * Pointer to the newly created worker.
1811 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001812static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001813{
Tejun Heoc34056a2010-06-29 10:07:11 +02001814 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001815 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001816 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001817
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001818 /* ID is needed to determine kthread name */
1819 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001820 if (id < 0)
1821 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001822
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001823 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001824 if (!worker)
1825 goto fail;
1826
Tejun Heoc34056a2010-06-29 10:07:11 +02001827 worker->id = id;
1828
Tejun Heo29c91e92013-03-12 11:30:03 -07001829 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001830 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1831 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001832 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001833 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1834
Tejun Heof3f90ad2013-04-01 11:23:34 -07001835 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001836 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001837 if (IS_ERR(worker->task))
1838 goto fail;
1839
Oleg Nesterov91151222013-11-14 12:56:18 +01001840 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001841 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001842
Lai Jiangshanda028462014-05-20 17:46:31 +08001843 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001844 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001845
Lai Jiangshan051e1852014-07-22 13:03:02 +08001846 /* start the newly created worker */
1847 spin_lock_irq(&pool->lock);
1848 worker->pool->nr_workers++;
1849 worker_enter_idle(worker);
1850 wake_up_process(worker->task);
1851 spin_unlock_irq(&pool->lock);
1852
Tejun Heoc34056a2010-06-29 10:07:11 +02001853 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001854
Tejun Heoc34056a2010-06-29 10:07:11 +02001855fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001856 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001857 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001858 kfree(worker);
1859 return NULL;
1860}
1861
1862/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001863 * destroy_worker - destroy a workqueue worker
1864 * @worker: worker to be destroyed
1865 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001866 * Destroy @worker and adjust @pool stats accordingly. The worker should
1867 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001868 *
1869 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001870 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001871 */
1872static void destroy_worker(struct worker *worker)
1873{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001874 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001875
Tejun Heocd549682013-03-13 19:47:39 -07001876 lockdep_assert_held(&pool->lock);
1877
Tejun Heoc34056a2010-06-29 10:07:11 +02001878 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001879 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001880 WARN_ON(!list_empty(&worker->scheduled)) ||
1881 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001882 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001883
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001884 pool->nr_workers--;
1885 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001886
Tejun Heoc8e55f32010-06-29 10:07:12 +02001887 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001888 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001889 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001890}
1891
Kees Cook32a6c722017-10-16 15:58:25 -07001892static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001893{
Kees Cook32a6c722017-10-16 15:58:25 -07001894 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001895
Tejun Heod565ed62013-01-24 11:01:33 -08001896 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001897
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001898 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 struct worker *worker;
1900 unsigned long expires;
1901
1902 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001903 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001904 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1905
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001906 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001908 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001909 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001910
1911 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 }
1913
Tejun Heod565ed62013-01-24 11:01:33 -08001914 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001915}
1916
Tejun Heo493a1722013-03-12 11:29:59 -07001917static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001918{
Tejun Heo112202d2013-02-13 19:29:12 -08001919 struct pool_workqueue *pwq = get_work_pwq(work);
1920 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001921
Tejun Heo2e109a22013-03-13 19:47:40 -07001922 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001923
Tejun Heo493008a2013-03-12 11:30:03 -07001924 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001925 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001926
1927 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001928 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001929 /*
1930 * If @pwq is for an unbound wq, its base ref may be put at
1931 * any time due to an attribute change. Pin @pwq until the
1932 * rescuer is done with it.
1933 */
1934 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001935 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001936 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001937 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001938}
1939
Kees Cook32a6c722017-10-16 15:58:25 -07001940static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001941{
Kees Cook32a6c722017-10-16 15:58:25 -07001942 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 struct work_struct *work;
1944
Tejun Heob2d82902014-12-08 12:39:16 -05001945 spin_lock_irq(&pool->lock);
1946 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001947
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 /*
1950 * We've been trying to create a new worker but
1951 * haven't been successful. We might be hitting an
1952 * allocation deadlock. Send distress signals to
1953 * rescuers.
1954 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001955 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 send_mayday(work);
1957 }
1958
Tejun Heob2d82902014-12-08 12:39:16 -05001959 spin_unlock(&wq_mayday_lock);
1960 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001961
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001963}
1964
1965/**
1966 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001967 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 * have at least one idle worker on return from this function. If
1971 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001972 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 * possible allocation deadlock.
1974 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001975 * On return, need_to_create_worker() is guaranteed to be %false and
1976 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 *
1978 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001979 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 * multiple times. Does GFP_KERNEL allocations. Called only from
1981 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001982 */
Tejun Heo29187a92015-01-16 14:21:16 -05001983static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001984__releases(&pool->lock)
1985__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001986{
Tejun Heoe22bee72010-06-29 10:07:14 +02001987restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001988 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001989
Tejun Heoe22bee72010-06-29 10:07:14 +02001990 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001991 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001992
1993 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001994 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001995 break;
1996
Lai Jiangshane212f362014-06-03 15:32:17 +08001997 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001998
Tejun Heo63d95a92012-07-12 14:46:37 -07001999 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 break;
2001 }
2002
Tejun Heo63d95a92012-07-12 14:46:37 -07002003 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08002004 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002005 /*
2006 * This is necessary even after a new worker was just successfully
2007 * created as @pool->lock was dropped and the new worker might have
2008 * already become busy.
2009 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002010 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002011 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002012}
2013
2014/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002015 * manage_workers - manage worker pool
2016 * @worker: self
2017 *
Tejun Heo706026c2013-01-24 11:01:34 -08002018 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002019 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002020 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002021 *
2022 * The caller can safely start processing works on false return. On
2023 * true return, it's guaranteed that need_to_create_worker() is false
2024 * and may_start_working() is true.
2025 *
2026 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002027 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002028 * multiple times. Does GFP_KERNEL allocations.
2029 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002030 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002031 * %false if the pool doesn't need management and the caller can safely
2032 * start processing works, %true if management function was performed and
2033 * the conditions that the caller verified before calling the function may
2034 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 */
2036static bool manage_workers(struct worker *worker)
2037{
Tejun Heo63d95a92012-07-12 14:46:37 -07002038 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002039
Tejun Heo692b4822017-10-09 08:04:13 -07002040 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002041 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002042
2043 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002044 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002045
Tejun Heo29187a92015-01-16 14:21:16 -05002046 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002047
Tejun Heo2607d7a2015-03-09 09:22:28 -04002048 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002049 pool->flags &= ~POOL_MANAGER_ACTIVE;
2050 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002051 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002052}
2053
Tejun Heoa62428c2010-06-29 10:07:10 +02002054/**
2055 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002056 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002057 * @work: work to process
2058 *
2059 * Process @work. This function contains all the logics necessary to
2060 * process a single work including synchronization against and
2061 * interaction with other workers on the same cpu, queueing and
2062 * flushing. As long as context requirement is met, any worker can
2063 * call this function to process a work.
2064 *
2065 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002066 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002067 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002068static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002069__releases(&pool->lock)
2070__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002071{
Tejun Heo112202d2013-02-13 19:29:12 -08002072 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002073 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002074 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002075 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002076 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002077#ifdef CONFIG_LOCKDEP
2078 /*
2079 * It is permissible to free the struct work_struct from
2080 * inside the function that is called from it, this we need to
2081 * take into account for lockdep too. To avoid bogus "held
2082 * lock freed" warnings as well as problems when looking into
2083 * work->lockdep_map, make a copy and use that here.
2084 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002085 struct lockdep_map lockdep_map;
2086
2087 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002088#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002089 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002090 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002091 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002092
Tejun Heo7e116292010-06-29 10:07:13 +02002093 /*
2094 * A single work shouldn't be executed concurrently by
2095 * multiple workers on a single cpu. Check whether anyone is
2096 * already processing the work. If so, defer the work to the
2097 * currently executing one.
2098 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002099 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002100 if (unlikely(collision)) {
2101 move_linked_works(work, &collision->scheduled, NULL);
2102 return;
2103 }
2104
Tejun Heo8930cab2012-08-03 10:30:45 -07002105 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002106 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002107 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002108 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002109 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002110 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002111 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002112
Tejun Heo8bf89592018-05-18 08:47:13 -07002113 /*
2114 * Record wq name for cmdline and debug reporting, may get
2115 * overridden through set_worker_desc().
2116 */
2117 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2118
Tejun Heoa62428c2010-06-29 10:07:10 +02002119 list_del_init(&work->entry);
2120
Tejun Heo649027d2010-06-29 10:07:14 +02002121 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002122 * CPU intensive works don't participate in concurrency management.
2123 * They're the scheduler's responsibility. This takes @worker out
2124 * of concurrency management and the next code block will chain
2125 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002126 */
2127 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002128 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002129
Tejun Heo974271c42012-07-12 14:46:37 -07002130 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002131 * Wake up another worker if necessary. The condition is always
2132 * false for normal per-cpu workers since nr_running would always
2133 * be >= 1 at this point. This is used to chain execution of the
2134 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002135 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002136 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002137 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002138 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002139
Tejun Heo8930cab2012-08-03 10:30:45 -07002140 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002141 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002142 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002143 * PENDING and queued state changes happen together while IRQ is
2144 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002145 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002146 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002147
Tejun Heod565ed62013-01-24 11:01:33 -08002148 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002149
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002150 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002151 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002152 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002153 * Strictly speaking we should mark the invariant state without holding
2154 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002155 *
2156 * However, that would result in:
2157 *
2158 * A(W1)
2159 * WFC(C)
2160 * A(W1)
2161 * C(C)
2162 *
2163 * Which would create W1->C->W1 dependencies, even though there is no
2164 * actual deadlock possible. There are two solutions, using a
2165 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002166 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002167 * these locks.
2168 *
2169 * AFAICT there is no possible deadlock scenario between the
2170 * flush_work() and complete() primitives (except for single-threaded
2171 * workqueues), so hiding them isn't a problem.
2172 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002173 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002174 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002175 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002176 /*
2177 * While we must be careful to not use "work" after this, the trace
2178 * point will only record its address.
2179 */
2180 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002181 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002182 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002183
2184 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002185 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2186 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002187 current->comm, preempt_count(), task_pid_nr(current),
2188 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002189 debug_show_held_locks(current);
2190 dump_stack();
2191 }
2192
Tejun Heob22ce272013-08-28 17:33:37 -04002193 /*
2194 * The following prevents a kworker from hogging CPU on !PREEMPT
2195 * kernels, where a requeueing work item waiting for something to
2196 * happen could deadlock with stop_machine as such work item could
2197 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002198 * stop_machine. At the same time, report a quiescent RCU state so
2199 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002200 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002201 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002202
Tejun Heod565ed62013-01-24 11:01:33 -08002203 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002204
Tejun Heofb0e7be2010-06-29 10:07:15 +02002205 /* clear cpu intensive status */
2206 if (unlikely(cpu_intensive))
2207 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2208
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002209 /* tag the worker for identification in schedule() */
2210 worker->last_func = worker->current_func;
2211
Tejun Heoa62428c2010-06-29 10:07:10 +02002212 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002213 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002214 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002215 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002216 worker->current_pwq = NULL;
2217 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002218}
2219
Tejun Heoaffee4b2010-06-29 10:07:12 +02002220/**
2221 * process_scheduled_works - process scheduled works
2222 * @worker: self
2223 *
2224 * Process all scheduled works. Please note that the scheduled list
2225 * may change while processing a work, so this function repeatedly
2226 * fetches a work from the top and executes it.
2227 *
2228 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002229 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002230 * multiple times.
2231 */
2232static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002234 while (!list_empty(&worker->scheduled)) {
2235 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002237 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239}
2240
Tejun Heo197f6ac2018-05-21 08:04:35 -07002241static void set_pf_worker(bool val)
2242{
2243 mutex_lock(&wq_pool_attach_mutex);
2244 if (val)
2245 current->flags |= PF_WQ_WORKER;
2246 else
2247 current->flags &= ~PF_WQ_WORKER;
2248 mutex_unlock(&wq_pool_attach_mutex);
2249}
2250
Tejun Heo4690c4a2010-06-29 10:07:10 +02002251/**
2252 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002253 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002254 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002255 * The worker thread function. All workers belong to a worker_pool -
2256 * either a per-cpu one or dynamic unbound one. These workers process all
2257 * work items regardless of their specific target workqueue. The only
2258 * exception is work items which belong to workqueues with a rescuer which
2259 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002260 *
2261 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002262 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002263static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
Tejun Heoc34056a2010-06-29 10:07:11 +02002265 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002266 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267
Tejun Heoe22bee72010-06-29 10:07:14 +02002268 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002269 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002270woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002271 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002272
Tejun Heoa9ab7752013-03-19 13:45:21 -07002273 /* am I supposed to die? */
2274 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002275 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002276 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002277 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002278
2279 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002280 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002281 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002282 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002283 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002285
Tejun Heoc8e55f32010-06-29 10:07:12 +02002286 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002287recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002288 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002289 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002290 goto sleep;
2291
2292 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002293 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002294 goto recheck;
2295
Tejun Heoc8e55f32010-06-29 10:07:12 +02002296 /*
2297 * ->scheduled list can only be filled while a worker is
2298 * preparing to process a work or actually processing it.
2299 * Make sure nobody diddled with it while I was sleeping.
2300 */
Tejun Heo6183c002013-03-12 11:29:57 -07002301 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002302
Tejun Heoe22bee72010-06-29 10:07:14 +02002303 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002304 * Finish PREP stage. We're guaranteed to have at least one idle
2305 * worker or that someone else has already assumed the manager
2306 * role. This is where @worker starts participating in concurrency
2307 * management if applicable and concurrency management is restored
2308 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002309 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002310 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002311
2312 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002313 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002314 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002315 struct work_struct, entry);
2316
Tejun Heo82607adc2015-12-08 11:28:04 -05002317 pool->watchdog_ts = jiffies;
2318
Tejun Heoc8e55f32010-06-29 10:07:12 +02002319 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2320 /* optimization path, not strictly necessary */
2321 process_one_work(worker, work);
2322 if (unlikely(!list_empty(&worker->scheduled)))
2323 process_scheduled_works(worker);
2324 } else {
2325 move_linked_works(work, &worker->scheduled, NULL);
2326 process_scheduled_works(worker);
2327 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002328 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002329
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002330 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002331sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002332 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002333 * pool->lock is held and there's no work to process and no need to
2334 * manage, sleep. Workers are woken up only while holding
2335 * pool->lock or from local cpu, so setting the current state
2336 * before releasing pool->lock is enough to prevent losing any
2337 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002338 */
2339 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002340 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002341 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002342 schedule();
2343 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344}
2345
Tejun Heoe22bee72010-06-29 10:07:14 +02002346/**
2347 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002348 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002349 *
2350 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002351 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002352 *
Tejun Heo706026c2013-01-24 11:01:34 -08002353 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002354 * worker which uses GFP_KERNEL allocation which has slight chance of
2355 * developing into deadlock if some works currently on the same queue
2356 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2357 * the problem rescuer solves.
2358 *
Tejun Heo706026c2013-01-24 11:01:34 -08002359 * When such condition is possible, the pool summons rescuers of all
2360 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002361 * those works so that forward progress can be guaranteed.
2362 *
2363 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002364 *
2365 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002366 */
Tejun Heo111c2252013-01-17 17:16:24 -08002367static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002368{
Tejun Heo111c2252013-01-17 17:16:24 -08002369 struct worker *rescuer = __rescuer;
2370 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002371 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002372 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002373
2374 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002375
2376 /*
2377 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2378 * doesn't participate in concurrency management.
2379 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002380 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002381repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002382 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002383
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002384 /*
2385 * By the time the rescuer is requested to stop, the workqueue
2386 * shouldn't have any work pending, but @wq->maydays may still have
2387 * pwq(s) queued. This can happen by non-rescuer workers consuming
2388 * all the work items before the rescuer got to them. Go through
2389 * @wq->maydays processing before acting on should_stop so that the
2390 * list is always empty on exit.
2391 */
2392 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002393
Tejun Heo493a1722013-03-12 11:29:59 -07002394 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002395 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002396
2397 while (!list_empty(&wq->maydays)) {
2398 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2399 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002400 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002401 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002402 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002403
2404 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002405 list_del_init(&pwq->mayday_node);
2406
Tejun Heo2e109a22013-03-13 19:47:40 -07002407 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002408
Lai Jiangshan51697d392014-05-20 17:46:36 +08002409 worker_attach_to_pool(rescuer, pool);
2410
2411 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002412
2413 /*
2414 * Slurp in all works issued via this workqueue and
2415 * process'em.
2416 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002417 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002418 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2419 if (get_work_pwq(work) == pwq) {
2420 if (first)
2421 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002422 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002423 }
2424 first = false;
2425 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002426
NeilBrown008847f2014-12-08 12:39:16 -05002427 if (!list_empty(scheduled)) {
2428 process_scheduled_works(rescuer);
2429
2430 /*
2431 * The above execution of rescued work items could
2432 * have created more to rescue through
2433 * pwq_activate_first_delayed() or chained
2434 * queueing. Let's put @pwq back on mayday list so
2435 * that such back-to-back work items, which may be
2436 * being used to relieve memory pressure, don't
2437 * incur MAYDAY_INTERVAL delay inbetween.
2438 */
2439 if (need_to_create_worker(pool)) {
2440 spin_lock(&wq_mayday_lock);
2441 get_pwq(pwq);
2442 list_move_tail(&pwq->mayday_node, &wq->maydays);
2443 spin_unlock(&wq_mayday_lock);
2444 }
2445 }
Tejun Heo75769582011-02-14 14:04:46 +01002446
2447 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002448 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002449 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002450 */
2451 put_pwq(pwq);
2452
2453 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002454 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002455 * regular worker; otherwise, we end up with 0 concurrency
2456 * and stalling the execution.
2457 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002458 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002459 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002460
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002461 spin_unlock_irq(&pool->lock);
2462
Tejun Heoa2d812a2018-05-18 08:47:13 -07002463 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002464
2465 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002466 }
2467
Tejun Heo2e109a22013-03-13 19:47:40 -07002468 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002469
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002470 if (should_stop) {
2471 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002472 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002473 return 0;
2474 }
2475
Tejun Heo111c2252013-01-17 17:16:24 -08002476 /* rescuers should never participate in concurrency management */
2477 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002478 schedule();
2479 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480}
2481
Tejun Heofca839c2015-12-07 10:58:57 -05002482/**
2483 * check_flush_dependency - check for flush dependency sanity
2484 * @target_wq: workqueue being flushed
2485 * @target_work: work item being flushed (NULL for workqueue flushes)
2486 *
2487 * %current is trying to flush the whole @target_wq or @target_work on it.
2488 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2489 * reclaiming memory or running on a workqueue which doesn't have
2490 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2491 * a deadlock.
2492 */
2493static void check_flush_dependency(struct workqueue_struct *target_wq,
2494 struct work_struct *target_work)
2495{
2496 work_func_t target_func = target_work ? target_work->func : NULL;
2497 struct worker *worker;
2498
2499 if (target_wq->flags & WQ_MEM_RECLAIM)
2500 return;
2501
2502 worker = current_wq_worker();
2503
2504 WARN_ONCE(current->flags & PF_MEMALLOC,
2505 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2506 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002507 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2508 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002509 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2510 worker->current_pwq->wq->name, worker->current_func,
2511 target_wq->name, target_func);
2512}
2513
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002514struct wq_barrier {
2515 struct work_struct work;
2516 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002517 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002518};
2519
2520static void wq_barrier_func(struct work_struct *work)
2521{
2522 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2523 complete(&barr->done);
2524}
2525
Tejun Heo4690c4a2010-06-29 10:07:10 +02002526/**
2527 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002528 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002529 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002530 * @target: target work to attach @barr to
2531 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002532 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002533 * @barr is linked to @target such that @barr is completed only after
2534 * @target finishes execution. Please note that the ordering
2535 * guarantee is observed only with respect to @target and on the local
2536 * cpu.
2537 *
2538 * Currently, a queued barrier can't be canceled. This is because
2539 * try_to_grab_pending() can't determine whether the work to be
2540 * grabbed is at the head of the queue and thus can't clear LINKED
2541 * flag of the previous work while there must be a valid next work
2542 * after a work with LINKED flag set.
2543 *
2544 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002545 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002546 *
2547 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002548 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002549 */
Tejun Heo112202d2013-02-13 19:29:12 -08002550static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002551 struct wq_barrier *barr,
2552 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002553{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002554 struct list_head *head;
2555 unsigned int linked = 0;
2556
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002557 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002558 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002559 * as we know for sure that this will not trigger any of the
2560 * checks and call back into the fixup functions where we
2561 * might deadlock.
2562 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002563 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002564 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002565
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002566 init_completion_map(&barr->done, &target->lockdep_map);
2567
Tejun Heo2607d7a2015-03-09 09:22:28 -04002568 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002569
Tejun Heoaffee4b2010-06-29 10:07:12 +02002570 /*
2571 * If @target is currently being executed, schedule the
2572 * barrier to the worker; otherwise, put it after @target.
2573 */
2574 if (worker)
2575 head = worker->scheduled.next;
2576 else {
2577 unsigned long *bits = work_data_bits(target);
2578
2579 head = target->entry.next;
2580 /* there can already be other linked works, inherit and set */
2581 linked = *bits & WORK_STRUCT_LINKED;
2582 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2583 }
2584
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002585 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002586 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002587 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002588}
2589
Tejun Heo73f53c42010-06-29 10:07:11 +02002590/**
Tejun Heo112202d2013-02-13 19:29:12 -08002591 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002592 * @wq: workqueue being flushed
2593 * @flush_color: new flush color, < 0 for no-op
2594 * @work_color: new work color, < 0 for no-op
2595 *
Tejun Heo112202d2013-02-13 19:29:12 -08002596 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002597 *
Tejun Heo112202d2013-02-13 19:29:12 -08002598 * If @flush_color is non-negative, flush_color on all pwqs should be
2599 * -1. If no pwq has in-flight commands at the specified color, all
2600 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2601 * has in flight commands, its pwq->flush_color is set to
2602 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002603 * wakeup logic is armed and %true is returned.
2604 *
2605 * The caller should have initialized @wq->first_flusher prior to
2606 * calling this function with non-negative @flush_color. If
2607 * @flush_color is negative, no flush color update is done and %false
2608 * is returned.
2609 *
Tejun Heo112202d2013-02-13 19:29:12 -08002610 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002611 * work_color which is previous to @work_color and all will be
2612 * advanced to @work_color.
2613 *
2614 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002615 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002616 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002617 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002618 * %true if @flush_color >= 0 and there's something to flush. %false
2619 * otherwise.
2620 */
Tejun Heo112202d2013-02-13 19:29:12 -08002621static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002622 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623{
Tejun Heo73f53c42010-06-29 10:07:11 +02002624 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002625 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002626
Tejun Heo73f53c42010-06-29 10:07:11 +02002627 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002628 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002629 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002630 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002631
Tejun Heo49e3cf42013-03-12 11:29:58 -07002632 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002633 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002634
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002635 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002636
2637 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002638 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002639
Tejun Heo112202d2013-02-13 19:29:12 -08002640 if (pwq->nr_in_flight[flush_color]) {
2641 pwq->flush_color = flush_color;
2642 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002643 wait = true;
2644 }
2645 }
2646
2647 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002648 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002649 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002650 }
2651
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002652 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002653 }
2654
Tejun Heo112202d2013-02-13 19:29:12 -08002655 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002656 complete(&wq->first_flusher->done);
2657
2658 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659}
2660
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002661/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002663 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002665 * This function sleeps until all work items which were queued on entry
2666 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002668void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669{
Tejun Heo73f53c42010-06-29 10:07:11 +02002670 struct wq_flusher this_flusher = {
2671 .list = LIST_HEAD_INIT(this_flusher.list),
2672 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002673 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002674 };
2675 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002676
Tejun Heo3347fa02016-09-16 15:49:32 -04002677 if (WARN_ON(!wq_online))
2678 return;
2679
Johannes Berg87915ad2018-08-22 11:49:04 +02002680 lock_map_acquire(&wq->lockdep_map);
2681 lock_map_release(&wq->lockdep_map);
2682
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002683 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002684
2685 /*
2686 * Start-to-wait phase
2687 */
2688 next_color = work_next_color(wq->work_color);
2689
2690 if (next_color != wq->flush_color) {
2691 /*
2692 * Color space is not full. The current work_color
2693 * becomes our flush_color and work_color is advanced
2694 * by one.
2695 */
Tejun Heo6183c002013-03-12 11:29:57 -07002696 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002697 this_flusher.flush_color = wq->work_color;
2698 wq->work_color = next_color;
2699
2700 if (!wq->first_flusher) {
2701 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002702 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002703
2704 wq->first_flusher = &this_flusher;
2705
Tejun Heo112202d2013-02-13 19:29:12 -08002706 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002707 wq->work_color)) {
2708 /* nothing to flush, done */
2709 wq->flush_color = next_color;
2710 wq->first_flusher = NULL;
2711 goto out_unlock;
2712 }
2713 } else {
2714 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002715 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002716 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002717 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002718 }
2719 } else {
2720 /*
2721 * Oops, color space is full, wait on overflow queue.
2722 * The next flush completion will assign us
2723 * flush_color and transfer to flusher_queue.
2724 */
2725 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2726 }
2727
Tejun Heofca839c2015-12-07 10:58:57 -05002728 check_flush_dependency(wq, NULL);
2729
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002730 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002731
2732 wait_for_completion(&this_flusher.done);
2733
2734 /*
2735 * Wake-up-and-cascade phase
2736 *
2737 * First flushers are responsible for cascading flushes and
2738 * handling overflow. Non-first flushers can simply return.
2739 */
2740 if (wq->first_flusher != &this_flusher)
2741 return;
2742
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002743 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002744
Tejun Heo4ce48b32010-07-02 10:03:51 +02002745 /* we might have raced, check again with mutex held */
2746 if (wq->first_flusher != &this_flusher)
2747 goto out_unlock;
2748
Tejun Heo73f53c42010-06-29 10:07:11 +02002749 wq->first_flusher = NULL;
2750
Tejun Heo6183c002013-03-12 11:29:57 -07002751 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2752 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002753
2754 while (true) {
2755 struct wq_flusher *next, *tmp;
2756
2757 /* complete all the flushers sharing the current flush color */
2758 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2759 if (next->flush_color != wq->flush_color)
2760 break;
2761 list_del_init(&next->list);
2762 complete(&next->done);
2763 }
2764
Tejun Heo6183c002013-03-12 11:29:57 -07002765 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2766 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002767
2768 /* this flush_color is finished, advance by one */
2769 wq->flush_color = work_next_color(wq->flush_color);
2770
2771 /* one color has been freed, handle overflow queue */
2772 if (!list_empty(&wq->flusher_overflow)) {
2773 /*
2774 * Assign the same color to all overflowed
2775 * flushers, advance work_color and append to
2776 * flusher_queue. This is the start-to-wait
2777 * phase for these overflowed flushers.
2778 */
2779 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2780 tmp->flush_color = wq->work_color;
2781
2782 wq->work_color = work_next_color(wq->work_color);
2783
2784 list_splice_tail_init(&wq->flusher_overflow,
2785 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002786 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002787 }
2788
2789 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002790 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002791 break;
2792 }
2793
2794 /*
2795 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002796 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002797 */
Tejun Heo6183c002013-03-12 11:29:57 -07002798 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2799 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002800
2801 list_del_init(&next->list);
2802 wq->first_flusher = next;
2803
Tejun Heo112202d2013-02-13 19:29:12 -08002804 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002805 break;
2806
2807 /*
2808 * Meh... this color is already done, clear first
2809 * flusher and repeat cascading.
2810 */
2811 wq->first_flusher = NULL;
2812 }
2813
2814out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002815 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002817EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002819/**
2820 * drain_workqueue - drain a workqueue
2821 * @wq: workqueue to drain
2822 *
2823 * Wait until the workqueue becomes empty. While draining is in progress,
2824 * only chain queueing is allowed. IOW, only currently pending or running
2825 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002826 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002827 * by the depth of chaining and should be relatively short. Whine if it
2828 * takes too long.
2829 */
2830void drain_workqueue(struct workqueue_struct *wq)
2831{
2832 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002833 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002834
2835 /*
2836 * __queue_work() needs to test whether there are drainers, is much
2837 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002838 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002839 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002840 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002841 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002842 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002843 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002844reflush:
2845 flush_workqueue(wq);
2846
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002847 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002848
Tejun Heo49e3cf42013-03-12 11:29:58 -07002849 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002850 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002851
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002852 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002853 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002854 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002855
2856 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002857 continue;
2858
2859 if (++flush_cnt == 10 ||
2860 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002861 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002862 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002863
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002864 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002865 goto reflush;
2866 }
2867
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002868 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002869 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002870 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002871}
2872EXPORT_SYMBOL_GPL(drain_workqueue);
2873
Johannes Bergd6e89782018-08-22 11:49:03 +02002874static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2875 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002876{
2877 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002878 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002879 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002880
2881 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002882
Tejun Heofa1b54e2013-03-12 11:30:00 -07002883 local_irq_disable();
2884 pool = get_work_pool(work);
2885 if (!pool) {
2886 local_irq_enable();
2887 return false;
2888 }
2889
2890 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002891 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002892 pwq = get_work_pwq(work);
2893 if (pwq) {
2894 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002895 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002896 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002897 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002898 if (!worker)
2899 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002900 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002901 }
Tejun Heobaf59022010-09-16 10:42:16 +02002902
Tejun Heofca839c2015-12-07 10:58:57 -05002903 check_flush_dependency(pwq->wq, work);
2904
Tejun Heo112202d2013-02-13 19:29:12 -08002905 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002906 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002907
Tejun Heoe159489b2011-01-09 23:32:15 +01002908 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002909 * Force a lock recursion deadlock when using flush_work() inside a
2910 * single-threaded or rescuer equipped workqueue.
2911 *
2912 * For single threaded workqueues the deadlock happens when the work
2913 * is after the work issuing the flush_work(). For rescuer equipped
2914 * workqueues the deadlock happens when the rescuer stalls, blocking
2915 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002916 */
Johannes Bergd6e89782018-08-22 11:49:03 +02002917 if (!from_cancel &&
2918 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08002919 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002920 lock_map_release(&pwq->wq->lockdep_map);
2921 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002922
Tejun Heobaf59022010-09-16 10:42:16 +02002923 return true;
2924already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002925 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002926 return false;
2927}
2928
Johannes Bergd6e89782018-08-22 11:49:03 +02002929static bool __flush_work(struct work_struct *work, bool from_cancel)
2930{
2931 struct wq_barrier barr;
2932
2933 if (WARN_ON(!wq_online))
2934 return false;
2935
Johannes Berg87915ad2018-08-22 11:49:04 +02002936 if (!from_cancel) {
2937 lock_map_acquire(&work->lockdep_map);
2938 lock_map_release(&work->lockdep_map);
2939 }
2940
Johannes Bergd6e89782018-08-22 11:49:03 +02002941 if (start_flush_work(work, &barr, from_cancel)) {
2942 wait_for_completion(&barr.done);
2943 destroy_work_on_stack(&barr.work);
2944 return true;
2945 } else {
2946 return false;
2947 }
2948}
2949
Oleg Nesterovdb700892008-07-25 01:47:49 -07002950/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002951 * flush_work - wait for a work to finish executing the last queueing instance
2952 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002953 *
Tejun Heo606a5022012-08-20 14:51:23 -07002954 * Wait until @work has finished execution. @work is guaranteed to be idle
2955 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002956 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002957 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002958 * %true if flush_work() waited for the work to finish execution,
2959 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002960 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002961bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002962{
Johannes Bergd6e89782018-08-22 11:49:03 +02002963 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07002964}
2965EXPORT_SYMBOL_GPL(flush_work);
2966
Tejun Heo8603e1b32015-03-05 08:04:13 -05002967struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002968 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002969 struct work_struct *work;
2970};
2971
Ingo Molnarac6424b2017-06-20 12:06:13 +02002972static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002973{
2974 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2975
2976 if (cwait->work != key)
2977 return 0;
2978 return autoremove_wake_function(wait, mode, sync, key);
2979}
2980
Tejun Heo36e227d2012-08-03 10:30:46 -07002981static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002982{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002983 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002984 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002985 int ret;
2986
2987 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002988 ret = try_to_grab_pending(work, is_dwork, &flags);
2989 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002990 * If someone else is already canceling, wait for it to
2991 * finish. flush_work() doesn't work for PREEMPT_NONE
2992 * because we may get scheduled between @work's completion
2993 * and the other canceling task resuming and clearing
2994 * CANCELING - flush_work() will return false immediately
2995 * as @work is no longer busy, try_to_grab_pending() will
2996 * return -ENOENT as @work is still being canceled and the
2997 * other canceling task won't be able to clear CANCELING as
2998 * we're hogging the CPU.
2999 *
3000 * Let's wait for completion using a waitqueue. As this
3001 * may lead to the thundering herd problem, use a custom
3002 * wake function which matches @work along with exclusive
3003 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003004 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003005 if (unlikely(ret == -ENOENT)) {
3006 struct cwt_wait cwait;
3007
3008 init_wait(&cwait.wait);
3009 cwait.wait.func = cwt_wakefn;
3010 cwait.work = work;
3011
3012 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3013 TASK_UNINTERRUPTIBLE);
3014 if (work_is_canceling(work))
3015 schedule();
3016 finish_wait(&cancel_waitq, &cwait.wait);
3017 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003018 } while (unlikely(ret < 0));
3019
Tejun Heobbb68df2012-08-03 10:30:46 -07003020 /* tell other tasks trying to grab @work to back off */
3021 mark_work_canceling(work);
3022 local_irq_restore(flags);
3023
Tejun Heo3347fa02016-09-16 15:49:32 -04003024 /*
3025 * This allows canceling during early boot. We know that @work
3026 * isn't executing.
3027 */
3028 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003029 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003030
Tejun Heo7a22ad72010-06-29 10:07:13 +02003031 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003032
3033 /*
3034 * Paired with prepare_to_wait() above so that either
3035 * waitqueue_active() is visible here or !work_is_canceling() is
3036 * visible there.
3037 */
3038 smp_mb();
3039 if (waitqueue_active(&cancel_waitq))
3040 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3041
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003042 return ret;
3043}
3044
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003045/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003046 * cancel_work_sync - cancel a work and wait for it to finish
3047 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003048 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003049 * Cancel @work and wait for its execution to finish. This function
3050 * can be used even if the work re-queues itself or migrates to
3051 * another workqueue. On return from this function, @work is
3052 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003053 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003054 * cancel_work_sync(&delayed_work->work) must not be used for
3055 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003056 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003057 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003058 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003059 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003060 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003061 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003062 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003063bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003064{
Tejun Heo36e227d2012-08-03 10:30:46 -07003065 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003066}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003067EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003068
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003069/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003070 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3071 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003072 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003073 * Delayed timer is cancelled and the pending work is queued for
3074 * immediate execution. Like flush_work(), this function only
3075 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003076 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003077 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003078 * %true if flush_work() waited for the work to finish execution,
3079 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003080 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003081bool flush_delayed_work(struct delayed_work *dwork)
3082{
Tejun Heo8930cab2012-08-03 10:30:45 -07003083 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003084 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003085 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003086 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003087 return flush_work(&dwork->work);
3088}
3089EXPORT_SYMBOL(flush_delayed_work);
3090
Tejun Heo05f0fe62018-03-14 12:45:13 -07003091/**
3092 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3093 * @rwork: the rcu work to flush
3094 *
3095 * Return:
3096 * %true if flush_rcu_work() waited for the work to finish execution,
3097 * %false if it was already idle.
3098 */
3099bool flush_rcu_work(struct rcu_work *rwork)
3100{
3101 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3102 rcu_barrier();
3103 flush_work(&rwork->work);
3104 return true;
3105 } else {
3106 return flush_work(&rwork->work);
3107 }
3108}
3109EXPORT_SYMBOL(flush_rcu_work);
3110
Jens Axboef72b8792016-08-24 15:51:50 -06003111static bool __cancel_work(struct work_struct *work, bool is_dwork)
3112{
3113 unsigned long flags;
3114 int ret;
3115
3116 do {
3117 ret = try_to_grab_pending(work, is_dwork, &flags);
3118 } while (unlikely(ret == -EAGAIN));
3119
3120 if (unlikely(ret < 0))
3121 return false;
3122
3123 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3124 local_irq_restore(flags);
3125 return ret;
3126}
3127
Tejun Heo401a8d02010-09-16 10:36:00 +02003128/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003129 * cancel_delayed_work - cancel a delayed work
3130 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003131 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003132 * Kill off a pending delayed_work.
3133 *
3134 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3135 * pending.
3136 *
3137 * Note:
3138 * The work callback function may still be running on return, unless
3139 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3140 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003141 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003142 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003143 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003144bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003145{
Jens Axboef72b8792016-08-24 15:51:50 -06003146 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003147}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003148EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003149
3150/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003151 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3152 * @dwork: the delayed work cancel
3153 *
3154 * This is cancel_work_sync() for delayed works.
3155 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003156 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003157 * %true if @dwork was pending, %false otherwise.
3158 */
3159bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003160{
Tejun Heo36e227d2012-08-03 10:30:46 -07003161 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003162}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003163EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003165/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003166 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003167 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003168 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003169 * schedule_on_each_cpu() executes @func on each online CPU using the
3170 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003171 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003172 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003173 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003174 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003175 */
David Howells65f27f32006-11-22 14:55:48 +00003176int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003177{
3178 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003179 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003180
Andrew Mortonb6136772006-06-25 05:47:49 -07003181 works = alloc_percpu(struct work_struct);
3182 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003183 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003184
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003185 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003186
Christoph Lameter15316ba82006-01-08 01:00:43 -08003187 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003188 struct work_struct *work = per_cpu_ptr(works, cpu);
3189
3190 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003191 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003192 }
Tejun Heo93981802009-11-17 14:06:20 -08003193
3194 for_each_online_cpu(cpu)
3195 flush_work(per_cpu_ptr(works, cpu));
3196
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003197 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003198 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003199 return 0;
3200}
3201
Alan Sterneef6a7d2010-02-12 17:39:21 +09003202/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003203 * execute_in_process_context - reliably execute the routine with user context
3204 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003205 * @ew: guaranteed storage for the execute work structure (must
3206 * be available when the work executes)
3207 *
3208 * Executes the function immediately if process context is available,
3209 * otherwise schedules the function for delayed execution.
3210 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003211 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003212 * 1 - function was scheduled for execution
3213 */
David Howells65f27f32006-11-22 14:55:48 +00003214int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003215{
3216 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003217 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003218 return 0;
3219 }
3220
David Howells65f27f32006-11-22 14:55:48 +00003221 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003222 schedule_work(&ew->work);
3223
3224 return 1;
3225}
3226EXPORT_SYMBOL_GPL(execute_in_process_context);
3227
Tejun Heo7a4e3442013-03-12 11:30:00 -07003228/**
3229 * free_workqueue_attrs - free a workqueue_attrs
3230 * @attrs: workqueue_attrs to free
3231 *
3232 * Undo alloc_workqueue_attrs().
3233 */
3234void free_workqueue_attrs(struct workqueue_attrs *attrs)
3235{
3236 if (attrs) {
3237 free_cpumask_var(attrs->cpumask);
3238 kfree(attrs);
3239 }
3240}
3241
3242/**
3243 * alloc_workqueue_attrs - allocate a workqueue_attrs
3244 * @gfp_mask: allocation mask to use
3245 *
3246 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003247 * return it.
3248 *
3249 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003250 */
3251struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3252{
3253 struct workqueue_attrs *attrs;
3254
3255 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3256 if (!attrs)
3257 goto fail;
3258 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3259 goto fail;
3260
Tejun Heo13e2e552013-04-01 11:23:31 -07003261 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003262 return attrs;
3263fail:
3264 free_workqueue_attrs(attrs);
3265 return NULL;
3266}
3267
Tejun Heo29c91e92013-03-12 11:30:03 -07003268static void copy_workqueue_attrs(struct workqueue_attrs *to,
3269 const struct workqueue_attrs *from)
3270{
3271 to->nice = from->nice;
3272 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003273 /*
3274 * Unlike hash and equality test, this function doesn't ignore
3275 * ->no_numa as it is used for both pool and wq attrs. Instead,
3276 * get_unbound_pool() explicitly clears ->no_numa after copying.
3277 */
3278 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003279}
3280
Tejun Heo29c91e92013-03-12 11:30:03 -07003281/* hash value of the content of @attr */
3282static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3283{
3284 u32 hash = 0;
3285
3286 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003287 hash = jhash(cpumask_bits(attrs->cpumask),
3288 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003289 return hash;
3290}
3291
3292/* content equality test */
3293static bool wqattrs_equal(const struct workqueue_attrs *a,
3294 const struct workqueue_attrs *b)
3295{
3296 if (a->nice != b->nice)
3297 return false;
3298 if (!cpumask_equal(a->cpumask, b->cpumask))
3299 return false;
3300 return true;
3301}
3302
Tejun Heo7a4e3442013-03-12 11:30:00 -07003303/**
3304 * init_worker_pool - initialize a newly zalloc'd worker_pool
3305 * @pool: worker_pool to initialize
3306 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303307 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003308 *
3309 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003310 * inside @pool proper are initialized and put_unbound_pool() can be called
3311 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003312 */
3313static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003314{
3315 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003316 pool->id = -1;
3317 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003318 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003319 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003320 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003321 INIT_LIST_HEAD(&pool->worklist);
3322 INIT_LIST_HEAD(&pool->idle_list);
3323 hash_init(pool->busy_hash);
3324
Kees Cook32a6c722017-10-16 15:58:25 -07003325 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003326
Kees Cook32a6c722017-10-16 15:58:25 -07003327 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003328
Lai Jiangshanda028462014-05-20 17:46:31 +08003329 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003330
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003331 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003332 INIT_HLIST_NODE(&pool->hash_node);
3333 pool->refcnt = 1;
3334
3335 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003336 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3337 if (!pool->attrs)
3338 return -ENOMEM;
3339 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003340}
3341
Bart Van Assche669de8b2019-02-14 15:00:54 -08003342#ifdef CONFIG_LOCKDEP
3343static void wq_init_lockdep(struct workqueue_struct *wq)
3344{
3345 char *lock_name;
3346
3347 lockdep_register_key(&wq->key);
3348 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3349 if (!lock_name)
3350 lock_name = wq->name;
3351 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3352}
3353
3354static void wq_unregister_lockdep(struct workqueue_struct *wq)
3355{
3356 lockdep_unregister_key(&wq->key);
3357}
3358
3359static void wq_free_lockdep(struct workqueue_struct *wq)
3360{
3361 if (wq->lock_name != wq->name)
3362 kfree(wq->lock_name);
3363}
3364#else
3365static void wq_init_lockdep(struct workqueue_struct *wq)
3366{
3367}
3368
3369static void wq_unregister_lockdep(struct workqueue_struct *wq)
3370{
3371}
3372
3373static void wq_free_lockdep(struct workqueue_struct *wq)
3374{
3375}
3376#endif
3377
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003378static void rcu_free_wq(struct rcu_head *rcu)
3379{
3380 struct workqueue_struct *wq =
3381 container_of(rcu, struct workqueue_struct, rcu);
3382
Bart Van Assche669de8b2019-02-14 15:00:54 -08003383 wq_free_lockdep(wq);
3384
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003385 if (!(wq->flags & WQ_UNBOUND))
3386 free_percpu(wq->cpu_pwqs);
3387 else
3388 free_workqueue_attrs(wq->unbound_attrs);
3389
3390 kfree(wq->rescuer);
3391 kfree(wq);
3392}
3393
Tejun Heo29c91e92013-03-12 11:30:03 -07003394static void rcu_free_pool(struct rcu_head *rcu)
3395{
3396 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3397
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003398 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003399 free_workqueue_attrs(pool->attrs);
3400 kfree(pool);
3401}
3402
3403/**
3404 * put_unbound_pool - put a worker_pool
3405 * @pool: worker_pool to put
3406 *
3407 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003408 * safe manner. get_unbound_pool() calls this function on its failure path
3409 * and this function should be able to release pools which went through,
3410 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003411 *
3412 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003413 */
3414static void put_unbound_pool(struct worker_pool *pool)
3415{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003416 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003417 struct worker *worker;
3418
Tejun Heoa892cac2013-04-01 11:23:32 -07003419 lockdep_assert_held(&wq_pool_mutex);
3420
3421 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003422 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003423
3424 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003425 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003426 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003427 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003428
3429 /* release id and unhash */
3430 if (pool->id >= 0)
3431 idr_remove(&worker_pool_idr, pool->id);
3432 hash_del(&pool->hash_node);
3433
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003434 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003435 * Become the manager and destroy all workers. This prevents
3436 * @pool's workers from blocking on attach_mutex. We're the last
3437 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003438 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003439 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003440 wait_event_lock_irq(wq_manager_wait,
3441 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3442 pool->flags |= POOL_MANAGER_ACTIVE;
3443
Lai Jiangshan1037de32014-05-22 16:44:07 +08003444 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003445 destroy_worker(worker);
3446 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003447 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003448
Tejun Heo1258fae2018-05-18 08:47:13 -07003449 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003450 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003451 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003452 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003453
3454 if (pool->detach_completion)
3455 wait_for_completion(pool->detach_completion);
3456
Tejun Heo29c91e92013-03-12 11:30:03 -07003457 /* shut down the timers */
3458 del_timer_sync(&pool->idle_timer);
3459 del_timer_sync(&pool->mayday_timer);
3460
3461 /* sched-RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003462 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003463}
3464
3465/**
3466 * get_unbound_pool - get a worker_pool with the specified attributes
3467 * @attrs: the attributes of the worker_pool to get
3468 *
3469 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3470 * reference count and return it. If there already is a matching
3471 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003472 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003473 *
3474 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003475 *
3476 * Return: On success, a worker_pool with the same attributes as @attrs.
3477 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003478 */
3479static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3480{
Tejun Heo29c91e92013-03-12 11:30:03 -07003481 u32 hash = wqattrs_hash(attrs);
3482 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003483 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003484 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003485
Tejun Heoa892cac2013-04-01 11:23:32 -07003486 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003487
3488 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003489 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3490 if (wqattrs_equal(pool->attrs, attrs)) {
3491 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003492 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003493 }
3494 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003495
Xunlei Pange22735842015-10-09 11:53:12 +08003496 /* if cpumask is contained inside a NUMA node, we belong to that node */
3497 if (wq_numa_enabled) {
3498 for_each_node(node) {
3499 if (cpumask_subset(attrs->cpumask,
3500 wq_numa_possible_cpumask[node])) {
3501 target_node = node;
3502 break;
3503 }
3504 }
3505 }
3506
Tejun Heo29c91e92013-03-12 11:30:03 -07003507 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003508 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003509 if (!pool || init_worker_pool(pool) < 0)
3510 goto fail;
3511
Tejun Heo8864b4e2013-03-12 11:30:04 -07003512 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003513 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003514 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003515
Shaohua Li2865a8f2013-08-01 09:56:36 +08003516 /*
3517 * no_numa isn't a worker_pool attribute, always clear it. See
3518 * 'struct workqueue_attrs' comments for detail.
3519 */
3520 pool->attrs->no_numa = false;
3521
Tejun Heo29c91e92013-03-12 11:30:03 -07003522 if (worker_pool_assign_id(pool) < 0)
3523 goto fail;
3524
3525 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003526 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003527 goto fail;
3528
Tejun Heo29c91e92013-03-12 11:30:03 -07003529 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003530 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003531
Tejun Heo29c91e92013-03-12 11:30:03 -07003532 return pool;
3533fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003534 if (pool)
3535 put_unbound_pool(pool);
3536 return NULL;
3537}
3538
Tejun Heo8864b4e2013-03-12 11:30:04 -07003539static void rcu_free_pwq(struct rcu_head *rcu)
3540{
3541 kmem_cache_free(pwq_cache,
3542 container_of(rcu, struct pool_workqueue, rcu));
3543}
3544
3545/*
3546 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3547 * and needs to be destroyed.
3548 */
3549static void pwq_unbound_release_workfn(struct work_struct *work)
3550{
3551 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3552 unbound_release_work);
3553 struct workqueue_struct *wq = pwq->wq;
3554 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003555 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003556
3557 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3558 return;
3559
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003560 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003561 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003562 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003563 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003564
Tejun Heoa892cac2013-04-01 11:23:32 -07003565 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003566 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003567 mutex_unlock(&wq_pool_mutex);
3568
Paul E. McKenney25b00772018-11-06 19:18:45 -08003569 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003570
3571 /*
3572 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003573 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003574 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003575 if (is_last) {
3576 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003577 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003578 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003579}
3580
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003581/**
Tejun Heo699ce092013-03-13 16:51:35 -07003582 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003583 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003584 *
Tejun Heo699ce092013-03-13 16:51:35 -07003585 * If @pwq isn't freezing, set @pwq->max_active to the associated
3586 * workqueue's saved_max_active and activate delayed work items
3587 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003588 */
Tejun Heo699ce092013-03-13 16:51:35 -07003589static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003590{
Tejun Heo699ce092013-03-13 16:51:35 -07003591 struct workqueue_struct *wq = pwq->wq;
3592 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003593 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003594
Tejun Heo699ce092013-03-13 16:51:35 -07003595 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003596 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003597
3598 /* fast exit for non-freezable wqs */
3599 if (!freezable && pwq->max_active == wq->saved_max_active)
3600 return;
3601
Tejun Heo3347fa02016-09-16 15:49:32 -04003602 /* this function can be called during early boot w/ irq disabled */
3603 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003604
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003605 /*
3606 * During [un]freezing, the caller is responsible for ensuring that
3607 * this function is called at least once after @workqueue_freezing
3608 * is updated and visible.
3609 */
3610 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003611 pwq->max_active = wq->saved_max_active;
3612
3613 while (!list_empty(&pwq->delayed_works) &&
3614 pwq->nr_active < pwq->max_active)
3615 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003616
3617 /*
3618 * Need to kick a worker after thawed or an unbound wq's
3619 * max_active is bumped. It's a slow path. Do it always.
3620 */
3621 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003622 } else {
3623 pwq->max_active = 0;
3624 }
3625
Tejun Heo3347fa02016-09-16 15:49:32 -04003626 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003627}
3628
Tejun Heoe50aba92013-04-01 11:23:35 -07003629/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003630static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3631 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003632{
3633 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3634
Tejun Heoe50aba92013-04-01 11:23:35 -07003635 memset(pwq, 0, sizeof(*pwq));
3636
Tejun Heod2c1d402013-03-12 11:30:04 -07003637 pwq->pool = pool;
3638 pwq->wq = wq;
3639 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003640 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003641 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003642 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003643 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003644 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003645}
Tejun Heod2c1d402013-03-12 11:30:04 -07003646
Tejun Heof147f292013-04-01 11:23:35 -07003647/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003648static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003649{
3650 struct workqueue_struct *wq = pwq->wq;
3651
3652 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003653
Tejun Heo1befcf32013-04-01 11:23:35 -07003654 /* may be called multiple times, ignore if already linked */
3655 if (!list_empty(&pwq->pwqs_node))
3656 return;
3657
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003658 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003659 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003660
3661 /* sync max_active to the current setting */
3662 pwq_adjust_max_active(pwq);
3663
3664 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003665 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003666}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003667
Tejun Heof147f292013-04-01 11:23:35 -07003668/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3669static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3670 const struct workqueue_attrs *attrs)
3671{
3672 struct worker_pool *pool;
3673 struct pool_workqueue *pwq;
3674
3675 lockdep_assert_held(&wq_pool_mutex);
3676
3677 pool = get_unbound_pool(attrs);
3678 if (!pool)
3679 return NULL;
3680
Tejun Heoe50aba92013-04-01 11:23:35 -07003681 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003682 if (!pwq) {
3683 put_unbound_pool(pool);
3684 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003685 }
Tejun Heo6029a912013-04-01 11:23:34 -07003686
Tejun Heof147f292013-04-01 11:23:35 -07003687 init_pwq(pwq, wq, pool);
3688 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003689}
3690
Tejun Heo4c16bd32013-04-01 11:23:36 -07003691/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003692 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003693 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003694 * @node: the target NUMA node
3695 * @cpu_going_down: if >= 0, the CPU to consider as offline
3696 * @cpumask: outarg, the resulting cpumask
3697 *
3698 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3699 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003700 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003701 *
3702 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3703 * enabled and @node has online CPUs requested by @attrs, the returned
3704 * cpumask is the intersection of the possible CPUs of @node and
3705 * @attrs->cpumask.
3706 *
3707 * The caller is responsible for ensuring that the cpumask of @node stays
3708 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003709 *
3710 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3711 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003712 */
3713static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3714 int cpu_going_down, cpumask_t *cpumask)
3715{
Tejun Heod55262c2013-04-01 11:23:38 -07003716 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003717 goto use_dfl;
3718
3719 /* does @node have any online CPUs @attrs wants? */
3720 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3721 if (cpu_going_down >= 0)
3722 cpumask_clear_cpu(cpu_going_down, cpumask);
3723
3724 if (cpumask_empty(cpumask))
3725 goto use_dfl;
3726
3727 /* yeap, return possible CPUs in @node that @attrs wants */
3728 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003729
3730 if (cpumask_empty(cpumask)) {
3731 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3732 "possible intersect\n");
3733 return false;
3734 }
3735
Tejun Heo4c16bd32013-04-01 11:23:36 -07003736 return !cpumask_equal(cpumask, attrs->cpumask);
3737
3738use_dfl:
3739 cpumask_copy(cpumask, attrs->cpumask);
3740 return false;
3741}
3742
Tejun Heo1befcf32013-04-01 11:23:35 -07003743/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3744static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3745 int node,
3746 struct pool_workqueue *pwq)
3747{
3748 struct pool_workqueue *old_pwq;
3749
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003750 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003751 lockdep_assert_held(&wq->mutex);
3752
3753 /* link_pwq() can handle duplicate calls */
3754 link_pwq(pwq);
3755
3756 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3757 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3758 return old_pwq;
3759}
3760
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003761/* context to store the prepared attrs & pwqs before applying */
3762struct apply_wqattrs_ctx {
3763 struct workqueue_struct *wq; /* target workqueue */
3764 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003765 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003766 struct pool_workqueue *dfl_pwq;
3767 struct pool_workqueue *pwq_tbl[];
3768};
3769
3770/* free the resources after success or abort */
3771static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3772{
3773 if (ctx) {
3774 int node;
3775
3776 for_each_node(node)
3777 put_pwq_unlocked(ctx->pwq_tbl[node]);
3778 put_pwq_unlocked(ctx->dfl_pwq);
3779
3780 free_workqueue_attrs(ctx->attrs);
3781
3782 kfree(ctx);
3783 }
3784}
3785
3786/* allocate the attrs and pwqs for later installation */
3787static struct apply_wqattrs_ctx *
3788apply_wqattrs_prepare(struct workqueue_struct *wq,
3789 const struct workqueue_attrs *attrs)
3790{
3791 struct apply_wqattrs_ctx *ctx;
3792 struct workqueue_attrs *new_attrs, *tmp_attrs;
3793 int node;
3794
3795 lockdep_assert_held(&wq_pool_mutex);
3796
Kees Cookacafe7e2018-05-08 13:45:50 -07003797 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003798
3799 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3800 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3801 if (!ctx || !new_attrs || !tmp_attrs)
3802 goto out_free;
3803
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003804 /*
3805 * Calculate the attrs of the default pwq.
3806 * If the user configured cpumask doesn't overlap with the
3807 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3808 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003809 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003810 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003811 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3812 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003813
3814 /*
3815 * We may create multiple pwqs with differing cpumasks. Make a
3816 * copy of @new_attrs which will be modified and used to obtain
3817 * pools.
3818 */
3819 copy_workqueue_attrs(tmp_attrs, new_attrs);
3820
3821 /*
3822 * If something goes wrong during CPU up/down, we'll fall back to
3823 * the default pwq covering whole @attrs->cpumask. Always create
3824 * it even if we don't use it immediately.
3825 */
3826 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3827 if (!ctx->dfl_pwq)
3828 goto out_free;
3829
3830 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003831 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003832 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3833 if (!ctx->pwq_tbl[node])
3834 goto out_free;
3835 } else {
3836 ctx->dfl_pwq->refcnt++;
3837 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3838 }
3839 }
3840
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003841 /* save the user configured attrs and sanitize it. */
3842 copy_workqueue_attrs(new_attrs, attrs);
3843 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003844 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003845
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003846 ctx->wq = wq;
3847 free_workqueue_attrs(tmp_attrs);
3848 return ctx;
3849
3850out_free:
3851 free_workqueue_attrs(tmp_attrs);
3852 free_workqueue_attrs(new_attrs);
3853 apply_wqattrs_cleanup(ctx);
3854 return NULL;
3855}
3856
3857/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3858static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3859{
3860 int node;
3861
3862 /* all pwqs have been created successfully, let's install'em */
3863 mutex_lock(&ctx->wq->mutex);
3864
3865 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3866
3867 /* save the previous pwq and install the new one */
3868 for_each_node(node)
3869 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3870 ctx->pwq_tbl[node]);
3871
3872 /* @dfl_pwq might not have been used, ensure it's linked */
3873 link_pwq(ctx->dfl_pwq);
3874 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3875
3876 mutex_unlock(&ctx->wq->mutex);
3877}
3878
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003879static void apply_wqattrs_lock(void)
3880{
3881 /* CPUs should stay stable across pwq creations and installations */
3882 get_online_cpus();
3883 mutex_lock(&wq_pool_mutex);
3884}
3885
3886static void apply_wqattrs_unlock(void)
3887{
3888 mutex_unlock(&wq_pool_mutex);
3889 put_online_cpus();
3890}
3891
3892static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3893 const struct workqueue_attrs *attrs)
3894{
3895 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003896
3897 /* only unbound workqueues can change attributes */
3898 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3899 return -EINVAL;
3900
3901 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003902 if (!list_empty(&wq->pwqs)) {
3903 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3904 return -EINVAL;
3905
3906 wq->flags &= ~__WQ_ORDERED;
3907 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003908
3909 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003910 if (!ctx)
3911 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003912
3913 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003914 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003915 apply_wqattrs_cleanup(ctx);
3916
wanghaibin62011712016-01-07 20:38:59 +08003917 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003918}
3919
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003920/**
3921 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3922 * @wq: the target workqueue
3923 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3924 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003925 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3926 * machines, this function maps a separate pwq to each NUMA node with
3927 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3928 * NUMA node it was issued on. Older pwqs are released as in-flight work
3929 * items finish. Note that a work item which repeatedly requeues itself
3930 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003931 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003932 * Performs GFP_KERNEL allocations.
3933 *
3934 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003935 */
3936int apply_workqueue_attrs(struct workqueue_struct *wq,
3937 const struct workqueue_attrs *attrs)
3938{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003939 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003940
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003941 apply_wqattrs_lock();
3942 ret = apply_workqueue_attrs_locked(wq, attrs);
3943 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003944
Tejun Heo48621252013-04-01 11:23:31 -07003945 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003946}
NeilBrown6106c0f2018-01-11 15:06:40 +11003947EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003948
Tejun Heo4c16bd32013-04-01 11:23:36 -07003949/**
3950 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3951 * @wq: the target workqueue
3952 * @cpu: the CPU coming up or going down
3953 * @online: whether @cpu is coming up or going down
3954 *
3955 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3956 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3957 * @wq accordingly.
3958 *
3959 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3960 * falls back to @wq->dfl_pwq which may not be optimal but is always
3961 * correct.
3962 *
3963 * Note that when the last allowed CPU of a NUMA node goes offline for a
3964 * workqueue with a cpumask spanning multiple nodes, the workers which were
3965 * already executing the work items for the workqueue will lose their CPU
3966 * affinity and may execute on any CPU. This is similar to how per-cpu
3967 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3968 * affinity, it's the user's responsibility to flush the work item from
3969 * CPU_DOWN_PREPARE.
3970 */
3971static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3972 bool online)
3973{
3974 int node = cpu_to_node(cpu);
3975 int cpu_off = online ? -1 : cpu;
3976 struct pool_workqueue *old_pwq = NULL, *pwq;
3977 struct workqueue_attrs *target_attrs;
3978 cpumask_t *cpumask;
3979
3980 lockdep_assert_held(&wq_pool_mutex);
3981
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003982 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3983 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003984 return;
3985
3986 /*
3987 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3988 * Let's use a preallocated one. The following buf is protected by
3989 * CPU hotplug exclusion.
3990 */
3991 target_attrs = wq_update_unbound_numa_attrs_buf;
3992 cpumask = target_attrs->cpumask;
3993
Tejun Heo4c16bd32013-04-01 11:23:36 -07003994 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3995 pwq = unbound_pwq_by_node(wq, node);
3996
3997 /*
3998 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003999 * different from the default pwq's, we need to compare it to @pwq's
4000 * and create a new one if they don't match. If the target cpumask
4001 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004002 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004003 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004004 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004005 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004006 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004007 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004008 }
4009
Tejun Heo4c16bd32013-04-01 11:23:36 -07004010 /* create a new pwq */
4011 pwq = alloc_unbound_pwq(wq, target_attrs);
4012 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004013 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4014 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004015 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004016 }
4017
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004018 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004019 mutex_lock(&wq->mutex);
4020 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4021 goto out_unlock;
4022
4023use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004024 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004025 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4026 get_pwq(wq->dfl_pwq);
4027 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4028 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4029out_unlock:
4030 mutex_unlock(&wq->mutex);
4031 put_pwq_unlocked(old_pwq);
4032}
4033
Tejun Heo30cdf2492013-03-12 11:29:57 -07004034static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004035{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004036 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004037 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004038
Tejun Heo30cdf2492013-03-12 11:29:57 -07004039 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004040 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4041 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004042 return -ENOMEM;
4043
4044 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004045 struct pool_workqueue *pwq =
4046 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004047 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004048 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004049
Tejun Heof147f292013-04-01 11:23:35 -07004050 init_pwq(pwq, wq, &cpu_pools[highpri]);
4051
4052 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004053 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004054 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004055 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004056 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004057 } else if (wq->flags & __WQ_ORDERED) {
4058 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4059 /* there should only be single pwq for ordering guarantee */
4060 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4061 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4062 "ordering guarantee broken for workqueue %s\n", wq->name);
4063 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07004064 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004065 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004066 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004067}
4068
Tejun Heof3421792010-07-02 10:03:51 +02004069static int wq_clamp_max_active(int max_active, unsigned int flags,
4070 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004071{
Tejun Heof3421792010-07-02 10:03:51 +02004072 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4073
4074 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004075 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4076 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004077
Tejun Heof3421792010-07-02 10:03:51 +02004078 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004079}
4080
Tejun Heo983c7512018-01-08 05:38:32 -08004081/*
4082 * Workqueues which may be used during memory reclaim should have a rescuer
4083 * to guarantee forward progress.
4084 */
4085static int init_rescuer(struct workqueue_struct *wq)
4086{
4087 struct worker *rescuer;
4088 int ret;
4089
4090 if (!(wq->flags & WQ_MEM_RECLAIM))
4091 return 0;
4092
4093 rescuer = alloc_worker(NUMA_NO_NODE);
4094 if (!rescuer)
4095 return -ENOMEM;
4096
4097 rescuer->rescue_wq = wq;
4098 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4099 ret = PTR_ERR_OR_ZERO(rescuer->task);
4100 if (ret) {
4101 kfree(rescuer);
4102 return ret;
4103 }
4104
4105 wq->rescuer = rescuer;
4106 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4107 wake_up_process(rescuer->task);
4108
4109 return 0;
4110}
4111
Bart Van Assche669de8b2019-02-14 15:00:54 -08004112struct workqueue_struct *alloc_workqueue(const char *fmt,
4113 unsigned int flags,
4114 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004115{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004116 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004117 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004118 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004119 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004120
Tejun Heo5c0338c2017-07-18 18:41:52 -04004121 /*
4122 * Unbound && max_active == 1 used to imply ordered, which is no
4123 * longer the case on NUMA machines due to per-node pools. While
4124 * alloc_ordered_workqueue() is the right way to create an ordered
4125 * workqueue, keep the previous behavior to avoid subtle breakages
4126 * on NUMA.
4127 */
4128 if ((flags & WQ_UNBOUND) && max_active == 1)
4129 flags |= __WQ_ORDERED;
4130
Viresh Kumarcee22a12013-04-08 16:45:40 +05304131 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4132 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4133 flags |= WQ_UNBOUND;
4134
Tejun Heoecf68812013-04-01 11:23:34 -07004135 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004136 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004137 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004138
4139 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004140 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004141 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004142
Tejun Heo6029a912013-04-01 11:23:34 -07004143 if (flags & WQ_UNBOUND) {
4144 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4145 if (!wq->unbound_attrs)
4146 goto err_free_wq;
4147 }
4148
Bart Van Assche669de8b2019-02-14 15:00:54 -08004149 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004150 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004151 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004152
Tejun Heod320c032010-06-29 10:07:14 +02004153 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004154 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004155
Tejun Heob196be82012-01-10 15:11:35 -08004156 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004157 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004158 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004159 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004160 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004161 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004162 INIT_LIST_HEAD(&wq->flusher_queue);
4163 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004164 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004165
Bart Van Assche669de8b2019-02-14 15:00:54 -08004166 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004167 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004168
Tejun Heo30cdf2492013-03-12 11:29:57 -07004169 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004170 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004171
Tejun Heo40c17f72018-01-08 05:38:37 -08004172 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004173 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004174
Tejun Heo226223a2013-03-12 11:30:05 -07004175 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4176 goto err_destroy;
4177
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004178 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004179 * wq_pool_mutex protects global freeze state and workqueues list.
4180 * Grab it, adjust max_active and add the new @wq to workqueues
4181 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004182 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004183 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004184
Lai Jiangshana357fc02013-03-25 16:57:19 -07004185 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004186 for_each_pwq(pwq, wq)
4187 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004188 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004189
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004190 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004191
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004192 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004193
Oleg Nesterov3af244332007-05-09 02:34:09 -07004194 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004195
4196err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004197 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004198 kfree(wq);
4199 return NULL;
4200err_destroy:
4201 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004202 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004203}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004204EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004205
4206/**
4207 * destroy_workqueue - safely terminate a workqueue
4208 * @wq: target workqueue
4209 *
4210 * Safely destroy a workqueue. All work currently pending will be done first.
4211 */
4212void destroy_workqueue(struct workqueue_struct *wq)
4213{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004214 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004215 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004216
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004217 /* drain it before proceeding with destruction */
4218 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004219
Tejun Heo6183c002013-03-12 11:29:57 -07004220 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004221 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004222 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004223 int i;
4224
Tejun Heo76af4d92013-03-12 11:30:00 -07004225 for (i = 0; i < WORK_NR_COLORS; i++) {
4226 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004227 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004228 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004229 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004230 }
4231 }
4232
Lai Jiangshan5c529592013-04-04 10:05:38 +08004233 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004234 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004235 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004236 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004237 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004238 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004239 }
Tejun Heo6183c002013-03-12 11:29:57 -07004240 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004241 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004242
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004243 /*
4244 * wq list is used to freeze wq, remove from list after
4245 * flushing is complete in case freeze races us.
4246 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004247 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004248 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004249 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004250
Tejun Heo226223a2013-03-12 11:30:05 -07004251 workqueue_sysfs_unregister(wq);
4252
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004253 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004254 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004255
Tejun Heo8864b4e2013-03-12 11:30:04 -07004256 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004257 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004258 /*
4259 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004260 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004261 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004262 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004263 } else {
4264 /*
4265 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004266 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4267 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004268 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004269 for_each_node(node) {
4270 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4271 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4272 put_pwq_unlocked(pwq);
4273 }
4274
4275 /*
4276 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4277 * put. Don't access it afterwards.
4278 */
4279 pwq = wq->dfl_pwq;
4280 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004281 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004282 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004283}
4284EXPORT_SYMBOL_GPL(destroy_workqueue);
4285
Tejun Heodcd989c2010-06-29 10:07:14 +02004286/**
4287 * workqueue_set_max_active - adjust max_active of a workqueue
4288 * @wq: target workqueue
4289 * @max_active: new max_active value.
4290 *
4291 * Set max_active of @wq to @max_active.
4292 *
4293 * CONTEXT:
4294 * Don't call from IRQ context.
4295 */
4296void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4297{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004298 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004299
Tejun Heo8719dce2013-03-12 11:30:04 -07004300 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004301 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004302 return;
4303
Tejun Heof3421792010-07-02 10:03:51 +02004304 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004305
Lai Jiangshana357fc02013-03-25 16:57:19 -07004306 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004307
Tejun Heo0a94efb2017-07-23 08:36:15 -04004308 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004309 wq->saved_max_active = max_active;
4310
Tejun Heo699ce092013-03-13 16:51:35 -07004311 for_each_pwq(pwq, wq)
4312 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004313
Lai Jiangshana357fc02013-03-25 16:57:19 -07004314 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004315}
4316EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4317
4318/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004319 * current_work - retrieve %current task's work struct
4320 *
4321 * Determine if %current task is a workqueue worker and what it's working on.
4322 * Useful to find out the context that the %current task is running in.
4323 *
4324 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4325 */
4326struct work_struct *current_work(void)
4327{
4328 struct worker *worker = current_wq_worker();
4329
4330 return worker ? worker->current_work : NULL;
4331}
4332EXPORT_SYMBOL(current_work);
4333
4334/**
Tejun Heoe62676162013-03-12 17:41:37 -07004335 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4336 *
4337 * Determine whether %current is a workqueue rescuer. Can be used from
4338 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004339 *
4340 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004341 */
4342bool current_is_workqueue_rescuer(void)
4343{
4344 struct worker *worker = current_wq_worker();
4345
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004346 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004347}
4348
4349/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004350 * workqueue_congested - test whether a workqueue is congested
4351 * @cpu: CPU in question
4352 * @wq: target workqueue
4353 *
4354 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4355 * no synchronization around this function and the test result is
4356 * unreliable and only useful as advisory hints or for debugging.
4357 *
Tejun Heod3251852013-05-10 11:10:17 -07004358 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4359 * Note that both per-cpu and unbound workqueues may be associated with
4360 * multiple pool_workqueues which have separate congested states. A
4361 * workqueue being congested on one CPU doesn't mean the workqueue is also
4362 * contested on other CPUs / NUMA nodes.
4363 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004364 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004365 * %true if congested, %false otherwise.
4366 */
Tejun Heod84ff052013-03-12 11:29:59 -07004367bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004368{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004369 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004370 bool ret;
4371
Lai Jiangshan88109452013-03-20 03:28:10 +08004372 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004373
Tejun Heod3251852013-05-10 11:10:17 -07004374 if (cpu == WORK_CPU_UNBOUND)
4375 cpu = smp_processor_id();
4376
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004377 if (!(wq->flags & WQ_UNBOUND))
4378 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4379 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004380 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004381
Tejun Heo76af4d92013-03-12 11:30:00 -07004382 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004383 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004384
4385 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004386}
4387EXPORT_SYMBOL_GPL(workqueue_congested);
4388
4389/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004390 * work_busy - test whether a work is currently pending or running
4391 * @work: the work to be tested
4392 *
4393 * Test whether @work is currently pending or running. There is no
4394 * synchronization around this function and the test result is
4395 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004396 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004397 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004398 * OR'd bitmask of WORK_BUSY_* bits.
4399 */
4400unsigned int work_busy(struct work_struct *work)
4401{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004402 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004403 unsigned long flags;
4404 unsigned int ret = 0;
4405
Tejun Heodcd989c2010-06-29 10:07:14 +02004406 if (work_pending(work))
4407 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004408
Tejun Heofa1b54e2013-03-12 11:30:00 -07004409 local_irq_save(flags);
4410 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004411 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004412 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004413 if (find_worker_executing_work(pool, work))
4414 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004415 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004416 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004417 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004418
4419 return ret;
4420}
4421EXPORT_SYMBOL_GPL(work_busy);
4422
Tejun Heo3d1cb202013-04-30 15:27:22 -07004423/**
4424 * set_worker_desc - set description for the current work item
4425 * @fmt: printf-style format string
4426 * @...: arguments for the format string
4427 *
4428 * This function can be called by a running work function to describe what
4429 * the work item is about. If the worker task gets dumped, this
4430 * information will be printed out together to help debugging. The
4431 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4432 */
4433void set_worker_desc(const char *fmt, ...)
4434{
4435 struct worker *worker = current_wq_worker();
4436 va_list args;
4437
4438 if (worker) {
4439 va_start(args, fmt);
4440 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4441 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004442 }
4443}
Steffen Maier5c750d52018-05-17 19:14:57 +02004444EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004445
4446/**
4447 * print_worker_info - print out worker information and description
4448 * @log_lvl: the log level to use when printing
4449 * @task: target task
4450 *
4451 * If @task is a worker and currently executing a work item, print out the
4452 * name of the workqueue being serviced and worker description set with
4453 * set_worker_desc() by the currently executing work item.
4454 *
4455 * This function can be safely called on any task as long as the
4456 * task_struct itself is accessible. While safe, this function isn't
4457 * synchronized and may print out mixups or garbages of limited length.
4458 */
4459void print_worker_info(const char *log_lvl, struct task_struct *task)
4460{
4461 work_func_t *fn = NULL;
4462 char name[WQ_NAME_LEN] = { };
4463 char desc[WORKER_DESC_LEN] = { };
4464 struct pool_workqueue *pwq = NULL;
4465 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004466 struct worker *worker;
4467
4468 if (!(task->flags & PF_WQ_WORKER))
4469 return;
4470
4471 /*
4472 * This function is called without any synchronization and @task
4473 * could be in any state. Be careful with dereferences.
4474 */
Petr Mladeke7005912016-10-11 13:55:17 -07004475 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004476
4477 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004478 * Carefully copy the associated workqueue's workfn, name and desc.
4479 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004480 */
4481 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4482 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4483 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4484 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004485 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004486
4487 if (fn || name[0] || desc[0]) {
4488 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004489 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004490 pr_cont(" (%s)", desc);
4491 pr_cont("\n");
4492 }
4493}
4494
Tejun Heo3494fc32015-03-09 09:22:28 -04004495static void pr_cont_pool_info(struct worker_pool *pool)
4496{
4497 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4498 if (pool->node != NUMA_NO_NODE)
4499 pr_cont(" node=%d", pool->node);
4500 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4501}
4502
4503static void pr_cont_work(bool comma, struct work_struct *work)
4504{
4505 if (work->func == wq_barrier_func) {
4506 struct wq_barrier *barr;
4507
4508 barr = container_of(work, struct wq_barrier, work);
4509
4510 pr_cont("%s BAR(%d)", comma ? "," : "",
4511 task_pid_nr(barr->task));
4512 } else {
4513 pr_cont("%s %pf", comma ? "," : "", work->func);
4514 }
4515}
4516
4517static void show_pwq(struct pool_workqueue *pwq)
4518{
4519 struct worker_pool *pool = pwq->pool;
4520 struct work_struct *work;
4521 struct worker *worker;
4522 bool has_in_flight = false, has_pending = false;
4523 int bkt;
4524
4525 pr_info(" pwq %d:", pool->id);
4526 pr_cont_pool_info(pool);
4527
4528 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4529 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4530
4531 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4532 if (worker->current_pwq == pwq) {
4533 has_in_flight = true;
4534 break;
4535 }
4536 }
4537 if (has_in_flight) {
4538 bool comma = false;
4539
4540 pr_info(" in-flight:");
4541 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4542 if (worker->current_pwq != pwq)
4543 continue;
4544
4545 pr_cont("%s %d%s:%pf", comma ? "," : "",
4546 task_pid_nr(worker->task),
4547 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4548 worker->current_func);
4549 list_for_each_entry(work, &worker->scheduled, entry)
4550 pr_cont_work(false, work);
4551 comma = true;
4552 }
4553 pr_cont("\n");
4554 }
4555
4556 list_for_each_entry(work, &pool->worklist, entry) {
4557 if (get_work_pwq(work) == pwq) {
4558 has_pending = true;
4559 break;
4560 }
4561 }
4562 if (has_pending) {
4563 bool comma = false;
4564
4565 pr_info(" pending:");
4566 list_for_each_entry(work, &pool->worklist, entry) {
4567 if (get_work_pwq(work) != pwq)
4568 continue;
4569
4570 pr_cont_work(comma, work);
4571 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4572 }
4573 pr_cont("\n");
4574 }
4575
4576 if (!list_empty(&pwq->delayed_works)) {
4577 bool comma = false;
4578
4579 pr_info(" delayed:");
4580 list_for_each_entry(work, &pwq->delayed_works, entry) {
4581 pr_cont_work(comma, work);
4582 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4583 }
4584 pr_cont("\n");
4585 }
4586}
4587
4588/**
4589 * show_workqueue_state - dump workqueue state
4590 *
Roger Lu7b776af2016-07-01 11:05:02 +08004591 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4592 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004593 */
4594void show_workqueue_state(void)
4595{
4596 struct workqueue_struct *wq;
4597 struct worker_pool *pool;
4598 unsigned long flags;
4599 int pi;
4600
4601 rcu_read_lock_sched();
4602
4603 pr_info("Showing busy workqueues and worker pools:\n");
4604
4605 list_for_each_entry_rcu(wq, &workqueues, list) {
4606 struct pool_workqueue *pwq;
4607 bool idle = true;
4608
4609 for_each_pwq(pwq, wq) {
4610 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4611 idle = false;
4612 break;
4613 }
4614 }
4615 if (idle)
4616 continue;
4617
4618 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4619
4620 for_each_pwq(pwq, wq) {
4621 spin_lock_irqsave(&pwq->pool->lock, flags);
4622 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4623 show_pwq(pwq);
4624 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004625 /*
4626 * We could be printing a lot from atomic context, e.g.
4627 * sysrq-t -> show_workqueue_state(). Avoid triggering
4628 * hard lockup.
4629 */
4630 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004631 }
4632 }
4633
4634 for_each_pool(pool, pi) {
4635 struct worker *worker;
4636 bool first = true;
4637
4638 spin_lock_irqsave(&pool->lock, flags);
4639 if (pool->nr_workers == pool->nr_idle)
4640 goto next_pool;
4641
4642 pr_info("pool %d:", pool->id);
4643 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004644 pr_cont(" hung=%us workers=%d",
4645 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4646 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004647 if (pool->manager)
4648 pr_cont(" manager: %d",
4649 task_pid_nr(pool->manager->task));
4650 list_for_each_entry(worker, &pool->idle_list, entry) {
4651 pr_cont(" %s%d", first ? "idle: " : "",
4652 task_pid_nr(worker->task));
4653 first = false;
4654 }
4655 pr_cont("\n");
4656 next_pool:
4657 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004658 /*
4659 * We could be printing a lot from atomic context, e.g.
4660 * sysrq-t -> show_workqueue_state(). Avoid triggering
4661 * hard lockup.
4662 */
4663 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004664 }
4665
4666 rcu_read_unlock_sched();
4667}
4668
Tejun Heo6b598082018-05-18 08:47:13 -07004669/* used to show worker information through /proc/PID/{comm,stat,status} */
4670void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4671{
Tejun Heo6b598082018-05-18 08:47:13 -07004672 int off;
4673
4674 /* always show the actual comm */
4675 off = strscpy(buf, task->comm, size);
4676 if (off < 0)
4677 return;
4678
Tejun Heo197f6ac2018-05-21 08:04:35 -07004679 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004680 mutex_lock(&wq_pool_attach_mutex);
4681
Tejun Heo197f6ac2018-05-21 08:04:35 -07004682 if (task->flags & PF_WQ_WORKER) {
4683 struct worker *worker = kthread_data(task);
4684 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004685
Tejun Heo197f6ac2018-05-21 08:04:35 -07004686 if (pool) {
4687 spin_lock_irq(&pool->lock);
4688 /*
4689 * ->desc tracks information (wq name or
4690 * set_worker_desc()) for the latest execution. If
4691 * current, prepend '+', otherwise '-'.
4692 */
4693 if (worker->desc[0] != '\0') {
4694 if (worker->current_work)
4695 scnprintf(buf + off, size - off, "+%s",
4696 worker->desc);
4697 else
4698 scnprintf(buf + off, size - off, "-%s",
4699 worker->desc);
4700 }
4701 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004702 }
Tejun Heo6b598082018-05-18 08:47:13 -07004703 }
4704
4705 mutex_unlock(&wq_pool_attach_mutex);
4706}
4707
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004708#ifdef CONFIG_SMP
4709
Tejun Heodb7bccf2010-06-29 10:07:12 +02004710/*
4711 * CPU hotplug.
4712 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004713 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004714 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004715 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004716 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004717 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004718 * blocked draining impractical.
4719 *
Tejun Heo24647572013-01-24 11:01:33 -08004720 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004721 * running as an unbound one and allowing it to be reattached later if the
4722 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004723 */
4724
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004725static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004726{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004727 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004728 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004729
Tejun Heof02ae732013-03-12 11:30:03 -07004730 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004731 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004732 spin_lock_irq(&pool->lock);
4733
4734 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004735 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004736 * unbound and set DISASSOCIATED. Before this, all workers
4737 * except for the ones which are still executing works from
4738 * before the last CPU down must be on the cpu. After
4739 * this, they may become diasporas.
4740 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004741 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004742 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004743
Tejun Heo24647572013-01-24 11:01:33 -08004744 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004745
Tejun Heo94cf58b2013-01-24 11:01:33 -08004746 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004747 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004748
Lai Jiangshaneb283422013-03-08 15:18:28 -08004749 /*
4750 * Call schedule() so that we cross rq->lock and thus can
4751 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4752 * This is necessary as scheduler callbacks may be invoked
4753 * from other cpus.
4754 */
4755 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004756
Lai Jiangshaneb283422013-03-08 15:18:28 -08004757 /*
4758 * Sched callbacks are disabled now. Zap nr_running.
4759 * After this, nr_running stays zero and need_more_worker()
4760 * and keep_working() are always true as long as the
4761 * worklist is not empty. This pool now behaves as an
4762 * unbound (in terms of concurrency management) pool which
4763 * are served by workers tied to the pool.
4764 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004765 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004766
4767 /*
4768 * With concurrency management just turned off, a busy
4769 * worker blocking could lead to lengthy stalls. Kick off
4770 * unbound chain execution of currently pending work items.
4771 */
4772 spin_lock_irq(&pool->lock);
4773 wake_up_worker(pool);
4774 spin_unlock_irq(&pool->lock);
4775 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004776}
4777
Tejun Heobd7c0892013-03-19 13:45:21 -07004778/**
4779 * rebind_workers - rebind all workers of a pool to the associated CPU
4780 * @pool: pool of interest
4781 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004782 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004783 */
4784static void rebind_workers(struct worker_pool *pool)
4785{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004786 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004787
Tejun Heo1258fae2018-05-18 08:47:13 -07004788 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004789
Tejun Heoa9ab7752013-03-19 13:45:21 -07004790 /*
4791 * Restore CPU affinity of all workers. As all idle workers should
4792 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304793 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004794 * of all workers first and then clear UNBOUND. As we're called
4795 * from CPU_ONLINE, the following shouldn't fail.
4796 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004797 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004798 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4799 pool->attrs->cpumask) < 0);
4800
4801 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004802
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004803 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004804
Lai Jiangshanda028462014-05-20 17:46:31 +08004805 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004806 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004807
4808 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004809 * A bound idle worker should actually be on the runqueue
4810 * of the associated CPU for local wake-ups targeting it to
4811 * work. Kick all idle workers so that they migrate to the
4812 * associated CPU. Doing this in the same loop as
4813 * replacing UNBOUND with REBOUND is safe as no worker will
4814 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004815 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004816 if (worker_flags & WORKER_IDLE)
4817 wake_up_process(worker->task);
4818
4819 /*
4820 * We want to clear UNBOUND but can't directly call
4821 * worker_clr_flags() or adjust nr_running. Atomically
4822 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4823 * @worker will clear REBOUND using worker_clr_flags() when
4824 * it initiates the next execution cycle thus restoring
4825 * concurrency management. Note that when or whether
4826 * @worker clears REBOUND doesn't affect correctness.
4827 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004828 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004829 * tested without holding any lock in
4830 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4831 * fail incorrectly leading to premature concurrency
4832 * management operations.
4833 */
4834 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4835 worker_flags |= WORKER_REBOUND;
4836 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004837 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004838 }
4839
Tejun Heoa9ab7752013-03-19 13:45:21 -07004840 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004841}
4842
Tejun Heo7dbc7252013-03-19 13:45:21 -07004843/**
4844 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4845 * @pool: unbound pool of interest
4846 * @cpu: the CPU which is coming up
4847 *
4848 * An unbound pool may end up with a cpumask which doesn't have any online
4849 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4850 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4851 * online CPU before, cpus_allowed of all its workers should be restored.
4852 */
4853static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4854{
4855 static cpumask_t cpumask;
4856 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004857
Tejun Heo1258fae2018-05-18 08:47:13 -07004858 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004859
4860 /* is @cpu allowed for @pool? */
4861 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4862 return;
4863
Tejun Heo7dbc7252013-03-19 13:45:21 -07004864 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004865
4866 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004867 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004868 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004869}
4870
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004871int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004872{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004873 struct worker_pool *pool;
4874
4875 for_each_cpu_worker_pool(pool, cpu) {
4876 if (pool->nr_workers)
4877 continue;
4878 if (!create_worker(pool))
4879 return -ENOMEM;
4880 }
4881 return 0;
4882}
4883
4884int workqueue_online_cpu(unsigned int cpu)
4885{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004886 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004887 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004888 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004889
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004890 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004891
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004892 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004893 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004894
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004895 if (pool->cpu == cpu)
4896 rebind_workers(pool);
4897 else if (pool->cpu < 0)
4898 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004899
Tejun Heo1258fae2018-05-18 08:47:13 -07004900 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004901 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004902
4903 /* update NUMA affinity of unbound workqueues */
4904 list_for_each_entry(wq, &workqueues, list)
4905 wq_update_unbound_numa(wq, cpu, true);
4906
4907 mutex_unlock(&wq_pool_mutex);
4908 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004909}
4910
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004911int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004912{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004913 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004914
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004915 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004916 if (WARN_ON(cpu != smp_processor_id()))
4917 return -1;
4918
4919 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004920
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004921 /* update NUMA affinity of unbound workqueues */
4922 mutex_lock(&wq_pool_mutex);
4923 list_for_each_entry(wq, &workqueues, list)
4924 wq_update_unbound_numa(wq, cpu, false);
4925 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004926
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004927 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004928}
4929
Rusty Russell2d3854a2008-11-05 13:39:10 +11004930struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004931 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004932 long (*fn)(void *);
4933 void *arg;
4934 long ret;
4935};
4936
Tejun Heoed48ece2012-09-18 12:48:43 -07004937static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004938{
Tejun Heoed48ece2012-09-18 12:48:43 -07004939 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4940
Rusty Russell2d3854a2008-11-05 13:39:10 +11004941 wfc->ret = wfc->fn(wfc->arg);
4942}
4943
4944/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004945 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004946 * @cpu: the cpu to run on
4947 * @fn: the function to run
4948 * @arg: the function arg
4949 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004950 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004951 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004952 *
4953 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004954 */
Tejun Heod84ff052013-03-12 11:29:59 -07004955long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004956{
Tejun Heoed48ece2012-09-18 12:48:43 -07004957 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004958
Tejun Heoed48ece2012-09-18 12:48:43 -07004959 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4960 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004961 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004962 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004963 return wfc.ret;
4964}
4965EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004966
4967/**
4968 * work_on_cpu_safe - run a function in thread context on a particular cpu
4969 * @cpu: the cpu to run on
4970 * @fn: the function to run
4971 * @arg: the function argument
4972 *
4973 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4974 * any locks which would prevent @fn from completing.
4975 *
4976 * Return: The value @fn returns.
4977 */
4978long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4979{
4980 long ret = -ENODEV;
4981
4982 get_online_cpus();
4983 if (cpu_online(cpu))
4984 ret = work_on_cpu(cpu, fn, arg);
4985 put_online_cpus();
4986 return ret;
4987}
4988EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004989#endif /* CONFIG_SMP */
4990
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004991#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304992
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004993/**
4994 * freeze_workqueues_begin - begin freezing workqueues
4995 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004996 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004997 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004998 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004999 *
5000 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005001 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005002 */
5003void freeze_workqueues_begin(void)
5004{
Tejun Heo24b8a842013-03-12 11:29:58 -07005005 struct workqueue_struct *wq;
5006 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005007
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005008 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005009
Tejun Heo6183c002013-03-12 11:29:57 -07005010 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005011 workqueue_freezing = true;
5012
Tejun Heo24b8a842013-03-12 11:29:58 -07005013 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005014 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005015 for_each_pwq(pwq, wq)
5016 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005017 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005018 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005019
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005020 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005021}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005022
5023/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005024 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005025 *
5026 * Check whether freezing is complete. This function must be called
5027 * between freeze_workqueues_begin() and thaw_workqueues().
5028 *
5029 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005030 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005031 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005032 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005033 * %true if some freezable workqueues are still busy. %false if freezing
5034 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005035 */
5036bool freeze_workqueues_busy(void)
5037{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005038 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005039 struct workqueue_struct *wq;
5040 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005041
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005042 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005043
Tejun Heo6183c002013-03-12 11:29:57 -07005044 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005045
Tejun Heo24b8a842013-03-12 11:29:58 -07005046 list_for_each_entry(wq, &workqueues, list) {
5047 if (!(wq->flags & WQ_FREEZABLE))
5048 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005049 /*
5050 * nr_active is monotonically decreasing. It's safe
5051 * to peek without lock.
5052 */
Lai Jiangshan88109452013-03-20 03:28:10 +08005053 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07005054 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005055 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005056 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005057 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08005058 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005059 goto out_unlock;
5060 }
5061 }
Lai Jiangshan88109452013-03-20 03:28:10 +08005062 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005063 }
5064out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005065 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005066 return busy;
5067}
5068
5069/**
5070 * thaw_workqueues - thaw workqueues
5071 *
5072 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005073 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005074 *
5075 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005076 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005077 */
5078void thaw_workqueues(void)
5079{
Tejun Heo24b8a842013-03-12 11:29:58 -07005080 struct workqueue_struct *wq;
5081 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005082
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005083 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005084
5085 if (!workqueue_freezing)
5086 goto out_unlock;
5087
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005088 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005089
Tejun Heo24b8a842013-03-12 11:29:58 -07005090 /* restore max_active and repopulate worklist */
5091 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005092 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005093 for_each_pwq(pwq, wq)
5094 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005095 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005096 }
5097
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005098out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005099 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005100}
5101#endif /* CONFIG_FREEZER */
5102
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005103static int workqueue_apply_unbound_cpumask(void)
5104{
5105 LIST_HEAD(ctxs);
5106 int ret = 0;
5107 struct workqueue_struct *wq;
5108 struct apply_wqattrs_ctx *ctx, *n;
5109
5110 lockdep_assert_held(&wq_pool_mutex);
5111
5112 list_for_each_entry(wq, &workqueues, list) {
5113 if (!(wq->flags & WQ_UNBOUND))
5114 continue;
5115 /* creating multiple pwqs breaks ordering guarantee */
5116 if (wq->flags & __WQ_ORDERED)
5117 continue;
5118
5119 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5120 if (!ctx) {
5121 ret = -ENOMEM;
5122 break;
5123 }
5124
5125 list_add_tail(&ctx->list, &ctxs);
5126 }
5127
5128 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5129 if (!ret)
5130 apply_wqattrs_commit(ctx);
5131 apply_wqattrs_cleanup(ctx);
5132 }
5133
5134 return ret;
5135}
5136
5137/**
5138 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5139 * @cpumask: the cpumask to set
5140 *
5141 * The low-level workqueues cpumask is a global cpumask that limits
5142 * the affinity of all unbound workqueues. This function check the @cpumask
5143 * and apply it to all unbound workqueues and updates all pwqs of them.
5144 *
5145 * Retun: 0 - Success
5146 * -EINVAL - Invalid @cpumask
5147 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5148 */
5149int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5150{
5151 int ret = -EINVAL;
5152 cpumask_var_t saved_cpumask;
5153
5154 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5155 return -ENOMEM;
5156
Tal Shorerc98a9802017-11-03 17:27:50 +02005157 /*
5158 * Not excluding isolated cpus on purpose.
5159 * If the user wishes to include them, we allow that.
5160 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005161 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5162 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005163 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005164
5165 /* save the old wq_unbound_cpumask. */
5166 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5167
5168 /* update wq_unbound_cpumask at first and apply it to wqs. */
5169 cpumask_copy(wq_unbound_cpumask, cpumask);
5170 ret = workqueue_apply_unbound_cpumask();
5171
5172 /* restore the wq_unbound_cpumask when failed. */
5173 if (ret < 0)
5174 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5175
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005176 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005177 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005178
5179 free_cpumask_var(saved_cpumask);
5180 return ret;
5181}
5182
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005183#ifdef CONFIG_SYSFS
5184/*
5185 * Workqueues with WQ_SYSFS flag set is visible to userland via
5186 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5187 * following attributes.
5188 *
5189 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5190 * max_active RW int : maximum number of in-flight work items
5191 *
5192 * Unbound workqueues have the following extra attributes.
5193 *
Wang Long9a19b462017-11-02 23:05:12 -04005194 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005195 * nice RW int : nice value of the workers
5196 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005197 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005198 */
5199struct wq_device {
5200 struct workqueue_struct *wq;
5201 struct device dev;
5202};
5203
5204static struct workqueue_struct *dev_to_wq(struct device *dev)
5205{
5206 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5207
5208 return wq_dev->wq;
5209}
5210
5211static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5212 char *buf)
5213{
5214 struct workqueue_struct *wq = dev_to_wq(dev);
5215
5216 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5217}
5218static DEVICE_ATTR_RO(per_cpu);
5219
5220static ssize_t max_active_show(struct device *dev,
5221 struct device_attribute *attr, char *buf)
5222{
5223 struct workqueue_struct *wq = dev_to_wq(dev);
5224
5225 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5226}
5227
5228static ssize_t max_active_store(struct device *dev,
5229 struct device_attribute *attr, const char *buf,
5230 size_t count)
5231{
5232 struct workqueue_struct *wq = dev_to_wq(dev);
5233 int val;
5234
5235 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5236 return -EINVAL;
5237
5238 workqueue_set_max_active(wq, val);
5239 return count;
5240}
5241static DEVICE_ATTR_RW(max_active);
5242
5243static struct attribute *wq_sysfs_attrs[] = {
5244 &dev_attr_per_cpu.attr,
5245 &dev_attr_max_active.attr,
5246 NULL,
5247};
5248ATTRIBUTE_GROUPS(wq_sysfs);
5249
5250static ssize_t wq_pool_ids_show(struct device *dev,
5251 struct device_attribute *attr, char *buf)
5252{
5253 struct workqueue_struct *wq = dev_to_wq(dev);
5254 const char *delim = "";
5255 int node, written = 0;
5256
5257 rcu_read_lock_sched();
5258 for_each_node(node) {
5259 written += scnprintf(buf + written, PAGE_SIZE - written,
5260 "%s%d:%d", delim, node,
5261 unbound_pwq_by_node(wq, node)->pool->id);
5262 delim = " ";
5263 }
5264 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5265 rcu_read_unlock_sched();
5266
5267 return written;
5268}
5269
5270static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5271 char *buf)
5272{
5273 struct workqueue_struct *wq = dev_to_wq(dev);
5274 int written;
5275
5276 mutex_lock(&wq->mutex);
5277 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5278 mutex_unlock(&wq->mutex);
5279
5280 return written;
5281}
5282
5283/* prepare workqueue_attrs for sysfs store operations */
5284static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5285{
5286 struct workqueue_attrs *attrs;
5287
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005288 lockdep_assert_held(&wq_pool_mutex);
5289
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005290 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5291 if (!attrs)
5292 return NULL;
5293
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005294 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005295 return attrs;
5296}
5297
5298static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5299 const char *buf, size_t count)
5300{
5301 struct workqueue_struct *wq = dev_to_wq(dev);
5302 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005303 int ret = -ENOMEM;
5304
5305 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005306
5307 attrs = wq_sysfs_prep_attrs(wq);
5308 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005309 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005310
5311 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5312 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005313 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005314 else
5315 ret = -EINVAL;
5316
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005317out_unlock:
5318 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005319 free_workqueue_attrs(attrs);
5320 return ret ?: count;
5321}
5322
5323static ssize_t wq_cpumask_show(struct device *dev,
5324 struct device_attribute *attr, char *buf)
5325{
5326 struct workqueue_struct *wq = dev_to_wq(dev);
5327 int written;
5328
5329 mutex_lock(&wq->mutex);
5330 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5331 cpumask_pr_args(wq->unbound_attrs->cpumask));
5332 mutex_unlock(&wq->mutex);
5333 return written;
5334}
5335
5336static ssize_t wq_cpumask_store(struct device *dev,
5337 struct device_attribute *attr,
5338 const char *buf, size_t count)
5339{
5340 struct workqueue_struct *wq = dev_to_wq(dev);
5341 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005342 int ret = -ENOMEM;
5343
5344 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005345
5346 attrs = wq_sysfs_prep_attrs(wq);
5347 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005348 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005349
5350 ret = cpumask_parse(buf, attrs->cpumask);
5351 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005352 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005353
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005354out_unlock:
5355 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005356 free_workqueue_attrs(attrs);
5357 return ret ?: count;
5358}
5359
5360static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5361 char *buf)
5362{
5363 struct workqueue_struct *wq = dev_to_wq(dev);
5364 int written;
5365
5366 mutex_lock(&wq->mutex);
5367 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5368 !wq->unbound_attrs->no_numa);
5369 mutex_unlock(&wq->mutex);
5370
5371 return written;
5372}
5373
5374static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5375 const char *buf, size_t count)
5376{
5377 struct workqueue_struct *wq = dev_to_wq(dev);
5378 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005379 int v, ret = -ENOMEM;
5380
5381 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005382
5383 attrs = wq_sysfs_prep_attrs(wq);
5384 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005385 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005386
5387 ret = -EINVAL;
5388 if (sscanf(buf, "%d", &v) == 1) {
5389 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005390 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005391 }
5392
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005393out_unlock:
5394 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005395 free_workqueue_attrs(attrs);
5396 return ret ?: count;
5397}
5398
5399static struct device_attribute wq_sysfs_unbound_attrs[] = {
5400 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5401 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5402 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5403 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5404 __ATTR_NULL,
5405};
5406
5407static struct bus_type wq_subsys = {
5408 .name = "workqueue",
5409 .dev_groups = wq_sysfs_groups,
5410};
5411
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005412static ssize_t wq_unbound_cpumask_show(struct device *dev,
5413 struct device_attribute *attr, char *buf)
5414{
5415 int written;
5416
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005417 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005418 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5419 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005420 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005421
5422 return written;
5423}
5424
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005425static ssize_t wq_unbound_cpumask_store(struct device *dev,
5426 struct device_attribute *attr, const char *buf, size_t count)
5427{
5428 cpumask_var_t cpumask;
5429 int ret;
5430
5431 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5432 return -ENOMEM;
5433
5434 ret = cpumask_parse(buf, cpumask);
5435 if (!ret)
5436 ret = workqueue_set_unbound_cpumask(cpumask);
5437
5438 free_cpumask_var(cpumask);
5439 return ret ? ret : count;
5440}
5441
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005442static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005443 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5444 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005445
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005446static int __init wq_sysfs_init(void)
5447{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005448 int err;
5449
5450 err = subsys_virtual_register(&wq_subsys, NULL);
5451 if (err)
5452 return err;
5453
5454 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005455}
5456core_initcall(wq_sysfs_init);
5457
5458static void wq_device_release(struct device *dev)
5459{
5460 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5461
5462 kfree(wq_dev);
5463}
5464
5465/**
5466 * workqueue_sysfs_register - make a workqueue visible in sysfs
5467 * @wq: the workqueue to register
5468 *
5469 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5470 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5471 * which is the preferred method.
5472 *
5473 * Workqueue user should use this function directly iff it wants to apply
5474 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5475 * apply_workqueue_attrs() may race against userland updating the
5476 * attributes.
5477 *
5478 * Return: 0 on success, -errno on failure.
5479 */
5480int workqueue_sysfs_register(struct workqueue_struct *wq)
5481{
5482 struct wq_device *wq_dev;
5483 int ret;
5484
5485 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305486 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005487 * attributes breaks ordering guarantee. Disallow exposing ordered
5488 * workqueues.
5489 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005490 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005491 return -EINVAL;
5492
5493 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5494 if (!wq_dev)
5495 return -ENOMEM;
5496
5497 wq_dev->wq = wq;
5498 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005499 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005500 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005501
5502 /*
5503 * unbound_attrs are created separately. Suppress uevent until
5504 * everything is ready.
5505 */
5506 dev_set_uevent_suppress(&wq_dev->dev, true);
5507
5508 ret = device_register(&wq_dev->dev);
5509 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305510 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005511 wq->wq_dev = NULL;
5512 return ret;
5513 }
5514
5515 if (wq->flags & WQ_UNBOUND) {
5516 struct device_attribute *attr;
5517
5518 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5519 ret = device_create_file(&wq_dev->dev, attr);
5520 if (ret) {
5521 device_unregister(&wq_dev->dev);
5522 wq->wq_dev = NULL;
5523 return ret;
5524 }
5525 }
5526 }
5527
5528 dev_set_uevent_suppress(&wq_dev->dev, false);
5529 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5530 return 0;
5531}
5532
5533/**
5534 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5535 * @wq: the workqueue to unregister
5536 *
5537 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5538 */
5539static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5540{
5541 struct wq_device *wq_dev = wq->wq_dev;
5542
5543 if (!wq->wq_dev)
5544 return;
5545
5546 wq->wq_dev = NULL;
5547 device_unregister(&wq_dev->dev);
5548}
5549#else /* CONFIG_SYSFS */
5550static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5551#endif /* CONFIG_SYSFS */
5552
Tejun Heo82607adc2015-12-08 11:28:04 -05005553/*
5554 * Workqueue watchdog.
5555 *
5556 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5557 * flush dependency, a concurrency managed work item which stays RUNNING
5558 * indefinitely. Workqueue stalls can be very difficult to debug as the
5559 * usual warning mechanisms don't trigger and internal workqueue state is
5560 * largely opaque.
5561 *
5562 * Workqueue watchdog monitors all worker pools periodically and dumps
5563 * state if some pools failed to make forward progress for a while where
5564 * forward progress is defined as the first item on ->worklist changing.
5565 *
5566 * This mechanism is controlled through the kernel parameter
5567 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5568 * corresponding sysfs parameter file.
5569 */
5570#ifdef CONFIG_WQ_WATCHDOG
5571
Tejun Heo82607adc2015-12-08 11:28:04 -05005572static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005573static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005574
5575static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5576static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5577
5578static void wq_watchdog_reset_touched(void)
5579{
5580 int cpu;
5581
5582 wq_watchdog_touched = jiffies;
5583 for_each_possible_cpu(cpu)
5584 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5585}
5586
Kees Cook5cd79d62017-10-04 16:27:00 -07005587static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005588{
5589 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5590 bool lockup_detected = false;
5591 struct worker_pool *pool;
5592 int pi;
5593
5594 if (!thresh)
5595 return;
5596
5597 rcu_read_lock();
5598
5599 for_each_pool(pool, pi) {
5600 unsigned long pool_ts, touched, ts;
5601
5602 if (list_empty(&pool->worklist))
5603 continue;
5604
5605 /* get the latest of pool and touched timestamps */
5606 pool_ts = READ_ONCE(pool->watchdog_ts);
5607 touched = READ_ONCE(wq_watchdog_touched);
5608
5609 if (time_after(pool_ts, touched))
5610 ts = pool_ts;
5611 else
5612 ts = touched;
5613
5614 if (pool->cpu >= 0) {
5615 unsigned long cpu_touched =
5616 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5617 pool->cpu));
5618 if (time_after(cpu_touched, ts))
5619 ts = cpu_touched;
5620 }
5621
5622 /* did we stall? */
5623 if (time_after(jiffies, ts + thresh)) {
5624 lockup_detected = true;
5625 pr_emerg("BUG: workqueue lockup - pool");
5626 pr_cont_pool_info(pool);
5627 pr_cont(" stuck for %us!\n",
5628 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5629 }
5630 }
5631
5632 rcu_read_unlock();
5633
5634 if (lockup_detected)
5635 show_workqueue_state();
5636
5637 wq_watchdog_reset_touched();
5638 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5639}
5640
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005641notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005642{
5643 if (cpu >= 0)
5644 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5645 else
5646 wq_watchdog_touched = jiffies;
5647}
5648
5649static void wq_watchdog_set_thresh(unsigned long thresh)
5650{
5651 wq_watchdog_thresh = 0;
5652 del_timer_sync(&wq_watchdog_timer);
5653
5654 if (thresh) {
5655 wq_watchdog_thresh = thresh;
5656 wq_watchdog_reset_touched();
5657 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5658 }
5659}
5660
5661static int wq_watchdog_param_set_thresh(const char *val,
5662 const struct kernel_param *kp)
5663{
5664 unsigned long thresh;
5665 int ret;
5666
5667 ret = kstrtoul(val, 0, &thresh);
5668 if (ret)
5669 return ret;
5670
5671 if (system_wq)
5672 wq_watchdog_set_thresh(thresh);
5673 else
5674 wq_watchdog_thresh = thresh;
5675
5676 return 0;
5677}
5678
5679static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5680 .set = wq_watchdog_param_set_thresh,
5681 .get = param_get_ulong,
5682};
5683
5684module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5685 0644);
5686
5687static void wq_watchdog_init(void)
5688{
Kees Cook5cd79d62017-10-04 16:27:00 -07005689 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005690 wq_watchdog_set_thresh(wq_watchdog_thresh);
5691}
5692
5693#else /* CONFIG_WQ_WATCHDOG */
5694
5695static inline void wq_watchdog_init(void) { }
5696
5697#endif /* CONFIG_WQ_WATCHDOG */
5698
Tejun Heobce90382013-04-01 11:23:32 -07005699static void __init wq_numa_init(void)
5700{
5701 cpumask_var_t *tbl;
5702 int node, cpu;
5703
Tejun Heobce90382013-04-01 11:23:32 -07005704 if (num_possible_nodes() <= 1)
5705 return;
5706
Tejun Heod55262c2013-04-01 11:23:38 -07005707 if (wq_disable_numa) {
5708 pr_info("workqueue: NUMA affinity support disabled\n");
5709 return;
5710 }
5711
Tejun Heo4c16bd32013-04-01 11:23:36 -07005712 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5713 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5714
Tejun Heobce90382013-04-01 11:23:32 -07005715 /*
5716 * We want masks of possible CPUs of each node which isn't readily
5717 * available. Build one from cpu_to_node() which should have been
5718 * fully initialized by now.
5719 */
Kees Cook6396bb22018-06-12 14:03:40 -07005720 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005721 BUG_ON(!tbl);
5722
5723 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005724 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005725 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005726
5727 for_each_possible_cpu(cpu) {
5728 node = cpu_to_node(cpu);
5729 if (WARN_ON(node == NUMA_NO_NODE)) {
5730 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5731 /* happens iff arch is bonkers, let's just proceed */
5732 return;
5733 }
5734 cpumask_set_cpu(cpu, tbl[node]);
5735 }
5736
5737 wq_numa_possible_cpumask = tbl;
5738 wq_numa_enabled = true;
5739}
5740
Tejun Heo3347fa02016-09-16 15:49:32 -04005741/**
5742 * workqueue_init_early - early init for workqueue subsystem
5743 *
5744 * This is the first half of two-staged workqueue subsystem initialization
5745 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5746 * idr are up. It sets up all the data structures and system workqueues
5747 * and allows early boot code to create workqueues and queue/cancel work
5748 * items. Actual work item execution starts only after kthreads can be
5749 * created and scheduled right before early initcalls.
5750 */
5751int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005752{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005753 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005754 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005755 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005756
Tejun Heoe904e6c2013-03-12 11:29:57 -07005757 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5758
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005759 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005760 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005761
Tejun Heoe904e6c2013-03-12 11:29:57 -07005762 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5763
Tejun Heo706026c2013-01-24 11:01:34 -08005764 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005765 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005766 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005767
Tejun Heo7a4e3442013-03-12 11:30:00 -07005768 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005769 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005770 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005771 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005772 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005773 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005774 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005775
Tejun Heo9daf9e62013-01-24 11:01:33 -08005776 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005777 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005778 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005779 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005780 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005781 }
5782
Tejun Heo8a2b7532013-09-05 12:30:04 -04005783 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005784 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5785 struct workqueue_attrs *attrs;
5786
5787 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005788 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005789 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005790
5791 /*
5792 * An ordered wq should have only one pwq as ordering is
5793 * guaranteed by max_active which is enforced by pwqs.
5794 * Turn off NUMA so that dfl_pwq is used for all nodes.
5795 */
5796 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5797 attrs->nice = std_nice[i];
5798 attrs->no_numa = true;
5799 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005800 }
5801
Tejun Heod320c032010-06-29 10:07:14 +02005802 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005803 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005804 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005805 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5806 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005807 system_freezable_wq = alloc_workqueue("events_freezable",
5808 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305809 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5810 WQ_POWER_EFFICIENT, 0);
5811 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5812 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5813 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005814 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305815 !system_unbound_wq || !system_freezable_wq ||
5816 !system_power_efficient_wq ||
5817 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005818
Tejun Heo3347fa02016-09-16 15:49:32 -04005819 return 0;
5820}
5821
5822/**
5823 * workqueue_init - bring workqueue subsystem fully online
5824 *
5825 * This is the latter half of two-staged workqueue subsystem initialization
5826 * and invoked as soon as kthreads can be created and scheduled.
5827 * Workqueues have been created and work items queued on them, but there
5828 * are no kworkers executing the work items yet. Populate the worker pools
5829 * with the initial workers and enable future kworker creations.
5830 */
5831int __init workqueue_init(void)
5832{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005833 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005834 struct worker_pool *pool;
5835 int cpu, bkt;
5836
Tejun Heo2186d9f2016-10-19 12:01:27 -04005837 /*
5838 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5839 * CPU to node mapping may not be available that early on some
5840 * archs such as power and arm64. As per-cpu pools created
5841 * previously could be missing node hint and unbound pools NUMA
5842 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005843 *
5844 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005845 */
5846 wq_numa_init();
5847
5848 mutex_lock(&wq_pool_mutex);
5849
5850 for_each_possible_cpu(cpu) {
5851 for_each_cpu_worker_pool(pool, cpu) {
5852 pool->node = cpu_to_node(cpu);
5853 }
5854 }
5855
Tejun Heo40c17f72018-01-08 05:38:37 -08005856 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005857 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005858 WARN(init_rescuer(wq),
5859 "workqueue: failed to create early rescuer for %s",
5860 wq->name);
5861 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005862
5863 mutex_unlock(&wq_pool_mutex);
5864
Tejun Heo3347fa02016-09-16 15:49:32 -04005865 /* create the initial workers */
5866 for_each_online_cpu(cpu) {
5867 for_each_cpu_worker_pool(pool, cpu) {
5868 pool->flags &= ~POOL_DISASSOCIATED;
5869 BUG_ON(!create_worker(pool));
5870 }
5871 }
5872
5873 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5874 BUG_ON(!create_worker(pool));
5875
5876 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005877 wq_watchdog_init();
5878
Suresh Siddha6ee05782010-07-30 14:57:37 -07005879 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005880}