blob: 21721faa923c84ef800f633ef01a62a09cbe7675 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070024 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070044#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050045#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070046#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070047#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070048#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070049#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020050#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090051#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020052
Tejun Heoea138442013-01-18 14:05:55 -080053#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070056 /*
Tejun Heo24647572013-01-24 11:01:33 -080057 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 *
Tejun Heo24647572013-01-24 11:01:33 -080059 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 * While associated (!DISASSOCIATED), all workers are bound to the
61 * CPU and none has %WORKER_UNBOUND set and concurrency management
62 * is in effect.
63 *
64 * While DISASSOCIATED, the cpu may be offline and all workers have
65 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080066 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070067 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070068 * Note that DISASSOCIATED should be flipped only while holding
Tejun Heo1258fae2018-05-18 08:47:13 -070069 * wq_pool_attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080070 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070071 */
Tejun Heo692b4822017-10-09 08:04:13 -070072 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080073 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020074
Tejun Heoc8e55f32010-06-29 10:07:12 +020075 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 WORKER_DIE = 1 << 1, /* die die die */
77 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020078 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020079 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020080 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020082
Tejun Heoa9ab7752013-03-19 13:45:21 -070083 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
84 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020085
Tejun Heoe34cdddb2013-01-24 11:01:33 -080086 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070087
Tejun Heo29c91e92013-03-12 11:30:03 -070088 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020089 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020090
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
92 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
93
Tejun Heo3233cdb2011-02-16 18:10:19 +010094 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
95 /* call for help after 10ms
96 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020097 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
98 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020099
100 /*
101 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200103 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800104 RESCUER_NICE_LEVEL = MIN_NICE,
105 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700106
107 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200108};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200111 * Structure fields follow one of the following exclusion rules.
112 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200113 * I: Modifiable by initialization/destruction paths and read-only for
114 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * P: Preemption protected. Disabling preemption is enough and should
117 * only be modified and accessed from the local cpu.
118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200120 *
Tejun Heod565ed62013-01-24 11:01:33 -0800121 * X: During normal operation, modification requires pool->lock and should
122 * be done only from local cpu. Either disabling preemption on local
123 * cpu or grabbing pool->lock is enough for read access. If
124 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200125 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700126 * A: wq_pool_attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700129 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700130 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700131 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800132 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
133 *
134 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
135 * sched-RCU for reads.
136 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700137 * WQ: wq->mutex protected.
138 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700139 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700140 *
141 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200142 */
143
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800144/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200145
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800147 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700148 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700149 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800150 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700151 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700152
Tejun Heo82607adc2015-12-08 11:28:04 -0500153 unsigned long watchdog_ts; /* L: watchdog timestamp */
154
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700156
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800157 int nr_workers; /* L: total number of workers */
158 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159
160 struct list_head idle_list; /* X: list of idle workers */
161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for workers */
163
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700164 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800165 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
166 /* L: hash of busy workers */
167
Tejun Heo2607d7a2015-03-09 09:22:28 -0400168 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800169 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800170 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800171
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800172 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Tejun Heo7a4e3442013-03-12 11:30:00 -0700174 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700175 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
176 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700177
Tejun Heoe19e3972013-01-24 11:39:44 -0800178 /*
179 * The current concurrency level. As it's likely to be accessed
180 * from other CPUs during try_to_wake_up(), put it in a separate
181 * cacheline.
182 */
183 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700184
185 /*
186 * Destruction of pool is sched-RCU protected to allow dereferences
187 * from get_work_pool().
188 */
189 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200190} ____cacheline_aligned_in_smp;
191
192/*
Tejun Heo112202d2013-02-13 19:29:12 -0800193 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
194 * of work_struct->data are used for flags and the remaining high bits
195 * point to the pwq; thus, pwqs need to be aligned at two's power of the
196 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
Tejun Heo112202d2013-02-13 19:29:12 -0800198struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700199 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200200 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200201 int work_color; /* L: current color */
202 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700203 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 int nr_in_flight[WORK_NR_COLORS];
205 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200206 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200207 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700209 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700210 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211
212 /*
213 * Release of unbound pwq is punted to system_wq. See put_pwq()
214 * and pwq_unbound_release_workfn() for details. pool_workqueue
215 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700216 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700217 */
218 struct work_struct unbound_release_work;
219 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700220} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 * Structure used to wait for workqueue flush.
224 */
225struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700226 struct list_head list; /* WQ: list of flushers */
227 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200228 struct completion done; /* flush completion */
229};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Tejun Heo226223a2013-03-12 11:30:05 -0700231struct wq_device;
232
Tejun Heo73f53c42010-06-29 10:07:11 +0200233/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700234 * The externally visible workqueue. It relays the issued work items to
235 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 */
237struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700238 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400239 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200240
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct mutex mutex; /* protects this wq */
242 int work_color; /* WQ: current work color */
243 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800244 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct wq_flusher *first_flusher; /* WQ: first flusher */
246 struct list_head flusher_queue; /* WQ: flush waiters */
247 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200248
Tejun Heo2e109a22013-03-13 19:47:40 -0700249 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200250 struct worker *rescuer; /* I: rescue worker */
251
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700252 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700253 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700254
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800255 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
256 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700257
Tejun Heo226223a2013-03-12 11:30:05 -0700258#ifdef CONFIG_SYSFS
259 struct wq_device *wq_dev; /* I: for sysfs interface */
260#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700261#ifdef CONFIG_LOCKDEP
Bart Van Assche669de8b2019-02-14 15:00:54 -0800262 char *lock_name;
263 struct lock_class_key key;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700266 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700267
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400268 /*
269 * Destruction of workqueue_struct is sched-RCU protected to allow
270 * walking the workqueues list without grabbing wq_pool_mutex.
271 * This is used to dump all workqueues from sysrq.
272 */
273 struct rcu_head rcu;
274
Tejun Heo2728fd22013-04-01 11:23:35 -0700275 /* hot fields used during command issue, aligned to cacheline */
276 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
277 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800278 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279};
280
Tejun Heoe904e6c2013-03-12 11:29:57 -0700281static struct kmem_cache *pwq_cache;
282
Tejun Heobce90382013-04-01 11:23:32 -0700283static cpumask_var_t *wq_numa_possible_cpumask;
284 /* possible CPUs of each node */
285
Tejun Heod55262c2013-04-01 11:23:38 -0700286static bool wq_disable_numa;
287module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930290static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292
Tejun Heo863b7102016-09-16 15:49:34 -0400293static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400294
Tejun Heobce90382013-04-01 11:23:32 -0700295static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
296
Tejun Heo4c16bd32013-04-01 11:23:36 -0700297/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
298static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
299
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700301static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
Tejun Heo2e109a22013-03-13 19:47:40 -0700302static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo692b4822017-10-09 08:04:13 -0700303static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700304
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400305static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700306static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700307
Mike Galbraithef5571802016-02-09 17:59:38 -0500308/* PL: allowable cpus for unbound wqs and work items */
309static cpumask_var_t wq_unbound_cpumask;
310
311/* CPU where unbound work was last round robin scheduled from this CPU */
312static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800313
Tejun Heof303fccb2016-02-09 17:59:38 -0500314/*
315 * Local execution of unbound work items is no longer guaranteed. The
316 * following always forces round-robin CPU selection on unbound work items
317 * to uncover usages which depend on it.
318 */
319#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
320static bool wq_debug_force_rr_cpu = true;
321#else
322static bool wq_debug_force_rr_cpu = false;
323#endif
324module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
325
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700326/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700327static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700328
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700329static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700330
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700331/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700332static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
333
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700334/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700335static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
336
Tejun Heo8a2b7532013-09-05 12:30:04 -0400337/* I: attributes used when instantiating ordered pools on demand */
338static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
339
Tejun Heod320c032010-06-29 10:07:14 +0200340struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400341EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300342struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900343EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200345EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300346struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200347EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300348struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100349EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530350struct workqueue_struct *system_power_efficient_wq __read_mostly;
351EXPORT_SYMBOL_GPL(system_power_efficient_wq);
352struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
353EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200354
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700355static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800356static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700357
Tejun Heo97bd2342010-10-05 10:41:14 +0200358#define CREATE_TRACE_POINTS
359#include <trace/events/workqueue.h>
360
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700361#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700362 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
363 !lockdep_is_held(&wq_pool_mutex), \
364 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700365
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700366#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700367 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
368 !lockdep_is_held(&wq->mutex), \
369 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700370
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800371#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700372 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
373 !lockdep_is_held(&wq->mutex) && \
374 !lockdep_is_held(&wq_pool_mutex), \
375 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800376
Tejun Heof02ae732013-03-12 11:30:03 -0700377#define for_each_cpu_worker_pool(pool, cpu) \
378 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
379 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700380 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700381
Tejun Heo49e3cf42013-03-12 11:29:58 -0700382/**
Tejun Heo17116962013-03-12 11:29:58 -0700383 * for_each_pool - iterate through all worker_pools in the system
384 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700385 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700386 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700387 * This must be called either with wq_pool_mutex held or sched RCU read
388 * locked. If the pool needs to be used beyond the locking in effect, the
389 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700390 *
391 * The if/else clause exists only for the lockdep assertion and can be
392 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700393 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700394#define for_each_pool(pool, pi) \
395 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700396 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700397 else
Tejun Heo17116962013-03-12 11:29:58 -0700398
399/**
Tejun Heo822d8402013-03-19 13:45:21 -0700400 * for_each_pool_worker - iterate through all workers of a worker_pool
401 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700402 * @pool: worker_pool to iterate workers of
403 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700404 * This must be called with wq_pool_attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700405 *
406 * The if/else clause exists only for the lockdep assertion and can be
407 * ignored.
408 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800409#define for_each_pool_worker(worker, pool) \
410 list_for_each_entry((worker), &(pool)->workers, node) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700411 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700412 else
413
414/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700415 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
416 * @pwq: iteration cursor
417 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700418 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700419 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18bc2013-03-13 19:47:40 -0700420 * If the pwq needs to be used beyond the locking in effect, the caller is
421 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700422 *
423 * The if/else clause exists only for the lockdep assertion and can be
424 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700425 */
426#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700427 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700428 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700429 else
Tejun Heof3421792010-07-02 10:03:51 +0200430
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900431#ifdef CONFIG_DEBUG_OBJECTS_WORK
432
433static struct debug_obj_descr work_debug_descr;
434
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100435static void *work_debug_hint(void *addr)
436{
437 return ((struct work_struct *) addr)->func;
438}
439
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700440static bool work_is_static_object(void *addr)
441{
442 struct work_struct *work = addr;
443
444 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
445}
446
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900447/*
448 * fixup_init is called when:
449 * - an active object is initialized
450 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700451static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900452{
453 struct work_struct *work = addr;
454
455 switch (state) {
456 case ODEBUG_STATE_ACTIVE:
457 cancel_work_sync(work);
458 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700459 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900460 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700461 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462 }
463}
464
465/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900466 * fixup_free is called when:
467 * - an active object is freed
468 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700469static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900470{
471 struct work_struct *work = addr;
472
473 switch (state) {
474 case ODEBUG_STATE_ACTIVE:
475 cancel_work_sync(work);
476 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700479 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900480 }
481}
482
483static struct debug_obj_descr work_debug_descr = {
484 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100485 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700486 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900487 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900488 .fixup_free = work_fixup_free,
489};
490
491static inline void debug_work_activate(struct work_struct *work)
492{
493 debug_object_activate(work, &work_debug_descr);
494}
495
496static inline void debug_work_deactivate(struct work_struct *work)
497{
498 debug_object_deactivate(work, &work_debug_descr);
499}
500
501void __init_work(struct work_struct *work, int onstack)
502{
503 if (onstack)
504 debug_object_init_on_stack(work, &work_debug_descr);
505 else
506 debug_object_init(work, &work_debug_descr);
507}
508EXPORT_SYMBOL_GPL(__init_work);
509
510void destroy_work_on_stack(struct work_struct *work)
511{
512 debug_object_free(work, &work_debug_descr);
513}
514EXPORT_SYMBOL_GPL(destroy_work_on_stack);
515
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000516void destroy_delayed_work_on_stack(struct delayed_work *work)
517{
518 destroy_timer_on_stack(&work->timer);
519 debug_object_free(&work->work, &work_debug_descr);
520}
521EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
522
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900523#else
524static inline void debug_work_activate(struct work_struct *work) { }
525static inline void debug_work_deactivate(struct work_struct *work) { }
526#endif
527
Li Bin4e8b22b2013-09-10 09:52:35 +0800528/**
529 * worker_pool_assign_id - allocate ID and assing it to @pool
530 * @pool: the pool pointer of interest
531 *
532 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
533 * successfully, -errno on failure.
534 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800535static int worker_pool_assign_id(struct worker_pool *pool)
536{
537 int ret;
538
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700539 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700540
Li Bin4e8b22b2013-09-10 09:52:35 +0800541 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
542 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700543 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700544 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700545 return 0;
546 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800547 return ret;
548}
549
Tejun Heo76af4d92013-03-12 11:30:00 -0700550/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700551 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
552 * @wq: the target workqueue
553 * @node: the node ID
554 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800555 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
556 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700557 * If the pwq needs to be used beyond the locking in effect, the caller is
558 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700559 *
560 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700561 */
562static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563 int node)
564{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800565 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500566
567 /*
568 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
569 * delayed item is pending. The plan is to keep CPU -> NODE
570 * mapping valid and stable across CPU on/offlines. Once that
571 * happens, this workaround can be removed.
572 */
573 if (unlikely(node == NUMA_NO_NODE))
574 return wq->dfl_pwq;
575
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700576 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
577}
578
Tejun Heo73f53c42010-06-29 10:07:11 +0200579static unsigned int work_color_to_flags(int color)
580{
581 return color << WORK_STRUCT_COLOR_SHIFT;
582}
583
584static int get_work_color(struct work_struct *work)
585{
586 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
587 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
588}
589
590static int work_next_color(int color)
591{
592 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700593}
594
David Howells4594bf12006-12-07 11:33:26 +0000595/*
Tejun Heo112202d2013-02-13 19:29:12 -0800596 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
597 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800598 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 *
Tejun Heo112202d2013-02-13 19:29:12 -0800600 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
601 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700602 * work->data. These functions should only be called while the work is
603 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604 *
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800607 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700609 *
610 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
611 * canceled. While being canceled, a work item may have its PENDING set
612 * but stay off timer and worklist for arbitrarily long and nobody should
613 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000614 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200615static inline void set_work_data(struct work_struct *work, unsigned long data,
616 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000617{
Tejun Heo6183c002013-03-12 11:29:57 -0700618 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200619 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000620}
David Howells365970a2006-11-22 14:54:49 +0000621
Tejun Heo112202d2013-02-13 19:29:12 -0800622static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200623 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200624{
Tejun Heo112202d2013-02-13 19:29:12 -0800625 set_work_data(work, (unsigned long)pwq,
626 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200627}
628
Lai Jiangshan4468a002013-02-06 18:04:53 -0800629static void set_work_pool_and_keep_pending(struct work_struct *work,
630 int pool_id)
631{
632 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
633 WORK_STRUCT_PENDING);
634}
635
Tejun Heo7c3eed52013-01-24 11:01:33 -0800636static void set_work_pool_and_clear_pending(struct work_struct *work,
637 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000638{
Tejun Heo23657bb2012-08-13 17:08:19 -0700639 /*
640 * The following wmb is paired with the implied mb in
641 * test_and_set_bit(PENDING) and ensures all updates to @work made
642 * here are visible to and precede any updates by the next PENDING
643 * owner.
644 */
645 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800646 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200647 /*
648 * The following mb guarantees that previous clear of a PENDING bit
649 * will not be reordered with any speculative LOADS or STORES from
650 * work->current_func, which is executed afterwards. This possible
Liu Song8bdc6202019-02-19 23:53:27 +0800651 * reordering can lead to a missed execution on attempt to queue
Roman Pen346c09f2016-04-26 13:15:35 +0200652 * the same @work. E.g. consider this case:
653 *
654 * CPU#0 CPU#1
655 * ---------------------------- --------------------------------
656 *
657 * 1 STORE event_indicated
658 * 2 queue_work_on() {
659 * 3 test_and_set_bit(PENDING)
660 * 4 } set_..._and_clear_pending() {
661 * 5 set_work_data() # clear bit
662 * 6 smp_mb()
663 * 7 work->current_func() {
664 * 8 LOAD event_indicated
665 * }
666 *
667 * Without an explicit full barrier speculative LOAD on line 8 can
668 * be executed before CPU#0 does STORE on line 1. If that happens,
669 * CPU#0 observes the PENDING bit is still set and new execution of
670 * a @work is not queued in a hope, that CPU#1 will eventually
671 * finish the queued @work. Meanwhile CPU#1 does not see
672 * event_indicated is set, because speculative LOAD was executed
673 * before actual STORE.
674 */
675 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200676}
677
678static void clear_work_data(struct work_struct *work)
679{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800680 smp_wmb(); /* see set_work_pool_and_clear_pending() */
681 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200682}
683
Tejun Heo112202d2013-02-13 19:29:12 -0800684static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685{
Tejun Heoe1201532010-07-22 14:14:25 +0200686 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200687
Tejun Heo112202d2013-02-13 19:29:12 -0800688 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200689 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
690 else
691 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200692}
693
Tejun Heo7c3eed52013-01-24 11:01:33 -0800694/**
695 * get_work_pool - return the worker_pool a given work was associated with
696 * @work: the work item of interest
697 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700698 * Pools are created and destroyed under wq_pool_mutex, and allows read
699 * access under sched-RCU read lock. As such, this function should be
700 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700701 *
702 * All fields of the returned pool are accessible as long as the above
703 * mentioned locking is in effect. If the returned pool needs to be used
704 * beyond the critical section, the caller is responsible for ensuring the
705 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700706 *
707 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800708 */
709static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200710{
Tejun Heoe1201532010-07-22 14:14:25 +0200711 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800712 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200713
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700714 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700715
Tejun Heo112202d2013-02-13 19:29:12 -0800716 if (data & WORK_STRUCT_PWQ)
717 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800718 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200719
Tejun Heo7c3eed52013-01-24 11:01:33 -0800720 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
721 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200722 return NULL;
723
Tejun Heofa1b54e2013-03-12 11:30:00 -0700724 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800725}
726
727/**
728 * get_work_pool_id - return the worker pool ID a given work is associated with
729 * @work: the work item of interest
730 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700731 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800732 * %WORK_OFFQ_POOL_NONE if none.
733 */
734static int get_work_pool_id(struct work_struct *work)
735{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800736 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800737
Tejun Heo112202d2013-02-13 19:29:12 -0800738 if (data & WORK_STRUCT_PWQ)
739 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800740 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
741
742 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800743}
744
Tejun Heobbb68df2012-08-03 10:30:46 -0700745static void mark_work_canceling(struct work_struct *work)
746{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700748
Tejun Heo7c3eed52013-01-24 11:01:33 -0800749 pool_id <<= WORK_OFFQ_POOL_SHIFT;
750 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700751}
752
753static bool work_is_canceling(struct work_struct *work)
754{
755 unsigned long data = atomic_long_read(&work->data);
756
Tejun Heo112202d2013-02-13 19:29:12 -0800757 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700758}
759
David Howells365970a2006-11-22 14:54:49 +0000760/*
Tejun Heo32704762012-07-13 22:16:45 -0700761 * Policy functions. These define the policies on how the global worker
762 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800763 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000764 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200765
Tejun Heo63d95a92012-07-12 14:46:37 -0700766static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000767{
Tejun Heoe19e3972013-01-24 11:39:44 -0800768 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000769}
770
Tejun Heoe22bee72010-06-29 10:07:14 +0200771/*
772 * Need to wake up a worker? Called from anything but currently
773 * running workers.
Tejun Heo974271c42012-07-12 14:46:37 -0700774 *
775 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800776 * function will always return %true for unbound pools as long as the
Tejun Heo974271c42012-07-12 14:46:37 -0700777 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200778 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700779static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000780{
Tejun Heo63d95a92012-07-12 14:46:37 -0700781 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000782}
783
Tejun Heoe22bee72010-06-29 10:07:14 +0200784/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700785static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200786{
Tejun Heo63d95a92012-07-12 14:46:37 -0700787 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200788}
789
790/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700791static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200792{
Tejun Heoe19e3972013-01-24 11:39:44 -0800793 return !list_empty(&pool->worklist) &&
794 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200795}
796
797/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700798static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200799{
Tejun Heo63d95a92012-07-12 14:46:37 -0700800 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200801}
802
Tejun Heoe22bee72010-06-29 10:07:14 +0200803/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700804static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200805{
Tejun Heo692b4822017-10-09 08:04:13 -0700806 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700807 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
808 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200809
810 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
811}
812
813/*
814 * Wake up functions.
815 */
816
Lai Jiangshan1037de32014-05-22 16:44:07 +0800817/* Return the first idle worker. Safe with preemption disabled */
818static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200819{
Tejun Heo63d95a92012-07-12 14:46:37 -0700820 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200821 return NULL;
822
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200824}
825
826/**
827 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200831 *
832 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800833 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200834 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700835static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200836{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800837 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200838
839 if (likely(worker))
840 wake_up_process(worker->task);
841}
842
Tejun Heo4690c4a2010-06-29 10:07:10 +0200843/**
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
Bart Van Assche8194fe92019-03-19 10:45:09 -0700916 * @task: Task to retrieve last work function of.
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800917 *
918 * Determine the last function a worker executed. This is called from
919 * the scheduler to get a worker's last known identity.
920 *
921 * CONTEXT:
922 * spin_lock_irq(rq->lock)
923 *
Johannes Weiner4b047002019-03-07 16:29:30 -0800924 * This function is called during schedule() when a kworker is going
925 * to sleep. It's used by psi to identify aggregation workers during
926 * dequeuing, to allow periodic aggregation to shut-off when that
927 * worker is the last task in the system or cgroup to go to sleep.
928 *
929 * As this function doesn't involve any workqueue-related locking, it
930 * only returns stable values when called from inside the scheduler's
931 * queuing and dequeuing paths, when @task, which must be a kworker,
932 * is guaranteed to not be processing any works.
933 *
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800934 * Return:
935 * The last work function %current executed as a worker, NULL if it
936 * hasn't executed any work yet.
937 */
938work_func_t wq_worker_last_func(struct task_struct *task)
939{
940 struct worker *worker = kthread_data(task);
941
942 return worker->last_func;
943}
944
945/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200946 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200947 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200948 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200949 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800950 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200951 *
Tejun Heocb444762010-07-02 10:03:50 +0200952 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800953 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200954 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800955static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200956{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700957 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200958
Tejun Heocb444762010-07-02 10:03:50 +0200959 WARN_ON_ONCE(worker->task != current);
960
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800961 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200962 if ((flags & WORKER_NOT_RUNNING) &&
963 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800964 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200965 }
966
Tejun Heod302f012010-06-29 10:07:13 +0200967 worker->flags |= flags;
968}
969
970/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200971 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200972 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200973 * @flags: flags to clear
974 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200975 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200976 *
Tejun Heocb444762010-07-02 10:03:50 +0200977 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800978 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200979 */
980static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
981{
Tejun Heo63d95a92012-07-12 14:46:37 -0700982 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200983 unsigned int oflags = worker->flags;
984
Tejun Heocb444762010-07-02 10:03:50 +0200985 WARN_ON_ONCE(worker->task != current);
986
Tejun Heod302f012010-06-29 10:07:13 +0200987 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200988
Tejun Heo42c025f2011-01-11 15:58:49 +0100989 /*
990 * If transitioning out of NOT_RUNNING, increment nr_running. Note
991 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
992 * of multiple flags, not a single flag.
993 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200994 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
995 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800996 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200997}
998
999/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001000 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001001 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001002 * @work: work to find worker for
1003 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001004 * Find a worker which is executing @work on @pool by searching
1005 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -08001006 * to match, its current execution should match the address of @work and
1007 * its work function. This is to avoid unwanted dependency between
1008 * unrelated work executions through a work item being recycled while still
1009 * being executed.
1010 *
1011 * This is a bit tricky. A work item may be freed once its execution
1012 * starts and nothing prevents the freed area from being recycled for
1013 * another work item. If the same work item address ends up being reused
1014 * before the original execution finishes, workqueue will identify the
1015 * recycled work item as currently executing and make it wait until the
1016 * current execution finishes, introducing an unwanted dependency.
1017 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001018 * This function checks the work item address and work function to avoid
1019 * false positives. Note that this isn't complete as one may construct a
1020 * work function which can introduce dependency onto itself through a
1021 * recycled work item. Well, if somebody wants to shoot oneself in the
1022 * foot that badly, there's only so much we can do, and if such deadlock
1023 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001024 *
1025 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001026 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001027 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001028 * Return:
1029 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001030 * otherwise.
1031 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001032static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001033 struct work_struct *work)
1034{
Sasha Levin42f85702012-12-17 10:01:23 -05001035 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001036
Sasha Levinb67bfe02013-02-27 17:06:00 -08001037 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001038 (unsigned long)work)
1039 if (worker->current_work == work &&
1040 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001041 return worker;
1042
1043 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001044}
1045
1046/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001047 * move_linked_works - move linked works to a list
1048 * @work: start of series of works to be scheduled
1049 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301050 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001051 *
1052 * Schedule linked works starting from @work to @head. Work series to
1053 * be scheduled starts at @work and includes any consecutive work with
1054 * WORK_STRUCT_LINKED set in its predecessor.
1055 *
1056 * If @nextp is not NULL, it's updated to point to the next work of
1057 * the last scheduled work. This allows move_linked_works() to be
1058 * nested inside outer list_for_each_entry_safe().
1059 *
1060 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001061 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001062 */
1063static void move_linked_works(struct work_struct *work, struct list_head *head,
1064 struct work_struct **nextp)
1065{
1066 struct work_struct *n;
1067
1068 /*
1069 * Linked worklist will always end before the end of the list,
1070 * use NULL for list head.
1071 */
1072 list_for_each_entry_safe_from(work, n, NULL, entry) {
1073 list_move_tail(&work->entry, head);
1074 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1075 break;
1076 }
1077
1078 /*
1079 * If we're already inside safe list traversal and have moved
1080 * multiple works to the scheduled queue, the next position
1081 * needs to be updated.
1082 */
1083 if (nextp)
1084 *nextp = n;
1085}
1086
Tejun Heo8864b4e2013-03-12 11:30:04 -07001087/**
1088 * get_pwq - get an extra reference on the specified pool_workqueue
1089 * @pwq: pool_workqueue to get
1090 *
1091 * Obtain an extra reference on @pwq. The caller should guarantee that
1092 * @pwq has positive refcnt and be holding the matching pool->lock.
1093 */
1094static void get_pwq(struct pool_workqueue *pwq)
1095{
1096 lockdep_assert_held(&pwq->pool->lock);
1097 WARN_ON_ONCE(pwq->refcnt <= 0);
1098 pwq->refcnt++;
1099}
1100
1101/**
1102 * put_pwq - put a pool_workqueue reference
1103 * @pwq: pool_workqueue to put
1104 *
1105 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1106 * destruction. The caller should be holding the matching pool->lock.
1107 */
1108static void put_pwq(struct pool_workqueue *pwq)
1109{
1110 lockdep_assert_held(&pwq->pool->lock);
1111 if (likely(--pwq->refcnt))
1112 return;
1113 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1114 return;
1115 /*
1116 * @pwq can't be released under pool->lock, bounce to
1117 * pwq_unbound_release_workfn(). This never recurses on the same
1118 * pool->lock as this path is taken only for unbound workqueues and
1119 * the release work item is scheduled on a per-cpu workqueue. To
1120 * avoid lockdep warning, unbound pool->locks are given lockdep
1121 * subclass of 1 in get_unbound_pool().
1122 */
1123 schedule_work(&pwq->unbound_release_work);
1124}
1125
Tejun Heodce90d42013-04-01 11:23:35 -07001126/**
1127 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1128 * @pwq: pool_workqueue to put (can be %NULL)
1129 *
1130 * put_pwq() with locking. This function also allows %NULL @pwq.
1131 */
1132static void put_pwq_unlocked(struct pool_workqueue *pwq)
1133{
1134 if (pwq) {
1135 /*
1136 * As both pwqs and pools are sched-RCU protected, the
1137 * following lock operations are safe.
1138 */
1139 spin_lock_irq(&pwq->pool->lock);
1140 put_pwq(pwq);
1141 spin_unlock_irq(&pwq->pool->lock);
1142 }
1143}
1144
Tejun Heo112202d2013-02-13 19:29:12 -08001145static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001146{
Tejun Heo112202d2013-02-13 19:29:12 -08001147 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001148
1149 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001150 if (list_empty(&pwq->pool->worklist))
1151 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001152 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001153 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001154 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001155}
1156
Tejun Heo112202d2013-02-13 19:29:12 -08001157static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001158{
Tejun Heo112202d2013-02-13 19:29:12 -08001159 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001160 struct work_struct, entry);
1161
Tejun Heo112202d2013-02-13 19:29:12 -08001162 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001163}
1164
Tejun Heobf4ede02012-08-03 10:30:46 -07001165/**
Tejun Heo112202d2013-02-13 19:29:12 -08001166 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1167 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001168 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001169 *
1170 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001171 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001172 *
1173 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001174 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001175 */
Tejun Heo112202d2013-02-13 19:29:12 -08001176static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001177{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001178 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001179 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001180 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001181
Tejun Heo112202d2013-02-13 19:29:12 -08001182 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001183
Tejun Heo112202d2013-02-13 19:29:12 -08001184 pwq->nr_active--;
1185 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001186 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001187 if (pwq->nr_active < pwq->max_active)
1188 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001189 }
1190
1191 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001192 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001193 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001194
1195 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001196 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001197 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001198
Tejun Heo112202d2013-02-13 19:29:12 -08001199 /* this pwq is done, clear flush_color */
1200 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001201
1202 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001203 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001204 * will handle the rest.
1205 */
Tejun Heo112202d2013-02-13 19:29:12 -08001206 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1207 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001208out_put:
1209 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001210}
1211
Tejun Heo36e227d2012-08-03 10:30:46 -07001212/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001213 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 * @work: work item to steal
1215 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001216 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001217 *
1218 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001219 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001220 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001221 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001222 * 1 if @work was pending and we successfully stole PENDING
1223 * 0 if @work was idle and we claimed PENDING
1224 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001225 * -ENOENT if someone else is canceling @work, this state may persist
1226 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001227 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001228 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001229 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001230 * interrupted while holding PENDING and @work off queue, irq must be
1231 * disabled on entry. This, combined with delayed_work->timer being
1232 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001233 *
1234 * On successful return, >= 0, irq is disabled and the caller is
1235 * responsible for releasing it using local_irq_restore(*@flags).
1236 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001237 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001238 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001239static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1240 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001241{
Tejun Heod565ed62013-01-24 11:01:33 -08001242 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001243 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001244
Tejun Heobbb68df2012-08-03 10:30:46 -07001245 local_irq_save(*flags);
1246
Tejun Heo36e227d2012-08-03 10:30:46 -07001247 /* try to steal the timer if it exists */
1248 if (is_dwork) {
1249 struct delayed_work *dwork = to_delayed_work(work);
1250
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001251 /*
1252 * dwork->timer is irqsafe. If del_timer() fails, it's
1253 * guaranteed that the timer is not queued anywhere and not
1254 * running on the local CPU.
1255 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001256 if (likely(del_timer(&dwork->timer)))
1257 return 1;
1258 }
1259
1260 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001261 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1262 return 0;
1263
1264 /*
1265 * The queueing is in progress, or it is already queued. Try to
1266 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1267 */
Tejun Heod565ed62013-01-24 11:01:33 -08001268 pool = get_work_pool(work);
1269 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001270 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001271
Tejun Heod565ed62013-01-24 11:01:33 -08001272 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001273 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001274 * work->data is guaranteed to point to pwq only while the work
1275 * item is queued on pwq->wq, and both updating work->data to point
1276 * to pwq on queueing and to pool on dequeueing are done under
1277 * pwq->pool->lock. This in turn guarantees that, if work->data
1278 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001279 * item is currently queued on that pool.
1280 */
Tejun Heo112202d2013-02-13 19:29:12 -08001281 pwq = get_work_pwq(work);
1282 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001283 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001284
Tejun Heo16062832013-02-06 18:04:53 -08001285 /*
1286 * A delayed work item cannot be grabbed directly because
1287 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001288 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001289 * management later on and cause stall. Make sure the work
1290 * item is activated before grabbing.
1291 */
1292 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001293 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001294
Tejun Heo16062832013-02-06 18:04:53 -08001295 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001296 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001297
Tejun Heo112202d2013-02-13 19:29:12 -08001298 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001299 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001300
Tejun Heo16062832013-02-06 18:04:53 -08001301 spin_unlock(&pool->lock);
1302 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001303 }
Tejun Heod565ed62013-01-24 11:01:33 -08001304 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001305fail:
1306 local_irq_restore(*flags);
1307 if (work_is_canceling(work))
1308 return -ENOENT;
1309 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001310 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001311}
1312
1313/**
Tejun Heo706026c2013-01-24 11:01:34 -08001314 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001315 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001316 * @work: work to insert
1317 * @head: insertion point
1318 * @extra_flags: extra WORK_STRUCT_* flags to set
1319 *
Tejun Heo112202d2013-02-13 19:29:12 -08001320 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001321 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001322 *
1323 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001324 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001325 */
Tejun Heo112202d2013-02-13 19:29:12 -08001326static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1327 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001328{
Tejun Heo112202d2013-02-13 19:29:12 -08001329 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001330
Tejun Heo4690c4a2010-06-29 10:07:10 +02001331 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001332 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001333 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001334 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001335
1336 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001337 * Ensure either wq_worker_sleeping() sees the above
1338 * list_add_tail() or we see zero nr_running to avoid workers lying
1339 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001340 */
1341 smp_mb();
1342
Tejun Heo63d95a92012-07-12 14:46:37 -07001343 if (__need_more_worker(pool))
1344 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001345}
1346
Tejun Heoc8efcc22010-12-20 19:32:04 +01001347/*
1348 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001349 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001350 */
1351static bool is_chained_work(struct workqueue_struct *wq)
1352{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001353 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001354
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001355 worker = current_wq_worker();
1356 /*
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001357 * Return %true iff I'm a worker executing a work item on @wq. If
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001358 * I'm @worker, it's safe to dereference it without locking.
1359 */
Tejun Heo112202d2013-02-13 19:29:12 -08001360 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001361}
1362
Mike Galbraithef5571802016-02-09 17:59:38 -05001363/*
1364 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1365 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1366 * avoid perturbing sensitive tasks.
1367 */
1368static int wq_select_unbound_cpu(int cpu)
1369{
Tejun Heof303fccb2016-02-09 17:59:38 -05001370 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001371 int new_cpu;
1372
Tejun Heof303fccb2016-02-09 17:59:38 -05001373 if (likely(!wq_debug_force_rr_cpu)) {
1374 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1375 return cpu;
1376 } else if (!printed_dbg_warning) {
1377 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1378 printed_dbg_warning = true;
1379 }
1380
Mike Galbraithef5571802016-02-09 17:59:38 -05001381 if (cpumask_empty(wq_unbound_cpumask))
1382 return cpu;
1383
1384 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1385 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1386 if (unlikely(new_cpu >= nr_cpu_ids)) {
1387 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1388 if (unlikely(new_cpu >= nr_cpu_ids))
1389 return cpu;
1390 }
1391 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1392
1393 return new_cpu;
1394}
1395
Tejun Heod84ff052013-03-12 11:29:59 -07001396static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 struct work_struct *work)
1398{
Tejun Heo112202d2013-02-13 19:29:12 -08001399 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001400 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001401 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001402 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001403 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001404
1405 /*
1406 * While a work item is PENDING && off queue, a task trying to
1407 * steal the PENDING will busy-loop waiting for it to either get
1408 * queued or lose PENDING. Grabbing PENDING and queueing should
1409 * happen with IRQ disabled.
1410 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001411 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001413 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001414
Li Bin9ef28a72013-09-09 13:13:58 +08001415 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001416 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001417 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001418 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001419retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001420 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001421 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001422
Tejun Heoc9178082013-03-12 11:30:04 -07001423 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001424 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001425 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001426 else
1427 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001428
Tejun Heoc9178082013-03-12 11:30:04 -07001429 /*
1430 * If @work was previously on a different pool, it might still be
1431 * running there, in which case the work needs to be queued on that
1432 * pool to guarantee non-reentrancy.
1433 */
1434 last_pool = get_work_pool(work);
1435 if (last_pool && last_pool != pwq->pool) {
1436 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001437
Tejun Heoc9178082013-03-12 11:30:04 -07001438 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001439
Tejun Heoc9178082013-03-12 11:30:04 -07001440 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001441
Tejun Heoc9178082013-03-12 11:30:04 -07001442 if (worker && worker->current_pwq->wq == wq) {
1443 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001444 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001445 /* meh... not running there, queue here */
1446 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001447 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001448 }
Tejun Heof3421792010-07-02 10:03:51 +02001449 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001450 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001451 }
1452
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001453 /*
1454 * pwq is determined and locked. For unbound pools, we could have
1455 * raced with pwq release and it could already be dead. If its
1456 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001457 * without another pwq replacing it in the numa_pwq_tbl or while
1458 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001459 * make forward-progress.
1460 */
1461 if (unlikely(!pwq->refcnt)) {
1462 if (wq->flags & WQ_UNBOUND) {
1463 spin_unlock(&pwq->pool->lock);
1464 cpu_relax();
1465 goto retry;
1466 }
1467 /* oops */
1468 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1469 wq->name, cpu);
1470 }
1471
Tejun Heo112202d2013-02-13 19:29:12 -08001472 /* pwq determined, queue */
1473 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001474
Dan Carpenterf5b25522012-04-13 22:06:58 +03001475 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001476 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001477 return;
1478 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001479
Tejun Heo112202d2013-02-13 19:29:12 -08001480 pwq->nr_in_flight[pwq->work_color]++;
1481 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001482
Tejun Heo112202d2013-02-13 19:29:12 -08001483 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001484 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001485 pwq->nr_active++;
1486 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001487 if (list_empty(worklist))
1488 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001489 } else {
1490 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001491 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001492 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001493
Tejun Heo112202d2013-02-13 19:29:12 -08001494 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001495
Tejun Heo112202d2013-02-13 19:29:12 -08001496 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497}
1498
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001499/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001500 * queue_work_on - queue work on specific cpu
1501 * @cpu: CPU number to execute work on
1502 * @wq: workqueue to use
1503 * @work: work to queue
1504 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001505 * We queue the work to a specific CPU, the caller must ensure it
1506 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001507 *
1508 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001509 */
Tejun Heod4283e92012-08-03 10:30:44 -07001510bool queue_work_on(int cpu, struct workqueue_struct *wq,
1511 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001512{
Tejun Heod4283e92012-08-03 10:30:44 -07001513 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001514 unsigned long flags;
1515
1516 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001517
Tejun Heo22df02b2010-06-29 10:07:10 +02001518 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001519 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001520 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001521 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001522
1523 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001524 return ret;
1525}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001526EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001527
Alexander Duyck8204e0c2019-01-22 10:39:26 -08001528/**
1529 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1530 * @node: NUMA node ID that we want to select a CPU from
1531 *
1532 * This function will attempt to find a "random" cpu available on a given
1533 * node. If there are no CPUs available on the given node it will return
1534 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1535 * available CPU if we need to schedule this work.
1536 */
1537static int workqueue_select_cpu_near(int node)
1538{
1539 int cpu;
1540
1541 /* No point in doing this if NUMA isn't enabled for workqueues */
1542 if (!wq_numa_enabled)
1543 return WORK_CPU_UNBOUND;
1544
1545 /* Delay binding to CPU if node is not valid or online */
1546 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1547 return WORK_CPU_UNBOUND;
1548
1549 /* Use local node/cpu if we are already there */
1550 cpu = raw_smp_processor_id();
1551 if (node == cpu_to_node(cpu))
1552 return cpu;
1553
1554 /* Use "random" otherwise know as "first" online CPU of node */
1555 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1556
1557 /* If CPU is valid return that, otherwise just defer */
1558 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1559}
1560
1561/**
1562 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1563 * @node: NUMA node that we are targeting the work for
1564 * @wq: workqueue to use
1565 * @work: work to queue
1566 *
1567 * We queue the work to a "random" CPU within a given NUMA node. The basic
1568 * idea here is to provide a way to somehow associate work with a given
1569 * NUMA node.
1570 *
1571 * This function will only make a best effort attempt at getting this onto
1572 * the right NUMA node. If no node is requested or the requested node is
1573 * offline then we just fall back to standard queue_work behavior.
1574 *
1575 * Currently the "random" CPU ends up being the first available CPU in the
1576 * intersection of cpu_online_mask and the cpumask of the node, unless we
1577 * are running on the node. In that case we just use the current CPU.
1578 *
1579 * Return: %false if @work was already on a queue, %true otherwise.
1580 */
1581bool queue_work_node(int node, struct workqueue_struct *wq,
1582 struct work_struct *work)
1583{
1584 unsigned long flags;
1585 bool ret = false;
1586
1587 /*
1588 * This current implementation is specific to unbound workqueues.
1589 * Specifically we only return the first available CPU for a given
1590 * node instead of cycling through individual CPUs within the node.
1591 *
1592 * If this is used with a per-cpu workqueue then the logic in
1593 * workqueue_select_cpu_near would need to be updated to allow for
1594 * some round robin type logic.
1595 */
1596 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1597
1598 local_irq_save(flags);
1599
1600 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1601 int cpu = workqueue_select_cpu_near(node);
1602
1603 __queue_work(cpu, wq, work);
1604 ret = true;
1605 }
1606
1607 local_irq_restore(flags);
1608 return ret;
1609}
1610EXPORT_SYMBOL_GPL(queue_work_node);
1611
Kees Cook8c20feb2017-10-04 16:27:07 -07001612void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613{
Kees Cook8c20feb2017-10-04 16:27:07 -07001614 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001616 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001617 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001619EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001621static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1622 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001624 struct timer_list *timer = &dwork->timer;
1625 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Tejun Heo637fdba2017-03-06 15:33:42 -05001627 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001628 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001629 WARN_ON_ONCE(timer_pending(timer));
1630 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001631
Tejun Heo8852aac2012-12-01 16:23:42 -08001632 /*
1633 * If @delay is 0, queue @dwork->work immediately. This is for
1634 * both optimization and correctness. The earliest @timer can
1635 * expire is on the closest next tick and delayed_work users depend
1636 * on that there's no such delay when @delay is 0.
1637 */
1638 if (!delay) {
1639 __queue_work(cpu, wq, &dwork->work);
1640 return;
1641 }
1642
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001643 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001644 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001645 timer->expires = jiffies + delay;
1646
Tejun Heo041bd122016-02-09 16:11:26 -05001647 if (unlikely(cpu != WORK_CPU_UNBOUND))
1648 add_timer_on(timer, cpu);
1649 else
1650 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651}
1652
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001653/**
1654 * queue_delayed_work_on - queue work on specific CPU after delay
1655 * @cpu: CPU number to execute work on
1656 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001657 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001658 * @delay: number of jiffies to wait before queueing
1659 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001660 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001661 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1662 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001663 */
Tejun Heod4283e92012-08-03 10:30:44 -07001664bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1665 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001666{
David Howells52bad642006-11-22 14:54:01 +00001667 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001668 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001669 unsigned long flags;
1670
1671 /* read the comment in __queue_work() */
1672 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001673
Tejun Heo22df02b2010-06-29 10:07:10 +02001674 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001675 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001676 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001677 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001678
1679 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001680 return ret;
1681}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001682EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683
Tejun Heoc8e55f32010-06-29 10:07:12 +02001684/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001685 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1686 * @cpu: CPU number to execute work on
1687 * @wq: workqueue to use
1688 * @dwork: work to queue
1689 * @delay: number of jiffies to wait before queueing
1690 *
1691 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1692 * modify @dwork's timer so that it expires after @delay. If @delay is
1693 * zero, @work is guaranteed to be scheduled immediately regardless of its
1694 * current state.
1695 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001696 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001697 * pending and its timer was modified.
1698 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001699 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001700 * See try_to_grab_pending() for details.
1701 */
1702bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1703 struct delayed_work *dwork, unsigned long delay)
1704{
1705 unsigned long flags;
1706 int ret;
1707
1708 do {
1709 ret = try_to_grab_pending(&dwork->work, true, &flags);
1710 } while (unlikely(ret == -EAGAIN));
1711
1712 if (likely(ret >= 0)) {
1713 __queue_delayed_work(cpu, wq, dwork, delay);
1714 local_irq_restore(flags);
1715 }
1716
1717 /* -ENOENT from try_to_grab_pending() becomes %true */
1718 return ret;
1719}
1720EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1721
Tejun Heo05f0fe62018-03-14 12:45:13 -07001722static void rcu_work_rcufn(struct rcu_head *rcu)
1723{
1724 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1725
1726 /* read the comment in __queue_work() */
1727 local_irq_disable();
1728 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1729 local_irq_enable();
1730}
1731
1732/**
1733 * queue_rcu_work - queue work after a RCU grace period
1734 * @wq: workqueue to use
1735 * @rwork: work to queue
1736 *
1737 * Return: %false if @rwork was already pending, %true otherwise. Note
1738 * that a full RCU grace period is guaranteed only after a %true return.
Bart Van Asschebf393fd2019-03-01 13:57:25 -08001739 * While @rwork is guaranteed to be executed after a %false return, the
Tejun Heo05f0fe62018-03-14 12:45:13 -07001740 * execution may happen before a full RCU grace period has passed.
1741 */
1742bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1743{
1744 struct work_struct *work = &rwork->work;
1745
1746 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1747 rwork->wq = wq;
1748 call_rcu(&rwork->rcu, rcu_work_rcufn);
1749 return true;
1750 }
1751
1752 return false;
1753}
1754EXPORT_SYMBOL(queue_rcu_work);
1755
Tejun Heo8376fe22012-08-03 10:30:47 -07001756/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001757 * worker_enter_idle - enter idle state
1758 * @worker: worker which is entering idle state
1759 *
1760 * @worker is entering idle state. Update stats and idle timer if
1761 * necessary.
1762 *
1763 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001764 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001765 */
1766static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001768 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Tejun Heo6183c002013-03-12 11:29:57 -07001770 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1771 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1772 (worker->hentry.next || worker->hentry.pprev)))
1773 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Lai Jiangshan051e1852014-07-22 13:03:02 +08001775 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001776 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001777 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001778 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001779
Tejun Heoc8e55f32010-06-29 10:07:12 +02001780 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001781 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001782
Tejun Heo628c78e2012-07-17 12:39:27 -07001783 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1784 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001785
Tejun Heo544ecf32012-05-14 15:04:50 -07001786 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001787 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001788 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001789 * nr_running, the warning may trigger spuriously. Check iff
1790 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001791 */
Tejun Heo24647572013-01-24 11:01:33 -08001792 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001793 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001794 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795}
1796
Tejun Heoc8e55f32010-06-29 10:07:12 +02001797/**
1798 * worker_leave_idle - leave idle state
1799 * @worker: worker which is leaving idle state
1800 *
1801 * @worker is leaving idle state. Update stats.
1802 *
1803 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001804 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001805 */
1806static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001808 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
Tejun Heo6183c002013-03-12 11:29:57 -07001810 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1811 return;
Tejun Heod302f012010-06-29 10:07:13 +02001812 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001813 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001814 list_del_init(&worker->entry);
1815}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001817static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001818{
1819 struct worker *worker;
1820
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001821 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001822 if (worker) {
1823 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001824 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001825 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001826 /* on creation a worker is in !idle && prep state */
1827 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001828 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001829 return worker;
1830}
1831
1832/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001833 * worker_attach_to_pool() - attach a worker to a pool
1834 * @worker: worker to be attached
1835 * @pool: the target pool
1836 *
1837 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1838 * cpu-binding of @worker are kept coordinated with the pool across
1839 * cpu-[un]hotplugs.
1840 */
1841static void worker_attach_to_pool(struct worker *worker,
1842 struct worker_pool *pool)
1843{
Tejun Heo1258fae2018-05-18 08:47:13 -07001844 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001845
1846 /*
1847 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1848 * online CPUs. It'll be re-applied when any of the CPUs come up.
1849 */
1850 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1851
1852 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001853 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1854 * stable across this function. See the comments above the flag
1855 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001856 */
1857 if (pool->flags & POOL_DISASSOCIATED)
1858 worker->flags |= WORKER_UNBOUND;
1859
1860 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001861 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001862
Tejun Heo1258fae2018-05-18 08:47:13 -07001863 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001864}
1865
1866/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001867 * worker_detach_from_pool() - detach a worker from its pool
1868 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001869 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001870 * Undo the attaching which had been done in worker_attach_to_pool(). The
1871 * caller worker shouldn't access to the pool after detached except it has
1872 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001873 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001874static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001875{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001876 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001877 struct completion *detach_completion = NULL;
1878
Tejun Heo1258fae2018-05-18 08:47:13 -07001879 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001880
Lai Jiangshanda028462014-05-20 17:46:31 +08001881 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001882 worker->pool = NULL;
1883
Lai Jiangshanda028462014-05-20 17:46:31 +08001884 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001885 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001886 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001887
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001888 /* clear leftover flags without pool->lock after it is detached */
1889 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1890
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001891 if (detach_completion)
1892 complete(detach_completion);
1893}
1894
1895/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001896 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001897 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001898 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001899 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001900 *
1901 * CONTEXT:
1902 * Might sleep. Does GFP_KERNEL allocations.
1903 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001904 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001905 * Pointer to the newly created worker.
1906 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001907static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001908{
Tejun Heoc34056a2010-06-29 10:07:11 +02001909 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001910 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001911 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001912
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001913 /* ID is needed to determine kthread name */
1914 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001915 if (id < 0)
1916 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001917
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001918 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001919 if (!worker)
1920 goto fail;
1921
Tejun Heoc34056a2010-06-29 10:07:11 +02001922 worker->id = id;
1923
Tejun Heo29c91e92013-03-12 11:30:03 -07001924 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001925 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1926 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001927 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001928 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1929
Tejun Heof3f90ad2013-04-01 11:23:34 -07001930 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001931 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001932 if (IS_ERR(worker->task))
1933 goto fail;
1934
Oleg Nesterov91151222013-11-14 12:56:18 +01001935 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001936 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001937
Lai Jiangshanda028462014-05-20 17:46:31 +08001938 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001939 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001940
Lai Jiangshan051e1852014-07-22 13:03:02 +08001941 /* start the newly created worker */
1942 spin_lock_irq(&pool->lock);
1943 worker->pool->nr_workers++;
1944 worker_enter_idle(worker);
1945 wake_up_process(worker->task);
1946 spin_unlock_irq(&pool->lock);
1947
Tejun Heoc34056a2010-06-29 10:07:11 +02001948 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001949
Tejun Heoc34056a2010-06-29 10:07:11 +02001950fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001951 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001952 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001953 kfree(worker);
1954 return NULL;
1955}
1956
1957/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001958 * destroy_worker - destroy a workqueue worker
1959 * @worker: worker to be destroyed
1960 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001961 * Destroy @worker and adjust @pool stats accordingly. The worker should
1962 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001963 *
1964 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001965 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001966 */
1967static void destroy_worker(struct worker *worker)
1968{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001969 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001970
Tejun Heocd549682013-03-13 19:47:39 -07001971 lockdep_assert_held(&pool->lock);
1972
Tejun Heoc34056a2010-06-29 10:07:11 +02001973 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001974 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001975 WARN_ON(!list_empty(&worker->scheduled)) ||
1976 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001977 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001978
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001979 pool->nr_workers--;
1980 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001981
Tejun Heoc8e55f32010-06-29 10:07:12 +02001982 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001983 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001984 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001985}
1986
Kees Cook32a6c722017-10-16 15:58:25 -07001987static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001988{
Kees Cook32a6c722017-10-16 15:58:25 -07001989 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001990
Tejun Heod565ed62013-01-24 11:01:33 -08001991 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001992
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001993 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001994 struct worker *worker;
1995 unsigned long expires;
1996
1997 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001998 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2000
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002001 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002002 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002003 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08002005
2006 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 }
2008
Tejun Heod565ed62013-01-24 11:01:33 -08002009 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002010}
2011
Tejun Heo493a1722013-03-12 11:29:59 -07002012static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02002013{
Tejun Heo112202d2013-02-13 19:29:12 -08002014 struct pool_workqueue *pwq = get_work_pwq(work);
2015 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07002016
Tejun Heo2e109a22013-03-13 19:47:40 -07002017 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002018
Tejun Heo493008a2013-03-12 11:30:03 -07002019 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07002020 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02002021
2022 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07002023 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04002024 /*
2025 * If @pwq is for an unbound wq, its base ref may be put at
2026 * any time due to an attribute change. Pin @pwq until the
2027 * rescuer is done with it.
2028 */
2029 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07002030 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02002031 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07002032 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002033}
2034
Kees Cook32a6c722017-10-16 15:58:25 -07002035static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02002036{
Kees Cook32a6c722017-10-16 15:58:25 -07002037 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002038 struct work_struct *work;
2039
Tejun Heob2d82902014-12-08 12:39:16 -05002040 spin_lock_irq(&pool->lock);
2041 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02002042
Tejun Heo63d95a92012-07-12 14:46:37 -07002043 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002044 /*
2045 * We've been trying to create a new worker but
2046 * haven't been successful. We might be hitting an
2047 * allocation deadlock. Send distress signals to
2048 * rescuers.
2049 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002050 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002051 send_mayday(work);
2052 }
2053
Tejun Heob2d82902014-12-08 12:39:16 -05002054 spin_unlock(&wq_mayday_lock);
2055 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002056
Tejun Heo63d95a92012-07-12 14:46:37 -07002057 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02002058}
2059
2060/**
2061 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07002062 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02002063 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002064 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02002065 * have at least one idle worker on return from this function. If
2066 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07002067 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02002068 * possible allocation deadlock.
2069 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002070 * On return, need_to_create_worker() is guaranteed to be %false and
2071 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002072 *
2073 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08002074 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002075 * multiple times. Does GFP_KERNEL allocations. Called only from
2076 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02002077 */
Tejun Heo29187a92015-01-16 14:21:16 -05002078static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08002079__releases(&pool->lock)
2080__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02002081{
Tejun Heoe22bee72010-06-29 10:07:14 +02002082restart:
Tejun Heod565ed62013-01-24 11:01:33 -08002083 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002084
Tejun Heoe22bee72010-06-29 10:07:14 +02002085 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002086 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002087
2088 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08002089 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002090 break;
2091
Lai Jiangshane212f362014-06-03 15:32:17 +08002092 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002093
Tejun Heo63d95a92012-07-12 14:46:37 -07002094 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002095 break;
2096 }
2097
Tejun Heo63d95a92012-07-12 14:46:37 -07002098 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08002099 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002100 /*
2101 * This is necessary even after a new worker was just successfully
2102 * created as @pool->lock was dropped and the new worker might have
2103 * already become busy.
2104 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002105 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002106 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002107}
2108
2109/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002110 * manage_workers - manage worker pool
2111 * @worker: self
2112 *
Tejun Heo706026c2013-01-24 11:01:34 -08002113 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002114 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002115 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002116 *
2117 * The caller can safely start processing works on false return. On
2118 * true return, it's guaranteed that need_to_create_worker() is false
2119 * and may_start_working() is true.
2120 *
2121 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002122 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002123 * multiple times. Does GFP_KERNEL allocations.
2124 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002125 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002126 * %false if the pool doesn't need management and the caller can safely
2127 * start processing works, %true if management function was performed and
2128 * the conditions that the caller verified before calling the function may
2129 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002130 */
2131static bool manage_workers(struct worker *worker)
2132{
Tejun Heo63d95a92012-07-12 14:46:37 -07002133 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002134
Tejun Heo692b4822017-10-09 08:04:13 -07002135 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002136 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002137
2138 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002139 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002140
Tejun Heo29187a92015-01-16 14:21:16 -05002141 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002142
Tejun Heo2607d7a2015-03-09 09:22:28 -04002143 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002144 pool->flags &= ~POOL_MANAGER_ACTIVE;
2145 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002146 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002147}
2148
Tejun Heoa62428c2010-06-29 10:07:10 +02002149/**
2150 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002151 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002152 * @work: work to process
2153 *
2154 * Process @work. This function contains all the logics necessary to
2155 * process a single work including synchronization against and
2156 * interaction with other workers on the same cpu, queueing and
2157 * flushing. As long as context requirement is met, any worker can
2158 * call this function to process a work.
2159 *
2160 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002161 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002162 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002163static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002164__releases(&pool->lock)
2165__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002166{
Tejun Heo112202d2013-02-13 19:29:12 -08002167 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002168 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002169 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002170 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002171 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002172#ifdef CONFIG_LOCKDEP
2173 /*
2174 * It is permissible to free the struct work_struct from
2175 * inside the function that is called from it, this we need to
2176 * take into account for lockdep too. To avoid bogus "held
2177 * lock freed" warnings as well as problems when looking into
2178 * work->lockdep_map, make a copy and use that here.
2179 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002180 struct lockdep_map lockdep_map;
2181
2182 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002183#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002184 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002185 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002186 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002187
Tejun Heo7e116292010-06-29 10:07:13 +02002188 /*
2189 * A single work shouldn't be executed concurrently by
2190 * multiple workers on a single cpu. Check whether anyone is
2191 * already processing the work. If so, defer the work to the
2192 * currently executing one.
2193 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002194 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002195 if (unlikely(collision)) {
2196 move_linked_works(work, &collision->scheduled, NULL);
2197 return;
2198 }
2199
Tejun Heo8930cab2012-08-03 10:30:45 -07002200 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002201 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002202 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002203 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002204 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002205 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002206 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002207
Tejun Heo8bf89592018-05-18 08:47:13 -07002208 /*
2209 * Record wq name for cmdline and debug reporting, may get
2210 * overridden through set_worker_desc().
2211 */
2212 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2213
Tejun Heoa62428c2010-06-29 10:07:10 +02002214 list_del_init(&work->entry);
2215
Tejun Heo649027d2010-06-29 10:07:14 +02002216 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002217 * CPU intensive works don't participate in concurrency management.
2218 * They're the scheduler's responsibility. This takes @worker out
2219 * of concurrency management and the next code block will chain
2220 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002221 */
2222 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002223 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002224
Tejun Heo974271c42012-07-12 14:46:37 -07002225 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002226 * Wake up another worker if necessary. The condition is always
2227 * false for normal per-cpu workers since nr_running would always
2228 * be >= 1 at this point. This is used to chain execution of the
2229 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002230 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002231 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002232 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002233 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002234
Tejun Heo8930cab2012-08-03 10:30:45 -07002235 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002236 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002237 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002238 * PENDING and queued state changes happen together while IRQ is
2239 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002240 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002241 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002242
Tejun Heod565ed62013-01-24 11:01:33 -08002243 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002244
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002245 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002246 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002247 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002248 * Strictly speaking we should mark the invariant state without holding
2249 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002250 *
2251 * However, that would result in:
2252 *
2253 * A(W1)
2254 * WFC(C)
2255 * A(W1)
2256 * C(C)
2257 *
2258 * Which would create W1->C->W1 dependencies, even though there is no
2259 * actual deadlock possible. There are two solutions, using a
2260 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002261 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002262 * these locks.
2263 *
2264 * AFAICT there is no possible deadlock scenario between the
2265 * flush_work() and complete() primitives (except for single-threaded
2266 * workqueues), so hiding them isn't a problem.
2267 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002268 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002269 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002270 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002271 /*
2272 * While we must be careful to not use "work" after this, the trace
2273 * point will only record its address.
2274 */
2275 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002276 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002277 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002278
2279 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002280 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2281 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002282 current->comm, preempt_count(), task_pid_nr(current),
2283 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002284 debug_show_held_locks(current);
2285 dump_stack();
2286 }
2287
Tejun Heob22ce272013-08-28 17:33:37 -04002288 /*
2289 * The following prevents a kworker from hogging CPU on !PREEMPT
2290 * kernels, where a requeueing work item waiting for something to
2291 * happen could deadlock with stop_machine as such work item could
2292 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002293 * stop_machine. At the same time, report a quiescent RCU state so
2294 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002295 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002296 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002297
Tejun Heod565ed62013-01-24 11:01:33 -08002298 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002299
Tejun Heofb0e7be2010-06-29 10:07:15 +02002300 /* clear cpu intensive status */
2301 if (unlikely(cpu_intensive))
2302 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2303
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002304 /* tag the worker for identification in schedule() */
2305 worker->last_func = worker->current_func;
2306
Tejun Heoa62428c2010-06-29 10:07:10 +02002307 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002308 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002309 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002310 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002311 worker->current_pwq = NULL;
2312 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002313}
2314
Tejun Heoaffee4b2010-06-29 10:07:12 +02002315/**
2316 * process_scheduled_works - process scheduled works
2317 * @worker: self
2318 *
2319 * Process all scheduled works. Please note that the scheduled list
2320 * may change while processing a work, so this function repeatedly
2321 * fetches a work from the top and executes it.
2322 *
2323 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002324 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002325 * multiple times.
2326 */
2327static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002329 while (!list_empty(&worker->scheduled)) {
2330 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002332 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334}
2335
Tejun Heo197f6ac2018-05-21 08:04:35 -07002336static void set_pf_worker(bool val)
2337{
2338 mutex_lock(&wq_pool_attach_mutex);
2339 if (val)
2340 current->flags |= PF_WQ_WORKER;
2341 else
2342 current->flags &= ~PF_WQ_WORKER;
2343 mutex_unlock(&wq_pool_attach_mutex);
2344}
2345
Tejun Heo4690c4a2010-06-29 10:07:10 +02002346/**
2347 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002348 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002349 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002350 * The worker thread function. All workers belong to a worker_pool -
2351 * either a per-cpu one or dynamic unbound one. These workers process all
2352 * work items regardless of their specific target workqueue. The only
2353 * exception is work items which belong to workqueues with a rescuer which
2354 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002355 *
2356 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002357 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002358static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359{
Tejun Heoc34056a2010-06-29 10:07:11 +02002360 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002361 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362
Tejun Heoe22bee72010-06-29 10:07:14 +02002363 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002364 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002365woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002366 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002367
Tejun Heoa9ab7752013-03-19 13:45:21 -07002368 /* am I supposed to die? */
2369 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002370 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002371 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002372 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002373
2374 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002375 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002376 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002377 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002378 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002380
Tejun Heoc8e55f32010-06-29 10:07:12 +02002381 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002382recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002383 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002384 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002385 goto sleep;
2386
2387 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002388 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002389 goto recheck;
2390
Tejun Heoc8e55f32010-06-29 10:07:12 +02002391 /*
2392 * ->scheduled list can only be filled while a worker is
2393 * preparing to process a work or actually processing it.
2394 * Make sure nobody diddled with it while I was sleeping.
2395 */
Tejun Heo6183c002013-03-12 11:29:57 -07002396 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002397
Tejun Heoe22bee72010-06-29 10:07:14 +02002398 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002399 * Finish PREP stage. We're guaranteed to have at least one idle
2400 * worker or that someone else has already assumed the manager
2401 * role. This is where @worker starts participating in concurrency
2402 * management if applicable and concurrency management is restored
2403 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002404 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002405 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002406
2407 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002408 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002409 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002410 struct work_struct, entry);
2411
Tejun Heo82607adc2015-12-08 11:28:04 -05002412 pool->watchdog_ts = jiffies;
2413
Tejun Heoc8e55f32010-06-29 10:07:12 +02002414 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2415 /* optimization path, not strictly necessary */
2416 process_one_work(worker, work);
2417 if (unlikely(!list_empty(&worker->scheduled)))
2418 process_scheduled_works(worker);
2419 } else {
2420 move_linked_works(work, &worker->scheduled, NULL);
2421 process_scheduled_works(worker);
2422 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002423 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002424
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002425 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002426sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002427 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002428 * pool->lock is held and there's no work to process and no need to
2429 * manage, sleep. Workers are woken up only while holding
2430 * pool->lock or from local cpu, so setting the current state
2431 * before releasing pool->lock is enough to prevent losing any
2432 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002433 */
2434 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002435 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002436 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002437 schedule();
2438 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439}
2440
Tejun Heoe22bee72010-06-29 10:07:14 +02002441/**
2442 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002443 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002444 *
2445 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002446 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002447 *
Tejun Heo706026c2013-01-24 11:01:34 -08002448 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002449 * worker which uses GFP_KERNEL allocation which has slight chance of
2450 * developing into deadlock if some works currently on the same queue
2451 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2452 * the problem rescuer solves.
2453 *
Tejun Heo706026c2013-01-24 11:01:34 -08002454 * When such condition is possible, the pool summons rescuers of all
2455 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002456 * those works so that forward progress can be guaranteed.
2457 *
2458 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002459 *
2460 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002461 */
Tejun Heo111c2252013-01-17 17:16:24 -08002462static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002463{
Tejun Heo111c2252013-01-17 17:16:24 -08002464 struct worker *rescuer = __rescuer;
2465 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002466 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002467 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002468
2469 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002470
2471 /*
2472 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2473 * doesn't participate in concurrency management.
2474 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002475 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002476repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002477 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002478
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002479 /*
2480 * By the time the rescuer is requested to stop, the workqueue
2481 * shouldn't have any work pending, but @wq->maydays may still have
2482 * pwq(s) queued. This can happen by non-rescuer workers consuming
2483 * all the work items before the rescuer got to them. Go through
2484 * @wq->maydays processing before acting on should_stop so that the
2485 * list is always empty on exit.
2486 */
2487 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002488
Tejun Heo493a1722013-03-12 11:29:59 -07002489 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002490 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002491
2492 while (!list_empty(&wq->maydays)) {
2493 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2494 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002495 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002496 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002497 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002498
2499 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002500 list_del_init(&pwq->mayday_node);
2501
Tejun Heo2e109a22013-03-13 19:47:40 -07002502 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002503
Lai Jiangshan51697d392014-05-20 17:46:36 +08002504 worker_attach_to_pool(rescuer, pool);
2505
2506 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002507
2508 /*
2509 * Slurp in all works issued via this workqueue and
2510 * process'em.
2511 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002512 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002513 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2514 if (get_work_pwq(work) == pwq) {
2515 if (first)
2516 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002517 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002518 }
2519 first = false;
2520 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002521
NeilBrown008847f2014-12-08 12:39:16 -05002522 if (!list_empty(scheduled)) {
2523 process_scheduled_works(rescuer);
2524
2525 /*
2526 * The above execution of rescued work items could
2527 * have created more to rescue through
2528 * pwq_activate_first_delayed() or chained
2529 * queueing. Let's put @pwq back on mayday list so
2530 * that such back-to-back work items, which may be
2531 * being used to relieve memory pressure, don't
2532 * incur MAYDAY_INTERVAL delay inbetween.
2533 */
2534 if (need_to_create_worker(pool)) {
2535 spin_lock(&wq_mayday_lock);
2536 get_pwq(pwq);
2537 list_move_tail(&pwq->mayday_node, &wq->maydays);
2538 spin_unlock(&wq_mayday_lock);
2539 }
2540 }
Tejun Heo75769582011-02-14 14:04:46 +01002541
2542 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002543 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002544 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002545 */
2546 put_pwq(pwq);
2547
2548 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002549 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002550 * regular worker; otherwise, we end up with 0 concurrency
2551 * and stalling the execution.
2552 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002553 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002554 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002555
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002556 spin_unlock_irq(&pool->lock);
2557
Tejun Heoa2d812a2018-05-18 08:47:13 -07002558 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002559
2560 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002561 }
2562
Tejun Heo2e109a22013-03-13 19:47:40 -07002563 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002564
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002565 if (should_stop) {
2566 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002567 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002568 return 0;
2569 }
2570
Tejun Heo111c2252013-01-17 17:16:24 -08002571 /* rescuers should never participate in concurrency management */
2572 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002573 schedule();
2574 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575}
2576
Tejun Heofca839c2015-12-07 10:58:57 -05002577/**
2578 * check_flush_dependency - check for flush dependency sanity
2579 * @target_wq: workqueue being flushed
2580 * @target_work: work item being flushed (NULL for workqueue flushes)
2581 *
2582 * %current is trying to flush the whole @target_wq or @target_work on it.
2583 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2584 * reclaiming memory or running on a workqueue which doesn't have
2585 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2586 * a deadlock.
2587 */
2588static void check_flush_dependency(struct workqueue_struct *target_wq,
2589 struct work_struct *target_work)
2590{
2591 work_func_t target_func = target_work ? target_work->func : NULL;
2592 struct worker *worker;
2593
2594 if (target_wq->flags & WQ_MEM_RECLAIM)
2595 return;
2596
2597 worker = current_wq_worker();
2598
2599 WARN_ONCE(current->flags & PF_MEMALLOC,
2600 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2601 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002602 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2603 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002604 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2605 worker->current_pwq->wq->name, worker->current_func,
2606 target_wq->name, target_func);
2607}
2608
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002609struct wq_barrier {
2610 struct work_struct work;
2611 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002612 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002613};
2614
2615static void wq_barrier_func(struct work_struct *work)
2616{
2617 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2618 complete(&barr->done);
2619}
2620
Tejun Heo4690c4a2010-06-29 10:07:10 +02002621/**
2622 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002623 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002624 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002625 * @target: target work to attach @barr to
2626 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002627 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002628 * @barr is linked to @target such that @barr is completed only after
2629 * @target finishes execution. Please note that the ordering
2630 * guarantee is observed only with respect to @target and on the local
2631 * cpu.
2632 *
2633 * Currently, a queued barrier can't be canceled. This is because
2634 * try_to_grab_pending() can't determine whether the work to be
2635 * grabbed is at the head of the queue and thus can't clear LINKED
2636 * flag of the previous work while there must be a valid next work
2637 * after a work with LINKED flag set.
2638 *
2639 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002640 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002641 *
2642 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002643 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002644 */
Tejun Heo112202d2013-02-13 19:29:12 -08002645static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002646 struct wq_barrier *barr,
2647 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002648{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002649 struct list_head *head;
2650 unsigned int linked = 0;
2651
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002652 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002653 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002654 * as we know for sure that this will not trigger any of the
2655 * checks and call back into the fixup functions where we
2656 * might deadlock.
2657 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002658 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002659 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002660
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002661 init_completion_map(&barr->done, &target->lockdep_map);
2662
Tejun Heo2607d7a2015-03-09 09:22:28 -04002663 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002664
Tejun Heoaffee4b2010-06-29 10:07:12 +02002665 /*
2666 * If @target is currently being executed, schedule the
2667 * barrier to the worker; otherwise, put it after @target.
2668 */
2669 if (worker)
2670 head = worker->scheduled.next;
2671 else {
2672 unsigned long *bits = work_data_bits(target);
2673
2674 head = target->entry.next;
2675 /* there can already be other linked works, inherit and set */
2676 linked = *bits & WORK_STRUCT_LINKED;
2677 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2678 }
2679
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002680 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002681 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002682 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002683}
2684
Tejun Heo73f53c42010-06-29 10:07:11 +02002685/**
Tejun Heo112202d2013-02-13 19:29:12 -08002686 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002687 * @wq: workqueue being flushed
2688 * @flush_color: new flush color, < 0 for no-op
2689 * @work_color: new work color, < 0 for no-op
2690 *
Tejun Heo112202d2013-02-13 19:29:12 -08002691 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002692 *
Tejun Heo112202d2013-02-13 19:29:12 -08002693 * If @flush_color is non-negative, flush_color on all pwqs should be
2694 * -1. If no pwq has in-flight commands at the specified color, all
2695 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2696 * has in flight commands, its pwq->flush_color is set to
2697 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002698 * wakeup logic is armed and %true is returned.
2699 *
2700 * The caller should have initialized @wq->first_flusher prior to
2701 * calling this function with non-negative @flush_color. If
2702 * @flush_color is negative, no flush color update is done and %false
2703 * is returned.
2704 *
Tejun Heo112202d2013-02-13 19:29:12 -08002705 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002706 * work_color which is previous to @work_color and all will be
2707 * advanced to @work_color.
2708 *
2709 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002710 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002711 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002712 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002713 * %true if @flush_color >= 0 and there's something to flush. %false
2714 * otherwise.
2715 */
Tejun Heo112202d2013-02-13 19:29:12 -08002716static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002717 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718{
Tejun Heo73f53c42010-06-29 10:07:11 +02002719 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002720 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002721
Tejun Heo73f53c42010-06-29 10:07:11 +02002722 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002723 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002724 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002725 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002726
Tejun Heo49e3cf42013-03-12 11:29:58 -07002727 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002728 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002729
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002730 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002731
2732 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002733 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002734
Tejun Heo112202d2013-02-13 19:29:12 -08002735 if (pwq->nr_in_flight[flush_color]) {
2736 pwq->flush_color = flush_color;
2737 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002738 wait = true;
2739 }
2740 }
2741
2742 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002743 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002744 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002745 }
2746
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002747 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002748 }
2749
Tejun Heo112202d2013-02-13 19:29:12 -08002750 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002751 complete(&wq->first_flusher->done);
2752
2753 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754}
2755
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002756/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002758 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002760 * This function sleeps until all work items which were queued on entry
2761 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002763void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764{
Tejun Heo73f53c42010-06-29 10:07:11 +02002765 struct wq_flusher this_flusher = {
2766 .list = LIST_HEAD_INIT(this_flusher.list),
2767 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002768 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002769 };
2770 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002771
Tejun Heo3347fa02016-09-16 15:49:32 -04002772 if (WARN_ON(!wq_online))
2773 return;
2774
Johannes Berg87915ad2018-08-22 11:49:04 +02002775 lock_map_acquire(&wq->lockdep_map);
2776 lock_map_release(&wq->lockdep_map);
2777
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002778 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002779
2780 /*
2781 * Start-to-wait phase
2782 */
2783 next_color = work_next_color(wq->work_color);
2784
2785 if (next_color != wq->flush_color) {
2786 /*
2787 * Color space is not full. The current work_color
2788 * becomes our flush_color and work_color is advanced
2789 * by one.
2790 */
Tejun Heo6183c002013-03-12 11:29:57 -07002791 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002792 this_flusher.flush_color = wq->work_color;
2793 wq->work_color = next_color;
2794
2795 if (!wq->first_flusher) {
2796 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002797 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002798
2799 wq->first_flusher = &this_flusher;
2800
Tejun Heo112202d2013-02-13 19:29:12 -08002801 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002802 wq->work_color)) {
2803 /* nothing to flush, done */
2804 wq->flush_color = next_color;
2805 wq->first_flusher = NULL;
2806 goto out_unlock;
2807 }
2808 } else {
2809 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002810 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002811 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002812 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002813 }
2814 } else {
2815 /*
2816 * Oops, color space is full, wait on overflow queue.
2817 * The next flush completion will assign us
2818 * flush_color and transfer to flusher_queue.
2819 */
2820 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2821 }
2822
Tejun Heofca839c2015-12-07 10:58:57 -05002823 check_flush_dependency(wq, NULL);
2824
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002825 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002826
2827 wait_for_completion(&this_flusher.done);
2828
2829 /*
2830 * Wake-up-and-cascade phase
2831 *
2832 * First flushers are responsible for cascading flushes and
2833 * handling overflow. Non-first flushers can simply return.
2834 */
2835 if (wq->first_flusher != &this_flusher)
2836 return;
2837
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002838 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002839
Tejun Heo4ce48b32010-07-02 10:03:51 +02002840 /* we might have raced, check again with mutex held */
2841 if (wq->first_flusher != &this_flusher)
2842 goto out_unlock;
2843
Tejun Heo73f53c42010-06-29 10:07:11 +02002844 wq->first_flusher = NULL;
2845
Tejun Heo6183c002013-03-12 11:29:57 -07002846 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2847 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002848
2849 while (true) {
2850 struct wq_flusher *next, *tmp;
2851
2852 /* complete all the flushers sharing the current flush color */
2853 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2854 if (next->flush_color != wq->flush_color)
2855 break;
2856 list_del_init(&next->list);
2857 complete(&next->done);
2858 }
2859
Tejun Heo6183c002013-03-12 11:29:57 -07002860 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2861 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002862
2863 /* this flush_color is finished, advance by one */
2864 wq->flush_color = work_next_color(wq->flush_color);
2865
2866 /* one color has been freed, handle overflow queue */
2867 if (!list_empty(&wq->flusher_overflow)) {
2868 /*
2869 * Assign the same color to all overflowed
2870 * flushers, advance work_color and append to
2871 * flusher_queue. This is the start-to-wait
2872 * phase for these overflowed flushers.
2873 */
2874 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2875 tmp->flush_color = wq->work_color;
2876
2877 wq->work_color = work_next_color(wq->work_color);
2878
2879 list_splice_tail_init(&wq->flusher_overflow,
2880 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002881 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002882 }
2883
2884 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002885 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002886 break;
2887 }
2888
2889 /*
2890 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002891 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002892 */
Tejun Heo6183c002013-03-12 11:29:57 -07002893 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2894 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002895
2896 list_del_init(&next->list);
2897 wq->first_flusher = next;
2898
Tejun Heo112202d2013-02-13 19:29:12 -08002899 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002900 break;
2901
2902 /*
2903 * Meh... this color is already done, clear first
2904 * flusher and repeat cascading.
2905 */
2906 wq->first_flusher = NULL;
2907 }
2908
2909out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002910 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002912EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002914/**
2915 * drain_workqueue - drain a workqueue
2916 * @wq: workqueue to drain
2917 *
2918 * Wait until the workqueue becomes empty. While draining is in progress,
2919 * only chain queueing is allowed. IOW, only currently pending or running
2920 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002921 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002922 * by the depth of chaining and should be relatively short. Whine if it
2923 * takes too long.
2924 */
2925void drain_workqueue(struct workqueue_struct *wq)
2926{
2927 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002928 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002929
2930 /*
2931 * __queue_work() needs to test whether there are drainers, is much
2932 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002933 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002934 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002935 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002936 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002937 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002938 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002939reflush:
2940 flush_workqueue(wq);
2941
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002942 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002943
Tejun Heo49e3cf42013-03-12 11:29:58 -07002944 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002945 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002946
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002947 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002948 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002949 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002950
2951 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002952 continue;
2953
2954 if (++flush_cnt == 10 ||
2955 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002956 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002957 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002958
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002959 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002960 goto reflush;
2961 }
2962
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002963 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002964 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002965 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002966}
2967EXPORT_SYMBOL_GPL(drain_workqueue);
2968
Johannes Bergd6e89782018-08-22 11:49:03 +02002969static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2970 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002971{
2972 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002973 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002974 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002975
2976 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002977
Tejun Heofa1b54e2013-03-12 11:30:00 -07002978 local_irq_disable();
2979 pool = get_work_pool(work);
2980 if (!pool) {
2981 local_irq_enable();
2982 return false;
2983 }
2984
2985 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002986 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002987 pwq = get_work_pwq(work);
2988 if (pwq) {
2989 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002990 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002991 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002992 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002993 if (!worker)
2994 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002995 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002996 }
Tejun Heobaf59022010-09-16 10:42:16 +02002997
Tejun Heofca839c2015-12-07 10:58:57 -05002998 check_flush_dependency(pwq->wq, work);
2999
Tejun Heo112202d2013-02-13 19:29:12 -08003000 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003001 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003002
Tejun Heoe159489b2011-01-09 23:32:15 +01003003 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003004 * Force a lock recursion deadlock when using flush_work() inside a
3005 * single-threaded or rescuer equipped workqueue.
3006 *
3007 * For single threaded workqueues the deadlock happens when the work
3008 * is after the work issuing the flush_work(). For rescuer equipped
3009 * workqueues the deadlock happens when the rescuer stalls, blocking
3010 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01003011 */
Johannes Bergd6e89782018-08-22 11:49:03 +02003012 if (!from_cancel &&
3013 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08003014 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02003015 lock_map_release(&pwq->wq->lockdep_map);
3016 }
Tejun Heoe159489b2011-01-09 23:32:15 +01003017
Tejun Heobaf59022010-09-16 10:42:16 +02003018 return true;
3019already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08003020 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02003021 return false;
3022}
3023
Johannes Bergd6e89782018-08-22 11:49:03 +02003024static bool __flush_work(struct work_struct *work, bool from_cancel)
3025{
3026 struct wq_barrier barr;
3027
3028 if (WARN_ON(!wq_online))
3029 return false;
3030
Tetsuo Handa4d43d392019-01-23 09:44:12 +09003031 if (WARN_ON(!work->func))
3032 return false;
3033
Johannes Berg87915ad2018-08-22 11:49:04 +02003034 if (!from_cancel) {
3035 lock_map_acquire(&work->lockdep_map);
3036 lock_map_release(&work->lockdep_map);
3037 }
3038
Johannes Bergd6e89782018-08-22 11:49:03 +02003039 if (start_flush_work(work, &barr, from_cancel)) {
3040 wait_for_completion(&barr.done);
3041 destroy_work_on_stack(&barr.work);
3042 return true;
3043 } else {
3044 return false;
3045 }
3046}
3047
Oleg Nesterovdb700892008-07-25 01:47:49 -07003048/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003049 * flush_work - wait for a work to finish executing the last queueing instance
3050 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07003051 *
Tejun Heo606a5022012-08-20 14:51:23 -07003052 * Wait until @work has finished execution. @work is guaranteed to be idle
3053 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02003054 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003055 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003056 * %true if flush_work() waited for the work to finish execution,
3057 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07003058 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003059bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07003060{
Johannes Bergd6e89782018-08-22 11:49:03 +02003061 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07003062}
3063EXPORT_SYMBOL_GPL(flush_work);
3064
Tejun Heo8603e1b32015-03-05 08:04:13 -05003065struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02003066 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05003067 struct work_struct *work;
3068};
3069
Ingo Molnarac6424b2017-06-20 12:06:13 +02003070static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05003071{
3072 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3073
3074 if (cwait->work != key)
3075 return 0;
3076 return autoremove_wake_function(wait, mode, sync, key);
3077}
3078
Tejun Heo36e227d2012-08-03 10:30:46 -07003079static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02003080{
Tejun Heo8603e1b32015-03-05 08:04:13 -05003081 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07003082 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003083 int ret;
3084
3085 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07003086 ret = try_to_grab_pending(work, is_dwork, &flags);
3087 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05003088 * If someone else is already canceling, wait for it to
3089 * finish. flush_work() doesn't work for PREEMPT_NONE
3090 * because we may get scheduled between @work's completion
3091 * and the other canceling task resuming and clearing
3092 * CANCELING - flush_work() will return false immediately
3093 * as @work is no longer busy, try_to_grab_pending() will
3094 * return -ENOENT as @work is still being canceled and the
3095 * other canceling task won't be able to clear CANCELING as
3096 * we're hogging the CPU.
3097 *
3098 * Let's wait for completion using a waitqueue. As this
3099 * may lead to the thundering herd problem, use a custom
3100 * wake function which matches @work along with exclusive
3101 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003102 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003103 if (unlikely(ret == -ENOENT)) {
3104 struct cwt_wait cwait;
3105
3106 init_wait(&cwait.wait);
3107 cwait.wait.func = cwt_wakefn;
3108 cwait.work = work;
3109
3110 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3111 TASK_UNINTERRUPTIBLE);
3112 if (work_is_canceling(work))
3113 schedule();
3114 finish_wait(&cancel_waitq, &cwait.wait);
3115 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003116 } while (unlikely(ret < 0));
3117
Tejun Heobbb68df2012-08-03 10:30:46 -07003118 /* tell other tasks trying to grab @work to back off */
3119 mark_work_canceling(work);
3120 local_irq_restore(flags);
3121
Tejun Heo3347fa02016-09-16 15:49:32 -04003122 /*
3123 * This allows canceling during early boot. We know that @work
3124 * isn't executing.
3125 */
3126 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003127 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003128
Tejun Heo7a22ad72010-06-29 10:07:13 +02003129 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003130
3131 /*
3132 * Paired with prepare_to_wait() above so that either
3133 * waitqueue_active() is visible here or !work_is_canceling() is
3134 * visible there.
3135 */
3136 smp_mb();
3137 if (waitqueue_active(&cancel_waitq))
3138 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3139
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003140 return ret;
3141}
3142
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003143/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003144 * cancel_work_sync - cancel a work and wait for it to finish
3145 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003146 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003147 * Cancel @work and wait for its execution to finish. This function
3148 * can be used even if the work re-queues itself or migrates to
3149 * another workqueue. On return from this function, @work is
3150 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003151 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003152 * cancel_work_sync(&delayed_work->work) must not be used for
3153 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003154 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003155 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003156 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003157 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003158 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003159 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003160 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003161bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003162{
Tejun Heo36e227d2012-08-03 10:30:46 -07003163 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003164}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003165EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003166
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003167/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003168 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3169 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003170 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003171 * Delayed timer is cancelled and the pending work is queued for
3172 * immediate execution. Like flush_work(), this function only
3173 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003174 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003175 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003176 * %true if flush_work() waited for the work to finish execution,
3177 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003178 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003179bool flush_delayed_work(struct delayed_work *dwork)
3180{
Tejun Heo8930cab2012-08-03 10:30:45 -07003181 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003182 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003183 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003184 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003185 return flush_work(&dwork->work);
3186}
3187EXPORT_SYMBOL(flush_delayed_work);
3188
Tejun Heo05f0fe62018-03-14 12:45:13 -07003189/**
3190 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3191 * @rwork: the rcu work to flush
3192 *
3193 * Return:
3194 * %true if flush_rcu_work() waited for the work to finish execution,
3195 * %false if it was already idle.
3196 */
3197bool flush_rcu_work(struct rcu_work *rwork)
3198{
3199 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3200 rcu_barrier();
3201 flush_work(&rwork->work);
3202 return true;
3203 } else {
3204 return flush_work(&rwork->work);
3205 }
3206}
3207EXPORT_SYMBOL(flush_rcu_work);
3208
Jens Axboef72b8792016-08-24 15:51:50 -06003209static bool __cancel_work(struct work_struct *work, bool is_dwork)
3210{
3211 unsigned long flags;
3212 int ret;
3213
3214 do {
3215 ret = try_to_grab_pending(work, is_dwork, &flags);
3216 } while (unlikely(ret == -EAGAIN));
3217
3218 if (unlikely(ret < 0))
3219 return false;
3220
3221 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3222 local_irq_restore(flags);
3223 return ret;
3224}
3225
Tejun Heo401a8d02010-09-16 10:36:00 +02003226/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003227 * cancel_delayed_work - cancel a delayed work
3228 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003229 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003230 * Kill off a pending delayed_work.
3231 *
3232 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3233 * pending.
3234 *
3235 * Note:
3236 * The work callback function may still be running on return, unless
3237 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3238 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003239 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003240 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003241 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003242bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003243{
Jens Axboef72b8792016-08-24 15:51:50 -06003244 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003245}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003246EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003247
3248/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003249 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3250 * @dwork: the delayed work cancel
3251 *
3252 * This is cancel_work_sync() for delayed works.
3253 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003254 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003255 * %true if @dwork was pending, %false otherwise.
3256 */
3257bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003258{
Tejun Heo36e227d2012-08-03 10:30:46 -07003259 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003260}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003261EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003262
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003263/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003264 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003265 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003266 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003267 * schedule_on_each_cpu() executes @func on each online CPU using the
3268 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003269 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003270 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003271 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003272 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003273 */
David Howells65f27f32006-11-22 14:55:48 +00003274int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003275{
3276 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003277 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003278
Andrew Mortonb6136772006-06-25 05:47:49 -07003279 works = alloc_percpu(struct work_struct);
3280 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003281 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003282
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003283 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003284
Christoph Lameter15316ba82006-01-08 01:00:43 -08003285 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003286 struct work_struct *work = per_cpu_ptr(works, cpu);
3287
3288 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003289 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003290 }
Tejun Heo93981802009-11-17 14:06:20 -08003291
3292 for_each_online_cpu(cpu)
3293 flush_work(per_cpu_ptr(works, cpu));
3294
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003295 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003296 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003297 return 0;
3298}
3299
Alan Sterneef6a7d2010-02-12 17:39:21 +09003300/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003301 * execute_in_process_context - reliably execute the routine with user context
3302 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003303 * @ew: guaranteed storage for the execute work structure (must
3304 * be available when the work executes)
3305 *
3306 * Executes the function immediately if process context is available,
3307 * otherwise schedules the function for delayed execution.
3308 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003309 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003310 * 1 - function was scheduled for execution
3311 */
David Howells65f27f32006-11-22 14:55:48 +00003312int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003313{
3314 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003315 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003316 return 0;
3317 }
3318
David Howells65f27f32006-11-22 14:55:48 +00003319 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003320 schedule_work(&ew->work);
3321
3322 return 1;
3323}
3324EXPORT_SYMBOL_GPL(execute_in_process_context);
3325
Tejun Heo7a4e3442013-03-12 11:30:00 -07003326/**
3327 * free_workqueue_attrs - free a workqueue_attrs
3328 * @attrs: workqueue_attrs to free
3329 *
3330 * Undo alloc_workqueue_attrs().
3331 */
3332void free_workqueue_attrs(struct workqueue_attrs *attrs)
3333{
3334 if (attrs) {
3335 free_cpumask_var(attrs->cpumask);
3336 kfree(attrs);
3337 }
3338}
3339
3340/**
3341 * alloc_workqueue_attrs - allocate a workqueue_attrs
3342 * @gfp_mask: allocation mask to use
3343 *
3344 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003345 * return it.
3346 *
3347 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003348 */
3349struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3350{
3351 struct workqueue_attrs *attrs;
3352
3353 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3354 if (!attrs)
3355 goto fail;
3356 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3357 goto fail;
3358
Tejun Heo13e2e552013-04-01 11:23:31 -07003359 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003360 return attrs;
3361fail:
3362 free_workqueue_attrs(attrs);
3363 return NULL;
3364}
3365
Tejun Heo29c91e92013-03-12 11:30:03 -07003366static void copy_workqueue_attrs(struct workqueue_attrs *to,
3367 const struct workqueue_attrs *from)
3368{
3369 to->nice = from->nice;
3370 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003371 /*
3372 * Unlike hash and equality test, this function doesn't ignore
3373 * ->no_numa as it is used for both pool and wq attrs. Instead,
3374 * get_unbound_pool() explicitly clears ->no_numa after copying.
3375 */
3376 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003377}
3378
Tejun Heo29c91e92013-03-12 11:30:03 -07003379/* hash value of the content of @attr */
3380static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3381{
3382 u32 hash = 0;
3383
3384 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003385 hash = jhash(cpumask_bits(attrs->cpumask),
3386 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003387 return hash;
3388}
3389
3390/* content equality test */
3391static bool wqattrs_equal(const struct workqueue_attrs *a,
3392 const struct workqueue_attrs *b)
3393{
3394 if (a->nice != b->nice)
3395 return false;
3396 if (!cpumask_equal(a->cpumask, b->cpumask))
3397 return false;
3398 return true;
3399}
3400
Tejun Heo7a4e3442013-03-12 11:30:00 -07003401/**
3402 * init_worker_pool - initialize a newly zalloc'd worker_pool
3403 * @pool: worker_pool to initialize
3404 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303405 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003406 *
3407 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003408 * inside @pool proper are initialized and put_unbound_pool() can be called
3409 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003410 */
3411static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003412{
3413 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003414 pool->id = -1;
3415 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003416 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003417 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003418 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003419 INIT_LIST_HEAD(&pool->worklist);
3420 INIT_LIST_HEAD(&pool->idle_list);
3421 hash_init(pool->busy_hash);
3422
Kees Cook32a6c722017-10-16 15:58:25 -07003423 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003424
Kees Cook32a6c722017-10-16 15:58:25 -07003425 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003426
Lai Jiangshanda028462014-05-20 17:46:31 +08003427 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003428
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003429 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003430 INIT_HLIST_NODE(&pool->hash_node);
3431 pool->refcnt = 1;
3432
3433 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003434 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3435 if (!pool->attrs)
3436 return -ENOMEM;
3437 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003438}
3439
Bart Van Assche669de8b2019-02-14 15:00:54 -08003440#ifdef CONFIG_LOCKDEP
3441static void wq_init_lockdep(struct workqueue_struct *wq)
3442{
3443 char *lock_name;
3444
3445 lockdep_register_key(&wq->key);
3446 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3447 if (!lock_name)
3448 lock_name = wq->name;
Qian Cai69a106c2019-03-06 19:27:31 -05003449
3450 wq->lock_name = lock_name;
Bart Van Assche669de8b2019-02-14 15:00:54 -08003451 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3452}
3453
3454static void wq_unregister_lockdep(struct workqueue_struct *wq)
3455{
3456 lockdep_unregister_key(&wq->key);
3457}
3458
3459static void wq_free_lockdep(struct workqueue_struct *wq)
3460{
3461 if (wq->lock_name != wq->name)
3462 kfree(wq->lock_name);
3463}
3464#else
3465static void wq_init_lockdep(struct workqueue_struct *wq)
3466{
3467}
3468
3469static void wq_unregister_lockdep(struct workqueue_struct *wq)
3470{
3471}
3472
3473static void wq_free_lockdep(struct workqueue_struct *wq)
3474{
3475}
3476#endif
3477
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003478static void rcu_free_wq(struct rcu_head *rcu)
3479{
3480 struct workqueue_struct *wq =
3481 container_of(rcu, struct workqueue_struct, rcu);
3482
Bart Van Assche669de8b2019-02-14 15:00:54 -08003483 wq_free_lockdep(wq);
3484
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003485 if (!(wq->flags & WQ_UNBOUND))
3486 free_percpu(wq->cpu_pwqs);
3487 else
3488 free_workqueue_attrs(wq->unbound_attrs);
3489
3490 kfree(wq->rescuer);
3491 kfree(wq);
3492}
3493
Tejun Heo29c91e92013-03-12 11:30:03 -07003494static void rcu_free_pool(struct rcu_head *rcu)
3495{
3496 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3497
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003498 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003499 free_workqueue_attrs(pool->attrs);
3500 kfree(pool);
3501}
3502
3503/**
3504 * put_unbound_pool - put a worker_pool
3505 * @pool: worker_pool to put
3506 *
3507 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003508 * safe manner. get_unbound_pool() calls this function on its failure path
3509 * and this function should be able to release pools which went through,
3510 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003511 *
3512 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003513 */
3514static void put_unbound_pool(struct worker_pool *pool)
3515{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003516 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003517 struct worker *worker;
3518
Tejun Heoa892cac2013-04-01 11:23:32 -07003519 lockdep_assert_held(&wq_pool_mutex);
3520
3521 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003522 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003523
3524 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003525 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003526 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003527 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003528
3529 /* release id and unhash */
3530 if (pool->id >= 0)
3531 idr_remove(&worker_pool_idr, pool->id);
3532 hash_del(&pool->hash_node);
3533
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003534 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003535 * Become the manager and destroy all workers. This prevents
3536 * @pool's workers from blocking on attach_mutex. We're the last
3537 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003538 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003539 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003540 wait_event_lock_irq(wq_manager_wait,
3541 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3542 pool->flags |= POOL_MANAGER_ACTIVE;
3543
Lai Jiangshan1037de32014-05-22 16:44:07 +08003544 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003545 destroy_worker(worker);
3546 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003547 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003548
Tejun Heo1258fae2018-05-18 08:47:13 -07003549 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003550 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003551 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003552 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003553
3554 if (pool->detach_completion)
3555 wait_for_completion(pool->detach_completion);
3556
Tejun Heo29c91e92013-03-12 11:30:03 -07003557 /* shut down the timers */
3558 del_timer_sync(&pool->idle_timer);
3559 del_timer_sync(&pool->mayday_timer);
3560
3561 /* sched-RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003562 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003563}
3564
3565/**
3566 * get_unbound_pool - get a worker_pool with the specified attributes
3567 * @attrs: the attributes of the worker_pool to get
3568 *
3569 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3570 * reference count and return it. If there already is a matching
3571 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003572 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003573 *
3574 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003575 *
3576 * Return: On success, a worker_pool with the same attributes as @attrs.
3577 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003578 */
3579static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3580{
Tejun Heo29c91e92013-03-12 11:30:03 -07003581 u32 hash = wqattrs_hash(attrs);
3582 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003583 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003584 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003585
Tejun Heoa892cac2013-04-01 11:23:32 -07003586 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003587
3588 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003589 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3590 if (wqattrs_equal(pool->attrs, attrs)) {
3591 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003592 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003593 }
3594 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003595
Xunlei Pange22735842015-10-09 11:53:12 +08003596 /* if cpumask is contained inside a NUMA node, we belong to that node */
3597 if (wq_numa_enabled) {
3598 for_each_node(node) {
3599 if (cpumask_subset(attrs->cpumask,
3600 wq_numa_possible_cpumask[node])) {
3601 target_node = node;
3602 break;
3603 }
3604 }
3605 }
3606
Tejun Heo29c91e92013-03-12 11:30:03 -07003607 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003608 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003609 if (!pool || init_worker_pool(pool) < 0)
3610 goto fail;
3611
Tejun Heo8864b4e2013-03-12 11:30:04 -07003612 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003613 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003614 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003615
Shaohua Li2865a8f2013-08-01 09:56:36 +08003616 /*
3617 * no_numa isn't a worker_pool attribute, always clear it. See
3618 * 'struct workqueue_attrs' comments for detail.
3619 */
3620 pool->attrs->no_numa = false;
3621
Tejun Heo29c91e92013-03-12 11:30:03 -07003622 if (worker_pool_assign_id(pool) < 0)
3623 goto fail;
3624
3625 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003626 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003627 goto fail;
3628
Tejun Heo29c91e92013-03-12 11:30:03 -07003629 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003630 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003631
Tejun Heo29c91e92013-03-12 11:30:03 -07003632 return pool;
3633fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003634 if (pool)
3635 put_unbound_pool(pool);
3636 return NULL;
3637}
3638
Tejun Heo8864b4e2013-03-12 11:30:04 -07003639static void rcu_free_pwq(struct rcu_head *rcu)
3640{
3641 kmem_cache_free(pwq_cache,
3642 container_of(rcu, struct pool_workqueue, rcu));
3643}
3644
3645/*
3646 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3647 * and needs to be destroyed.
3648 */
3649static void pwq_unbound_release_workfn(struct work_struct *work)
3650{
3651 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3652 unbound_release_work);
3653 struct workqueue_struct *wq = pwq->wq;
3654 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003655 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003656
3657 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3658 return;
3659
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003660 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003661 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003662 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003663 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003664
Tejun Heoa892cac2013-04-01 11:23:32 -07003665 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003666 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003667 mutex_unlock(&wq_pool_mutex);
3668
Paul E. McKenney25b00772018-11-06 19:18:45 -08003669 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003670
3671 /*
3672 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003673 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003674 */
Bart Van Assche669de8b2019-02-14 15:00:54 -08003675 if (is_last) {
3676 wq_unregister_lockdep(wq);
Paul E. McKenney25b00772018-11-06 19:18:45 -08003677 call_rcu(&wq->rcu, rcu_free_wq);
Bart Van Assche669de8b2019-02-14 15:00:54 -08003678 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003679}
3680
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003681/**
Tejun Heo699ce092013-03-13 16:51:35 -07003682 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003683 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003684 *
Tejun Heo699ce092013-03-13 16:51:35 -07003685 * If @pwq isn't freezing, set @pwq->max_active to the associated
3686 * workqueue's saved_max_active and activate delayed work items
3687 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003688 */
Tejun Heo699ce092013-03-13 16:51:35 -07003689static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003690{
Tejun Heo699ce092013-03-13 16:51:35 -07003691 struct workqueue_struct *wq = pwq->wq;
3692 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003693 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003694
Tejun Heo699ce092013-03-13 16:51:35 -07003695 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003696 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003697
3698 /* fast exit for non-freezable wqs */
3699 if (!freezable && pwq->max_active == wq->saved_max_active)
3700 return;
3701
Tejun Heo3347fa02016-09-16 15:49:32 -04003702 /* this function can be called during early boot w/ irq disabled */
3703 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003704
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003705 /*
3706 * During [un]freezing, the caller is responsible for ensuring that
3707 * this function is called at least once after @workqueue_freezing
3708 * is updated and visible.
3709 */
3710 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003711 pwq->max_active = wq->saved_max_active;
3712
3713 while (!list_empty(&pwq->delayed_works) &&
3714 pwq->nr_active < pwq->max_active)
3715 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003716
3717 /*
3718 * Need to kick a worker after thawed or an unbound wq's
3719 * max_active is bumped. It's a slow path. Do it always.
3720 */
3721 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003722 } else {
3723 pwq->max_active = 0;
3724 }
3725
Tejun Heo3347fa02016-09-16 15:49:32 -04003726 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003727}
3728
Tejun Heoe50aba92013-04-01 11:23:35 -07003729/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003730static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3731 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003732{
3733 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3734
Tejun Heoe50aba92013-04-01 11:23:35 -07003735 memset(pwq, 0, sizeof(*pwq));
3736
Tejun Heod2c1d402013-03-12 11:30:04 -07003737 pwq->pool = pool;
3738 pwq->wq = wq;
3739 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003740 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003741 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003742 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003743 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003744 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003745}
Tejun Heod2c1d402013-03-12 11:30:04 -07003746
Tejun Heof147f292013-04-01 11:23:35 -07003747/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003748static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003749{
3750 struct workqueue_struct *wq = pwq->wq;
3751
3752 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003753
Tejun Heo1befcf32013-04-01 11:23:35 -07003754 /* may be called multiple times, ignore if already linked */
3755 if (!list_empty(&pwq->pwqs_node))
3756 return;
3757
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003758 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003759 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003760
3761 /* sync max_active to the current setting */
3762 pwq_adjust_max_active(pwq);
3763
3764 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003765 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003766}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003767
Tejun Heof147f292013-04-01 11:23:35 -07003768/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3769static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3770 const struct workqueue_attrs *attrs)
3771{
3772 struct worker_pool *pool;
3773 struct pool_workqueue *pwq;
3774
3775 lockdep_assert_held(&wq_pool_mutex);
3776
3777 pool = get_unbound_pool(attrs);
3778 if (!pool)
3779 return NULL;
3780
Tejun Heoe50aba92013-04-01 11:23:35 -07003781 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003782 if (!pwq) {
3783 put_unbound_pool(pool);
3784 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003785 }
Tejun Heo6029a912013-04-01 11:23:34 -07003786
Tejun Heof147f292013-04-01 11:23:35 -07003787 init_pwq(pwq, wq, pool);
3788 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003789}
3790
Tejun Heo4c16bd32013-04-01 11:23:36 -07003791/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003792 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003793 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003794 * @node: the target NUMA node
3795 * @cpu_going_down: if >= 0, the CPU to consider as offline
3796 * @cpumask: outarg, the resulting cpumask
3797 *
3798 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3799 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003800 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003801 *
3802 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3803 * enabled and @node has online CPUs requested by @attrs, the returned
3804 * cpumask is the intersection of the possible CPUs of @node and
3805 * @attrs->cpumask.
3806 *
3807 * The caller is responsible for ensuring that the cpumask of @node stays
3808 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003809 *
3810 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3811 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003812 */
3813static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3814 int cpu_going_down, cpumask_t *cpumask)
3815{
Tejun Heod55262c2013-04-01 11:23:38 -07003816 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003817 goto use_dfl;
3818
3819 /* does @node have any online CPUs @attrs wants? */
3820 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3821 if (cpu_going_down >= 0)
3822 cpumask_clear_cpu(cpu_going_down, cpumask);
3823
3824 if (cpumask_empty(cpumask))
3825 goto use_dfl;
3826
3827 /* yeap, return possible CPUs in @node that @attrs wants */
3828 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003829
3830 if (cpumask_empty(cpumask)) {
3831 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3832 "possible intersect\n");
3833 return false;
3834 }
3835
Tejun Heo4c16bd32013-04-01 11:23:36 -07003836 return !cpumask_equal(cpumask, attrs->cpumask);
3837
3838use_dfl:
3839 cpumask_copy(cpumask, attrs->cpumask);
3840 return false;
3841}
3842
Tejun Heo1befcf32013-04-01 11:23:35 -07003843/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3844static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3845 int node,
3846 struct pool_workqueue *pwq)
3847{
3848 struct pool_workqueue *old_pwq;
3849
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003850 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003851 lockdep_assert_held(&wq->mutex);
3852
3853 /* link_pwq() can handle duplicate calls */
3854 link_pwq(pwq);
3855
3856 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3857 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3858 return old_pwq;
3859}
3860
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003861/* context to store the prepared attrs & pwqs before applying */
3862struct apply_wqattrs_ctx {
3863 struct workqueue_struct *wq; /* target workqueue */
3864 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003865 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003866 struct pool_workqueue *dfl_pwq;
3867 struct pool_workqueue *pwq_tbl[];
3868};
3869
3870/* free the resources after success or abort */
3871static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3872{
3873 if (ctx) {
3874 int node;
3875
3876 for_each_node(node)
3877 put_pwq_unlocked(ctx->pwq_tbl[node]);
3878 put_pwq_unlocked(ctx->dfl_pwq);
3879
3880 free_workqueue_attrs(ctx->attrs);
3881
3882 kfree(ctx);
3883 }
3884}
3885
3886/* allocate the attrs and pwqs for later installation */
3887static struct apply_wqattrs_ctx *
3888apply_wqattrs_prepare(struct workqueue_struct *wq,
3889 const struct workqueue_attrs *attrs)
3890{
3891 struct apply_wqattrs_ctx *ctx;
3892 struct workqueue_attrs *new_attrs, *tmp_attrs;
3893 int node;
3894
3895 lockdep_assert_held(&wq_pool_mutex);
3896
Kees Cookacafe7e2018-05-08 13:45:50 -07003897 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003898
3899 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3900 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3901 if (!ctx || !new_attrs || !tmp_attrs)
3902 goto out_free;
3903
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003904 /*
3905 * Calculate the attrs of the default pwq.
3906 * If the user configured cpumask doesn't overlap with the
3907 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3908 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003909 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003910 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003911 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3912 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003913
3914 /*
3915 * We may create multiple pwqs with differing cpumasks. Make a
3916 * copy of @new_attrs which will be modified and used to obtain
3917 * pools.
3918 */
3919 copy_workqueue_attrs(tmp_attrs, new_attrs);
3920
3921 /*
3922 * If something goes wrong during CPU up/down, we'll fall back to
3923 * the default pwq covering whole @attrs->cpumask. Always create
3924 * it even if we don't use it immediately.
3925 */
3926 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3927 if (!ctx->dfl_pwq)
3928 goto out_free;
3929
3930 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003931 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003932 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3933 if (!ctx->pwq_tbl[node])
3934 goto out_free;
3935 } else {
3936 ctx->dfl_pwq->refcnt++;
3937 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3938 }
3939 }
3940
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003941 /* save the user configured attrs and sanitize it. */
3942 copy_workqueue_attrs(new_attrs, attrs);
3943 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003944 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003945
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003946 ctx->wq = wq;
3947 free_workqueue_attrs(tmp_attrs);
3948 return ctx;
3949
3950out_free:
3951 free_workqueue_attrs(tmp_attrs);
3952 free_workqueue_attrs(new_attrs);
3953 apply_wqattrs_cleanup(ctx);
3954 return NULL;
3955}
3956
3957/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3958static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3959{
3960 int node;
3961
3962 /* all pwqs have been created successfully, let's install'em */
3963 mutex_lock(&ctx->wq->mutex);
3964
3965 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3966
3967 /* save the previous pwq and install the new one */
3968 for_each_node(node)
3969 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3970 ctx->pwq_tbl[node]);
3971
3972 /* @dfl_pwq might not have been used, ensure it's linked */
3973 link_pwq(ctx->dfl_pwq);
3974 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3975
3976 mutex_unlock(&ctx->wq->mutex);
3977}
3978
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003979static void apply_wqattrs_lock(void)
3980{
3981 /* CPUs should stay stable across pwq creations and installations */
3982 get_online_cpus();
3983 mutex_lock(&wq_pool_mutex);
3984}
3985
3986static void apply_wqattrs_unlock(void)
3987{
3988 mutex_unlock(&wq_pool_mutex);
3989 put_online_cpus();
3990}
3991
3992static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3993 const struct workqueue_attrs *attrs)
3994{
3995 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003996
3997 /* only unbound workqueues can change attributes */
3998 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3999 return -EINVAL;
4000
4001 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004002 if (!list_empty(&wq->pwqs)) {
4003 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4004 return -EINVAL;
4005
4006 wq->flags &= ~__WQ_ORDERED;
4007 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004008
4009 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08004010 if (!ctx)
4011 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004012
4013 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08004014 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004015 apply_wqattrs_cleanup(ctx);
4016
wanghaibin62011712016-01-07 20:38:59 +08004017 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004018}
4019
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004020/**
4021 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4022 * @wq: the target workqueue
4023 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4024 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07004025 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4026 * machines, this function maps a separate pwq to each NUMA node with
4027 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4028 * NUMA node it was issued on. Older pwqs are released as in-flight work
4029 * items finish. Note that a work item which repeatedly requeues itself
4030 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004031 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004032 * Performs GFP_KERNEL allocations.
4033 *
4034 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004035 */
4036int apply_workqueue_attrs(struct workqueue_struct *wq,
4037 const struct workqueue_attrs *attrs)
4038{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004039 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004040
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004041 apply_wqattrs_lock();
4042 ret = apply_workqueue_attrs_locked(wq, attrs);
4043 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08004044
Tejun Heo48621252013-04-01 11:23:31 -07004045 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004046}
NeilBrown6106c0f2018-01-11 15:06:40 +11004047EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004048
Tejun Heo4c16bd32013-04-01 11:23:36 -07004049/**
4050 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4051 * @wq: the target workqueue
4052 * @cpu: the CPU coming up or going down
4053 * @online: whether @cpu is coming up or going down
4054 *
4055 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4056 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4057 * @wq accordingly.
4058 *
4059 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4060 * falls back to @wq->dfl_pwq which may not be optimal but is always
4061 * correct.
4062 *
4063 * Note that when the last allowed CPU of a NUMA node goes offline for a
4064 * workqueue with a cpumask spanning multiple nodes, the workers which were
4065 * already executing the work items for the workqueue will lose their CPU
4066 * affinity and may execute on any CPU. This is similar to how per-cpu
4067 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4068 * affinity, it's the user's responsibility to flush the work item from
4069 * CPU_DOWN_PREPARE.
4070 */
4071static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4072 bool online)
4073{
4074 int node = cpu_to_node(cpu);
4075 int cpu_off = online ? -1 : cpu;
4076 struct pool_workqueue *old_pwq = NULL, *pwq;
4077 struct workqueue_attrs *target_attrs;
4078 cpumask_t *cpumask;
4079
4080 lockdep_assert_held(&wq_pool_mutex);
4081
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004082 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4083 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07004084 return;
4085
4086 /*
4087 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4088 * Let's use a preallocated one. The following buf is protected by
4089 * CPU hotplug exclusion.
4090 */
4091 target_attrs = wq_update_unbound_numa_attrs_buf;
4092 cpumask = target_attrs->cpumask;
4093
Tejun Heo4c16bd32013-04-01 11:23:36 -07004094 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4095 pwq = unbound_pwq_by_node(wq, node);
4096
4097 /*
4098 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004099 * different from the default pwq's, we need to compare it to @pwq's
4100 * and create a new one if they don't match. If the target cpumask
4101 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07004102 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004103 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07004104 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004105 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004106 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09004107 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004108 }
4109
Tejun Heo4c16bd32013-04-01 11:23:36 -07004110 /* create a new pwq */
4111 pwq = alloc_unbound_pwq(wq, target_attrs);
4112 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04004113 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4114 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09004115 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004116 }
4117
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004118 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004119 mutex_lock(&wq->mutex);
4120 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4121 goto out_unlock;
4122
4123use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08004124 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004125 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4126 get_pwq(wq->dfl_pwq);
4127 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4128 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4129out_unlock:
4130 mutex_unlock(&wq->mutex);
4131 put_pwq_unlocked(old_pwq);
4132}
4133
Tejun Heo30cdf2492013-03-12 11:29:57 -07004134static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004135{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004136 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004137 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01004138
Tejun Heo30cdf2492013-03-12 11:29:57 -07004139 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07004140 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4141 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004142 return -ENOMEM;
4143
4144 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004145 struct pool_workqueue *pwq =
4146 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004147 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004148 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004149
Tejun Heof147f292013-04-01 11:23:35 -07004150 init_pwq(pwq, wq, &cpu_pools[highpri]);
4151
4152 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004153 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004154 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004155 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004156 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004157 } else if (wq->flags & __WQ_ORDERED) {
4158 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4159 /* there should only be single pwq for ordering guarantee */
4160 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4161 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4162 "ordering guarantee broken for workqueue %s\n", wq->name);
4163 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07004164 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004165 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004166 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004167}
4168
Tejun Heof3421792010-07-02 10:03:51 +02004169static int wq_clamp_max_active(int max_active, unsigned int flags,
4170 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004171{
Tejun Heof3421792010-07-02 10:03:51 +02004172 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4173
4174 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004175 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4176 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004177
Tejun Heof3421792010-07-02 10:03:51 +02004178 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004179}
4180
Tejun Heo983c7512018-01-08 05:38:32 -08004181/*
4182 * Workqueues which may be used during memory reclaim should have a rescuer
4183 * to guarantee forward progress.
4184 */
4185static int init_rescuer(struct workqueue_struct *wq)
4186{
4187 struct worker *rescuer;
4188 int ret;
4189
4190 if (!(wq->flags & WQ_MEM_RECLAIM))
4191 return 0;
4192
4193 rescuer = alloc_worker(NUMA_NO_NODE);
4194 if (!rescuer)
4195 return -ENOMEM;
4196
4197 rescuer->rescue_wq = wq;
4198 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4199 ret = PTR_ERR_OR_ZERO(rescuer->task);
4200 if (ret) {
4201 kfree(rescuer);
4202 return ret;
4203 }
4204
4205 wq->rescuer = rescuer;
4206 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4207 wake_up_process(rescuer->task);
4208
4209 return 0;
4210}
4211
Mathieu Malaterrea2775bb2019-03-12 21:21:26 +01004212__printf(1, 4)
Bart Van Assche669de8b2019-02-14 15:00:54 -08004213struct workqueue_struct *alloc_workqueue(const char *fmt,
4214 unsigned int flags,
4215 int max_active, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004216{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004217 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004218 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004219 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004220 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004221
Tejun Heo5c0338c2017-07-18 18:41:52 -04004222 /*
4223 * Unbound && max_active == 1 used to imply ordered, which is no
4224 * longer the case on NUMA machines due to per-node pools. While
4225 * alloc_ordered_workqueue() is the right way to create an ordered
4226 * workqueue, keep the previous behavior to avoid subtle breakages
4227 * on NUMA.
4228 */
4229 if ((flags & WQ_UNBOUND) && max_active == 1)
4230 flags |= __WQ_ORDERED;
4231
Viresh Kumarcee22a12013-04-08 16:45:40 +05304232 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4233 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4234 flags |= WQ_UNBOUND;
4235
Tejun Heoecf68812013-04-01 11:23:34 -07004236 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004237 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004238 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004239
4240 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004241 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004242 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004243
Tejun Heo6029a912013-04-01 11:23:34 -07004244 if (flags & WQ_UNBOUND) {
4245 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4246 if (!wq->unbound_attrs)
4247 goto err_free_wq;
4248 }
4249
Bart Van Assche669de8b2019-02-14 15:00:54 -08004250 va_start(args, max_active);
Tejun Heoecf68812013-04-01 11:23:34 -07004251 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004252 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004253
Tejun Heod320c032010-06-29 10:07:14 +02004254 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004255 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004256
Tejun Heob196be82012-01-10 15:11:35 -08004257 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004258 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004259 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004260 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004261 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004262 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004263 INIT_LIST_HEAD(&wq->flusher_queue);
4264 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004265 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004266
Bart Van Assche669de8b2019-02-14 15:00:54 -08004267 wq_init_lockdep(wq);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004268 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004269
Tejun Heo30cdf2492013-03-12 11:29:57 -07004270 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004271 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004272
Tejun Heo40c17f72018-01-08 05:38:37 -08004273 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004274 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004275
Tejun Heo226223a2013-03-12 11:30:05 -07004276 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4277 goto err_destroy;
4278
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004279 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004280 * wq_pool_mutex protects global freeze state and workqueues list.
4281 * Grab it, adjust max_active and add the new @wq to workqueues
4282 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004283 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004284 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004285
Lai Jiangshana357fc02013-03-25 16:57:19 -07004286 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004287 for_each_pwq(pwq, wq)
4288 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004289 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004290
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004291 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004292
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004293 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004294
Oleg Nesterov3af244332007-05-09 02:34:09 -07004295 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004296
4297err_free_wq:
Bart Van Assche009bb422019-03-03 14:00:46 -08004298 wq_unregister_lockdep(wq);
4299 wq_free_lockdep(wq);
Tejun Heo6029a912013-04-01 11:23:34 -07004300 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004301 kfree(wq);
4302 return NULL;
4303err_destroy:
4304 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004305 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004306}
Bart Van Assche669de8b2019-02-14 15:00:54 -08004307EXPORT_SYMBOL_GPL(alloc_workqueue);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004308
4309/**
4310 * destroy_workqueue - safely terminate a workqueue
4311 * @wq: target workqueue
4312 *
4313 * Safely destroy a workqueue. All work currently pending will be done first.
4314 */
4315void destroy_workqueue(struct workqueue_struct *wq)
4316{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004317 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004318 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004319
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004320 /* drain it before proceeding with destruction */
4321 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004322
Tejun Heo6183c002013-03-12 11:29:57 -07004323 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004324 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004325 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004326 int i;
4327
Tejun Heo76af4d92013-03-12 11:30:00 -07004328 for (i = 0; i < WORK_NR_COLORS; i++) {
4329 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004330 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004331 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004332 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004333 }
4334 }
4335
Lai Jiangshan5c529592013-04-04 10:05:38 +08004336 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004337 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004338 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004339 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004340 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004341 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004342 }
Tejun Heo6183c002013-03-12 11:29:57 -07004343 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004344 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004345
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004346 /*
4347 * wq list is used to freeze wq, remove from list after
4348 * flushing is complete in case freeze races us.
4349 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004350 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004351 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004352 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004353
Tejun Heo226223a2013-03-12 11:30:05 -07004354 workqueue_sysfs_unregister(wq);
4355
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004356 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004357 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004358
Tejun Heo8864b4e2013-03-12 11:30:04 -07004359 if (!(wq->flags & WQ_UNBOUND)) {
Bart Van Assche669de8b2019-02-14 15:00:54 -08004360 wq_unregister_lockdep(wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004361 /*
4362 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004363 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004364 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004365 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004366 } else {
4367 /*
4368 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004369 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4370 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004371 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004372 for_each_node(node) {
4373 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4374 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4375 put_pwq_unlocked(pwq);
4376 }
4377
4378 /*
4379 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4380 * put. Don't access it afterwards.
4381 */
4382 pwq = wq->dfl_pwq;
4383 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004384 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004385 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004386}
4387EXPORT_SYMBOL_GPL(destroy_workqueue);
4388
Tejun Heodcd989c2010-06-29 10:07:14 +02004389/**
4390 * workqueue_set_max_active - adjust max_active of a workqueue
4391 * @wq: target workqueue
4392 * @max_active: new max_active value.
4393 *
4394 * Set max_active of @wq to @max_active.
4395 *
4396 * CONTEXT:
4397 * Don't call from IRQ context.
4398 */
4399void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4400{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004401 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004402
Tejun Heo8719dce2013-03-12 11:30:04 -07004403 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004404 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004405 return;
4406
Tejun Heof3421792010-07-02 10:03:51 +02004407 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004408
Lai Jiangshana357fc02013-03-25 16:57:19 -07004409 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004410
Tejun Heo0a94efb2017-07-23 08:36:15 -04004411 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004412 wq->saved_max_active = max_active;
4413
Tejun Heo699ce092013-03-13 16:51:35 -07004414 for_each_pwq(pwq, wq)
4415 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004416
Lai Jiangshana357fc02013-03-25 16:57:19 -07004417 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004418}
4419EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4420
4421/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004422 * current_work - retrieve %current task's work struct
4423 *
4424 * Determine if %current task is a workqueue worker and what it's working on.
4425 * Useful to find out the context that the %current task is running in.
4426 *
4427 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4428 */
4429struct work_struct *current_work(void)
4430{
4431 struct worker *worker = current_wq_worker();
4432
4433 return worker ? worker->current_work : NULL;
4434}
4435EXPORT_SYMBOL(current_work);
4436
4437/**
Tejun Heoe62676162013-03-12 17:41:37 -07004438 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4439 *
4440 * Determine whether %current is a workqueue rescuer. Can be used from
4441 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004442 *
4443 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004444 */
4445bool current_is_workqueue_rescuer(void)
4446{
4447 struct worker *worker = current_wq_worker();
4448
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004449 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004450}
4451
4452/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004453 * workqueue_congested - test whether a workqueue is congested
4454 * @cpu: CPU in question
4455 * @wq: target workqueue
4456 *
4457 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4458 * no synchronization around this function and the test result is
4459 * unreliable and only useful as advisory hints or for debugging.
4460 *
Tejun Heod3251852013-05-10 11:10:17 -07004461 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4462 * Note that both per-cpu and unbound workqueues may be associated with
4463 * multiple pool_workqueues which have separate congested states. A
4464 * workqueue being congested on one CPU doesn't mean the workqueue is also
4465 * contested on other CPUs / NUMA nodes.
4466 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004467 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004468 * %true if congested, %false otherwise.
4469 */
Tejun Heod84ff052013-03-12 11:29:59 -07004470bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004471{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004472 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004473 bool ret;
4474
Lai Jiangshan88109452013-03-20 03:28:10 +08004475 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004476
Tejun Heod3251852013-05-10 11:10:17 -07004477 if (cpu == WORK_CPU_UNBOUND)
4478 cpu = smp_processor_id();
4479
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004480 if (!(wq->flags & WQ_UNBOUND))
4481 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4482 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004483 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004484
Tejun Heo76af4d92013-03-12 11:30:00 -07004485 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004486 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004487
4488 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004489}
4490EXPORT_SYMBOL_GPL(workqueue_congested);
4491
4492/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004493 * work_busy - test whether a work is currently pending or running
4494 * @work: the work to be tested
4495 *
4496 * Test whether @work is currently pending or running. There is no
4497 * synchronization around this function and the test result is
4498 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004499 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004500 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004501 * OR'd bitmask of WORK_BUSY_* bits.
4502 */
4503unsigned int work_busy(struct work_struct *work)
4504{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004505 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004506 unsigned long flags;
4507 unsigned int ret = 0;
4508
Tejun Heodcd989c2010-06-29 10:07:14 +02004509 if (work_pending(work))
4510 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004511
Tejun Heofa1b54e2013-03-12 11:30:00 -07004512 local_irq_save(flags);
4513 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004514 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004515 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004516 if (find_worker_executing_work(pool, work))
4517 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004518 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004519 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004520 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004521
4522 return ret;
4523}
4524EXPORT_SYMBOL_GPL(work_busy);
4525
Tejun Heo3d1cb202013-04-30 15:27:22 -07004526/**
4527 * set_worker_desc - set description for the current work item
4528 * @fmt: printf-style format string
4529 * @...: arguments for the format string
4530 *
4531 * This function can be called by a running work function to describe what
4532 * the work item is about. If the worker task gets dumped, this
4533 * information will be printed out together to help debugging. The
4534 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4535 */
4536void set_worker_desc(const char *fmt, ...)
4537{
4538 struct worker *worker = current_wq_worker();
4539 va_list args;
4540
4541 if (worker) {
4542 va_start(args, fmt);
4543 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4544 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004545 }
4546}
Steffen Maier5c750d52018-05-17 19:14:57 +02004547EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004548
4549/**
4550 * print_worker_info - print out worker information and description
4551 * @log_lvl: the log level to use when printing
4552 * @task: target task
4553 *
4554 * If @task is a worker and currently executing a work item, print out the
4555 * name of the workqueue being serviced and worker description set with
4556 * set_worker_desc() by the currently executing work item.
4557 *
4558 * This function can be safely called on any task as long as the
4559 * task_struct itself is accessible. While safe, this function isn't
4560 * synchronized and may print out mixups or garbages of limited length.
4561 */
4562void print_worker_info(const char *log_lvl, struct task_struct *task)
4563{
4564 work_func_t *fn = NULL;
4565 char name[WQ_NAME_LEN] = { };
4566 char desc[WORKER_DESC_LEN] = { };
4567 struct pool_workqueue *pwq = NULL;
4568 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004569 struct worker *worker;
4570
4571 if (!(task->flags & PF_WQ_WORKER))
4572 return;
4573
4574 /*
4575 * This function is called without any synchronization and @task
4576 * could be in any state. Be careful with dereferences.
4577 */
Petr Mladeke7005912016-10-11 13:55:17 -07004578 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004579
4580 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004581 * Carefully copy the associated workqueue's workfn, name and desc.
4582 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004583 */
4584 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4585 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4586 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4587 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004588 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004589
4590 if (fn || name[0] || desc[0]) {
4591 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004592 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004593 pr_cont(" (%s)", desc);
4594 pr_cont("\n");
4595 }
4596}
4597
Tejun Heo3494fc32015-03-09 09:22:28 -04004598static void pr_cont_pool_info(struct worker_pool *pool)
4599{
4600 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4601 if (pool->node != NUMA_NO_NODE)
4602 pr_cont(" node=%d", pool->node);
4603 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4604}
4605
4606static void pr_cont_work(bool comma, struct work_struct *work)
4607{
4608 if (work->func == wq_barrier_func) {
4609 struct wq_barrier *barr;
4610
4611 barr = container_of(work, struct wq_barrier, work);
4612
4613 pr_cont("%s BAR(%d)", comma ? "," : "",
4614 task_pid_nr(barr->task));
4615 } else {
4616 pr_cont("%s %pf", comma ? "," : "", work->func);
4617 }
4618}
4619
4620static void show_pwq(struct pool_workqueue *pwq)
4621{
4622 struct worker_pool *pool = pwq->pool;
4623 struct work_struct *work;
4624 struct worker *worker;
4625 bool has_in_flight = false, has_pending = false;
4626 int bkt;
4627
4628 pr_info(" pwq %d:", pool->id);
4629 pr_cont_pool_info(pool);
4630
4631 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4632 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4633
4634 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4635 if (worker->current_pwq == pwq) {
4636 has_in_flight = true;
4637 break;
4638 }
4639 }
4640 if (has_in_flight) {
4641 bool comma = false;
4642
4643 pr_info(" in-flight:");
4644 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4645 if (worker->current_pwq != pwq)
4646 continue;
4647
4648 pr_cont("%s %d%s:%pf", comma ? "," : "",
4649 task_pid_nr(worker->task),
4650 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4651 worker->current_func);
4652 list_for_each_entry(work, &worker->scheduled, entry)
4653 pr_cont_work(false, work);
4654 comma = true;
4655 }
4656 pr_cont("\n");
4657 }
4658
4659 list_for_each_entry(work, &pool->worklist, entry) {
4660 if (get_work_pwq(work) == pwq) {
4661 has_pending = true;
4662 break;
4663 }
4664 }
4665 if (has_pending) {
4666 bool comma = false;
4667
4668 pr_info(" pending:");
4669 list_for_each_entry(work, &pool->worklist, entry) {
4670 if (get_work_pwq(work) != pwq)
4671 continue;
4672
4673 pr_cont_work(comma, work);
4674 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4675 }
4676 pr_cont("\n");
4677 }
4678
4679 if (!list_empty(&pwq->delayed_works)) {
4680 bool comma = false;
4681
4682 pr_info(" delayed:");
4683 list_for_each_entry(work, &pwq->delayed_works, entry) {
4684 pr_cont_work(comma, work);
4685 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4686 }
4687 pr_cont("\n");
4688 }
4689}
4690
4691/**
4692 * show_workqueue_state - dump workqueue state
4693 *
Roger Lu7b776af2016-07-01 11:05:02 +08004694 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4695 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004696 */
4697void show_workqueue_state(void)
4698{
4699 struct workqueue_struct *wq;
4700 struct worker_pool *pool;
4701 unsigned long flags;
4702 int pi;
4703
4704 rcu_read_lock_sched();
4705
4706 pr_info("Showing busy workqueues and worker pools:\n");
4707
4708 list_for_each_entry_rcu(wq, &workqueues, list) {
4709 struct pool_workqueue *pwq;
4710 bool idle = true;
4711
4712 for_each_pwq(pwq, wq) {
4713 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4714 idle = false;
4715 break;
4716 }
4717 }
4718 if (idle)
4719 continue;
4720
4721 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4722
4723 for_each_pwq(pwq, wq) {
4724 spin_lock_irqsave(&pwq->pool->lock, flags);
4725 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4726 show_pwq(pwq);
4727 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004728 /*
4729 * We could be printing a lot from atomic context, e.g.
4730 * sysrq-t -> show_workqueue_state(). Avoid triggering
4731 * hard lockup.
4732 */
4733 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004734 }
4735 }
4736
4737 for_each_pool(pool, pi) {
4738 struct worker *worker;
4739 bool first = true;
4740
4741 spin_lock_irqsave(&pool->lock, flags);
4742 if (pool->nr_workers == pool->nr_idle)
4743 goto next_pool;
4744
4745 pr_info("pool %d:", pool->id);
4746 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004747 pr_cont(" hung=%us workers=%d",
4748 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4749 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004750 if (pool->manager)
4751 pr_cont(" manager: %d",
4752 task_pid_nr(pool->manager->task));
4753 list_for_each_entry(worker, &pool->idle_list, entry) {
4754 pr_cont(" %s%d", first ? "idle: " : "",
4755 task_pid_nr(worker->task));
4756 first = false;
4757 }
4758 pr_cont("\n");
4759 next_pool:
4760 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004761 /*
4762 * We could be printing a lot from atomic context, e.g.
4763 * sysrq-t -> show_workqueue_state(). Avoid triggering
4764 * hard lockup.
4765 */
4766 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004767 }
4768
4769 rcu_read_unlock_sched();
4770}
4771
Tejun Heo6b598082018-05-18 08:47:13 -07004772/* used to show worker information through /proc/PID/{comm,stat,status} */
4773void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4774{
Tejun Heo6b598082018-05-18 08:47:13 -07004775 int off;
4776
4777 /* always show the actual comm */
4778 off = strscpy(buf, task->comm, size);
4779 if (off < 0)
4780 return;
4781
Tejun Heo197f6ac2018-05-21 08:04:35 -07004782 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004783 mutex_lock(&wq_pool_attach_mutex);
4784
Tejun Heo197f6ac2018-05-21 08:04:35 -07004785 if (task->flags & PF_WQ_WORKER) {
4786 struct worker *worker = kthread_data(task);
4787 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004788
Tejun Heo197f6ac2018-05-21 08:04:35 -07004789 if (pool) {
4790 spin_lock_irq(&pool->lock);
4791 /*
4792 * ->desc tracks information (wq name or
4793 * set_worker_desc()) for the latest execution. If
4794 * current, prepend '+', otherwise '-'.
4795 */
4796 if (worker->desc[0] != '\0') {
4797 if (worker->current_work)
4798 scnprintf(buf + off, size - off, "+%s",
4799 worker->desc);
4800 else
4801 scnprintf(buf + off, size - off, "-%s",
4802 worker->desc);
4803 }
4804 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004805 }
Tejun Heo6b598082018-05-18 08:47:13 -07004806 }
4807
4808 mutex_unlock(&wq_pool_attach_mutex);
4809}
4810
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004811#ifdef CONFIG_SMP
4812
Tejun Heodb7bccf2010-06-29 10:07:12 +02004813/*
4814 * CPU hotplug.
4815 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004816 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004817 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004818 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004819 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004820 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004821 * blocked draining impractical.
4822 *
Tejun Heo24647572013-01-24 11:01:33 -08004823 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004824 * running as an unbound one and allowing it to be reattached later if the
4825 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004826 */
4827
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004828static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004829{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004830 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004831 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004832
Tejun Heof02ae732013-03-12 11:30:03 -07004833 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004834 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004835 spin_lock_irq(&pool->lock);
4836
4837 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004838 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004839 * unbound and set DISASSOCIATED. Before this, all workers
4840 * except for the ones which are still executing works from
4841 * before the last CPU down must be on the cpu. After
4842 * this, they may become diasporas.
4843 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004844 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004845 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004846
Tejun Heo24647572013-01-24 11:01:33 -08004847 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004848
Tejun Heo94cf58b2013-01-24 11:01:33 -08004849 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004850 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004851
Lai Jiangshaneb283422013-03-08 15:18:28 -08004852 /*
4853 * Call schedule() so that we cross rq->lock and thus can
4854 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4855 * This is necessary as scheduler callbacks may be invoked
4856 * from other cpus.
4857 */
4858 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004859
Lai Jiangshaneb283422013-03-08 15:18:28 -08004860 /*
4861 * Sched callbacks are disabled now. Zap nr_running.
4862 * After this, nr_running stays zero and need_more_worker()
4863 * and keep_working() are always true as long as the
4864 * worklist is not empty. This pool now behaves as an
4865 * unbound (in terms of concurrency management) pool which
4866 * are served by workers tied to the pool.
4867 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004868 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004869
4870 /*
4871 * With concurrency management just turned off, a busy
4872 * worker blocking could lead to lengthy stalls. Kick off
4873 * unbound chain execution of currently pending work items.
4874 */
4875 spin_lock_irq(&pool->lock);
4876 wake_up_worker(pool);
4877 spin_unlock_irq(&pool->lock);
4878 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004879}
4880
Tejun Heobd7c0892013-03-19 13:45:21 -07004881/**
4882 * rebind_workers - rebind all workers of a pool to the associated CPU
4883 * @pool: pool of interest
4884 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004885 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004886 */
4887static void rebind_workers(struct worker_pool *pool)
4888{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004889 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004890
Tejun Heo1258fae2018-05-18 08:47:13 -07004891 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004892
Tejun Heoa9ab7752013-03-19 13:45:21 -07004893 /*
4894 * Restore CPU affinity of all workers. As all idle workers should
4895 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304896 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004897 * of all workers first and then clear UNBOUND. As we're called
4898 * from CPU_ONLINE, the following shouldn't fail.
4899 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004900 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004901 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4902 pool->attrs->cpumask) < 0);
4903
4904 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004905
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004906 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004907
Lai Jiangshanda028462014-05-20 17:46:31 +08004908 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004909 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004910
4911 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004912 * A bound idle worker should actually be on the runqueue
4913 * of the associated CPU for local wake-ups targeting it to
4914 * work. Kick all idle workers so that they migrate to the
4915 * associated CPU. Doing this in the same loop as
4916 * replacing UNBOUND with REBOUND is safe as no worker will
4917 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004918 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004919 if (worker_flags & WORKER_IDLE)
4920 wake_up_process(worker->task);
4921
4922 /*
4923 * We want to clear UNBOUND but can't directly call
4924 * worker_clr_flags() or adjust nr_running. Atomically
4925 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4926 * @worker will clear REBOUND using worker_clr_flags() when
4927 * it initiates the next execution cycle thus restoring
4928 * concurrency management. Note that when or whether
4929 * @worker clears REBOUND doesn't affect correctness.
4930 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004931 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004932 * tested without holding any lock in
4933 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4934 * fail incorrectly leading to premature concurrency
4935 * management operations.
4936 */
4937 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4938 worker_flags |= WORKER_REBOUND;
4939 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004940 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004941 }
4942
Tejun Heoa9ab7752013-03-19 13:45:21 -07004943 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004944}
4945
Tejun Heo7dbc7252013-03-19 13:45:21 -07004946/**
4947 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4948 * @pool: unbound pool of interest
4949 * @cpu: the CPU which is coming up
4950 *
4951 * An unbound pool may end up with a cpumask which doesn't have any online
4952 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4953 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4954 * online CPU before, cpus_allowed of all its workers should be restored.
4955 */
4956static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4957{
4958 static cpumask_t cpumask;
4959 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004960
Tejun Heo1258fae2018-05-18 08:47:13 -07004961 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004962
4963 /* is @cpu allowed for @pool? */
4964 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4965 return;
4966
Tejun Heo7dbc7252013-03-19 13:45:21 -07004967 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004968
4969 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004970 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004971 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004972}
4973
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004974int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004975{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004976 struct worker_pool *pool;
4977
4978 for_each_cpu_worker_pool(pool, cpu) {
4979 if (pool->nr_workers)
4980 continue;
4981 if (!create_worker(pool))
4982 return -ENOMEM;
4983 }
4984 return 0;
4985}
4986
4987int workqueue_online_cpu(unsigned int cpu)
4988{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004989 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004990 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004991 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004992
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004993 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004994
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004995 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004996 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004997
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004998 if (pool->cpu == cpu)
4999 rebind_workers(pool);
5000 else if (pool->cpu < 0)
5001 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08005002
Tejun Heo1258fae2018-05-18 08:47:13 -07005003 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07005004 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005005
5006 /* update NUMA affinity of unbound workqueues */
5007 list_for_each_entry(wq, &workqueues, list)
5008 wq_update_unbound_numa(wq, cpu, true);
5009
5010 mutex_unlock(&wq_pool_mutex);
5011 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005012}
5013
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005014int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07005015{
Tejun Heo4c16bd32013-04-01 11:23:36 -07005016 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07005017
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005018 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08005019 if (WARN_ON(cpu != smp_processor_id()))
5020 return -1;
5021
5022 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005023
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005024 /* update NUMA affinity of unbound workqueues */
5025 mutex_lock(&wq_pool_mutex);
5026 list_for_each_entry(wq, &workqueues, list)
5027 wq_update_unbound_numa(wq, cpu, false);
5028 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07005029
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00005030 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07005031}
5032
Rusty Russell2d3854a2008-11-05 13:39:10 +11005033struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07005034 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11005035 long (*fn)(void *);
5036 void *arg;
5037 long ret;
5038};
5039
Tejun Heoed48ece2012-09-18 12:48:43 -07005040static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005041{
Tejun Heoed48ece2012-09-18 12:48:43 -07005042 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5043
Rusty Russell2d3854a2008-11-05 13:39:10 +11005044 wfc->ret = wfc->fn(wfc->arg);
5045}
5046
5047/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01005048 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11005049 * @cpu: the cpu to run on
5050 * @fn: the function to run
5051 * @arg: the function arg
5052 *
Rusty Russell31ad9082009-01-16 15:31:15 -08005053 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06005054 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07005055 *
5056 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11005057 */
Tejun Heod84ff052013-03-12 11:29:59 -07005058long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11005059{
Tejun Heoed48ece2012-09-18 12:48:43 -07005060 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11005061
Tejun Heoed48ece2012-09-18 12:48:43 -07005062 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5063 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07005064 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05005065 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005066 return wfc.ret;
5067}
5068EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02005069
5070/**
5071 * work_on_cpu_safe - run a function in thread context on a particular cpu
5072 * @cpu: the cpu to run on
5073 * @fn: the function to run
5074 * @arg: the function argument
5075 *
5076 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5077 * any locks which would prevent @fn from completing.
5078 *
5079 * Return: The value @fn returns.
5080 */
5081long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5082{
5083 long ret = -ENODEV;
5084
5085 get_online_cpus();
5086 if (cpu_online(cpu))
5087 ret = work_on_cpu(cpu, fn, arg);
5088 put_online_cpus();
5089 return ret;
5090}
5091EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11005092#endif /* CONFIG_SMP */
5093
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005094#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10305095
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005096/**
5097 * freeze_workqueues_begin - begin freezing workqueues
5098 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01005099 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07005100 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08005101 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005102 *
5103 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005104 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005105 */
5106void freeze_workqueues_begin(void)
5107{
Tejun Heo24b8a842013-03-12 11:29:58 -07005108 struct workqueue_struct *wq;
5109 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005110
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005111 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005112
Tejun Heo6183c002013-03-12 11:29:57 -07005113 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005114 workqueue_freezing = true;
5115
Tejun Heo24b8a842013-03-12 11:29:58 -07005116 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005117 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005118 for_each_pwq(pwq, wq)
5119 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005120 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07005121 }
Tejun Heo5bcab332013-03-13 19:47:40 -07005122
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005123 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005124}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005125
5126/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01005127 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005128 *
5129 * Check whether freezing is complete. This function must be called
5130 * between freeze_workqueues_begin() and thaw_workqueues().
5131 *
5132 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005133 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005134 *
Yacine Belkadid185af32013-07-31 14:59:24 -07005135 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01005136 * %true if some freezable workqueues are still busy. %false if freezing
5137 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005138 */
5139bool freeze_workqueues_busy(void)
5140{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005141 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07005142 struct workqueue_struct *wq;
5143 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005144
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005145 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005146
Tejun Heo6183c002013-03-12 11:29:57 -07005147 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005148
Tejun Heo24b8a842013-03-12 11:29:58 -07005149 list_for_each_entry(wq, &workqueues, list) {
5150 if (!(wq->flags & WQ_FREEZABLE))
5151 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005152 /*
5153 * nr_active is monotonically decreasing. It's safe
5154 * to peek without lock.
5155 */
Lai Jiangshan88109452013-03-20 03:28:10 +08005156 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07005157 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005158 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005159 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005160 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08005161 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005162 goto out_unlock;
5163 }
5164 }
Lai Jiangshan88109452013-03-20 03:28:10 +08005165 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005166 }
5167out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005168 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005169 return busy;
5170}
5171
5172/**
5173 * thaw_workqueues - thaw workqueues
5174 *
5175 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005176 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005177 *
5178 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005179 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005180 */
5181void thaw_workqueues(void)
5182{
Tejun Heo24b8a842013-03-12 11:29:58 -07005183 struct workqueue_struct *wq;
5184 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005185
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005186 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005187
5188 if (!workqueue_freezing)
5189 goto out_unlock;
5190
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005191 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005192
Tejun Heo24b8a842013-03-12 11:29:58 -07005193 /* restore max_active and repopulate worklist */
5194 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005195 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005196 for_each_pwq(pwq, wq)
5197 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005198 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005199 }
5200
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005201out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005202 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005203}
5204#endif /* CONFIG_FREEZER */
5205
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005206static int workqueue_apply_unbound_cpumask(void)
5207{
5208 LIST_HEAD(ctxs);
5209 int ret = 0;
5210 struct workqueue_struct *wq;
5211 struct apply_wqattrs_ctx *ctx, *n;
5212
5213 lockdep_assert_held(&wq_pool_mutex);
5214
5215 list_for_each_entry(wq, &workqueues, list) {
5216 if (!(wq->flags & WQ_UNBOUND))
5217 continue;
5218 /* creating multiple pwqs breaks ordering guarantee */
5219 if (wq->flags & __WQ_ORDERED)
5220 continue;
5221
5222 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5223 if (!ctx) {
5224 ret = -ENOMEM;
5225 break;
5226 }
5227
5228 list_add_tail(&ctx->list, &ctxs);
5229 }
5230
5231 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5232 if (!ret)
5233 apply_wqattrs_commit(ctx);
5234 apply_wqattrs_cleanup(ctx);
5235 }
5236
5237 return ret;
5238}
5239
5240/**
5241 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5242 * @cpumask: the cpumask to set
5243 *
5244 * The low-level workqueues cpumask is a global cpumask that limits
5245 * the affinity of all unbound workqueues. This function check the @cpumask
5246 * and apply it to all unbound workqueues and updates all pwqs of them.
5247 *
5248 * Retun: 0 - Success
5249 * -EINVAL - Invalid @cpumask
5250 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5251 */
5252int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5253{
5254 int ret = -EINVAL;
5255 cpumask_var_t saved_cpumask;
5256
5257 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5258 return -ENOMEM;
5259
Tal Shorerc98a9802017-11-03 17:27:50 +02005260 /*
5261 * Not excluding isolated cpus on purpose.
5262 * If the user wishes to include them, we allow that.
5263 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005264 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5265 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005266 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005267
5268 /* save the old wq_unbound_cpumask. */
5269 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5270
5271 /* update wq_unbound_cpumask at first and apply it to wqs. */
5272 cpumask_copy(wq_unbound_cpumask, cpumask);
5273 ret = workqueue_apply_unbound_cpumask();
5274
5275 /* restore the wq_unbound_cpumask when failed. */
5276 if (ret < 0)
5277 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5278
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005279 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005280 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005281
5282 free_cpumask_var(saved_cpumask);
5283 return ret;
5284}
5285
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005286#ifdef CONFIG_SYSFS
5287/*
5288 * Workqueues with WQ_SYSFS flag set is visible to userland via
5289 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5290 * following attributes.
5291 *
5292 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5293 * max_active RW int : maximum number of in-flight work items
5294 *
5295 * Unbound workqueues have the following extra attributes.
5296 *
Wang Long9a19b462017-11-02 23:05:12 -04005297 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005298 * nice RW int : nice value of the workers
5299 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005300 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005301 */
5302struct wq_device {
5303 struct workqueue_struct *wq;
5304 struct device dev;
5305};
5306
5307static struct workqueue_struct *dev_to_wq(struct device *dev)
5308{
5309 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5310
5311 return wq_dev->wq;
5312}
5313
5314static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5315 char *buf)
5316{
5317 struct workqueue_struct *wq = dev_to_wq(dev);
5318
5319 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5320}
5321static DEVICE_ATTR_RO(per_cpu);
5322
5323static ssize_t max_active_show(struct device *dev,
5324 struct device_attribute *attr, char *buf)
5325{
5326 struct workqueue_struct *wq = dev_to_wq(dev);
5327
5328 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5329}
5330
5331static ssize_t max_active_store(struct device *dev,
5332 struct device_attribute *attr, const char *buf,
5333 size_t count)
5334{
5335 struct workqueue_struct *wq = dev_to_wq(dev);
5336 int val;
5337
5338 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5339 return -EINVAL;
5340
5341 workqueue_set_max_active(wq, val);
5342 return count;
5343}
5344static DEVICE_ATTR_RW(max_active);
5345
5346static struct attribute *wq_sysfs_attrs[] = {
5347 &dev_attr_per_cpu.attr,
5348 &dev_attr_max_active.attr,
5349 NULL,
5350};
5351ATTRIBUTE_GROUPS(wq_sysfs);
5352
5353static ssize_t wq_pool_ids_show(struct device *dev,
5354 struct device_attribute *attr, char *buf)
5355{
5356 struct workqueue_struct *wq = dev_to_wq(dev);
5357 const char *delim = "";
5358 int node, written = 0;
5359
5360 rcu_read_lock_sched();
5361 for_each_node(node) {
5362 written += scnprintf(buf + written, PAGE_SIZE - written,
5363 "%s%d:%d", delim, node,
5364 unbound_pwq_by_node(wq, node)->pool->id);
5365 delim = " ";
5366 }
5367 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5368 rcu_read_unlock_sched();
5369
5370 return written;
5371}
5372
5373static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5374 char *buf)
5375{
5376 struct workqueue_struct *wq = dev_to_wq(dev);
5377 int written;
5378
5379 mutex_lock(&wq->mutex);
5380 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5381 mutex_unlock(&wq->mutex);
5382
5383 return written;
5384}
5385
5386/* prepare workqueue_attrs for sysfs store operations */
5387static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5388{
5389 struct workqueue_attrs *attrs;
5390
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005391 lockdep_assert_held(&wq_pool_mutex);
5392
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005393 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5394 if (!attrs)
5395 return NULL;
5396
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005397 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005398 return attrs;
5399}
5400
5401static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5402 const char *buf, size_t count)
5403{
5404 struct workqueue_struct *wq = dev_to_wq(dev);
5405 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005406 int ret = -ENOMEM;
5407
5408 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005409
5410 attrs = wq_sysfs_prep_attrs(wq);
5411 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005412 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005413
5414 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5415 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005416 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005417 else
5418 ret = -EINVAL;
5419
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005420out_unlock:
5421 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005422 free_workqueue_attrs(attrs);
5423 return ret ?: count;
5424}
5425
5426static ssize_t wq_cpumask_show(struct device *dev,
5427 struct device_attribute *attr, char *buf)
5428{
5429 struct workqueue_struct *wq = dev_to_wq(dev);
5430 int written;
5431
5432 mutex_lock(&wq->mutex);
5433 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5434 cpumask_pr_args(wq->unbound_attrs->cpumask));
5435 mutex_unlock(&wq->mutex);
5436 return written;
5437}
5438
5439static ssize_t wq_cpumask_store(struct device *dev,
5440 struct device_attribute *attr,
5441 const char *buf, size_t count)
5442{
5443 struct workqueue_struct *wq = dev_to_wq(dev);
5444 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005445 int ret = -ENOMEM;
5446
5447 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005448
5449 attrs = wq_sysfs_prep_attrs(wq);
5450 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005451 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005452
5453 ret = cpumask_parse(buf, attrs->cpumask);
5454 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005455 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005456
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005457out_unlock:
5458 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005459 free_workqueue_attrs(attrs);
5460 return ret ?: count;
5461}
5462
5463static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5464 char *buf)
5465{
5466 struct workqueue_struct *wq = dev_to_wq(dev);
5467 int written;
5468
5469 mutex_lock(&wq->mutex);
5470 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5471 !wq->unbound_attrs->no_numa);
5472 mutex_unlock(&wq->mutex);
5473
5474 return written;
5475}
5476
5477static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5478 const char *buf, size_t count)
5479{
5480 struct workqueue_struct *wq = dev_to_wq(dev);
5481 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005482 int v, ret = -ENOMEM;
5483
5484 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005485
5486 attrs = wq_sysfs_prep_attrs(wq);
5487 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005488 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005489
5490 ret = -EINVAL;
5491 if (sscanf(buf, "%d", &v) == 1) {
5492 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005493 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005494 }
5495
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005496out_unlock:
5497 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005498 free_workqueue_attrs(attrs);
5499 return ret ?: count;
5500}
5501
5502static struct device_attribute wq_sysfs_unbound_attrs[] = {
5503 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5504 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5505 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5506 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5507 __ATTR_NULL,
5508};
5509
5510static struct bus_type wq_subsys = {
5511 .name = "workqueue",
5512 .dev_groups = wq_sysfs_groups,
5513};
5514
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005515static ssize_t wq_unbound_cpumask_show(struct device *dev,
5516 struct device_attribute *attr, char *buf)
5517{
5518 int written;
5519
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005520 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005521 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5522 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005523 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005524
5525 return written;
5526}
5527
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005528static ssize_t wq_unbound_cpumask_store(struct device *dev,
5529 struct device_attribute *attr, const char *buf, size_t count)
5530{
5531 cpumask_var_t cpumask;
5532 int ret;
5533
5534 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5535 return -ENOMEM;
5536
5537 ret = cpumask_parse(buf, cpumask);
5538 if (!ret)
5539 ret = workqueue_set_unbound_cpumask(cpumask);
5540
5541 free_cpumask_var(cpumask);
5542 return ret ? ret : count;
5543}
5544
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005545static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005546 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5547 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005548
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005549static int __init wq_sysfs_init(void)
5550{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005551 int err;
5552
5553 err = subsys_virtual_register(&wq_subsys, NULL);
5554 if (err)
5555 return err;
5556
5557 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005558}
5559core_initcall(wq_sysfs_init);
5560
5561static void wq_device_release(struct device *dev)
5562{
5563 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5564
5565 kfree(wq_dev);
5566}
5567
5568/**
5569 * workqueue_sysfs_register - make a workqueue visible in sysfs
5570 * @wq: the workqueue to register
5571 *
5572 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5573 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5574 * which is the preferred method.
5575 *
5576 * Workqueue user should use this function directly iff it wants to apply
5577 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5578 * apply_workqueue_attrs() may race against userland updating the
5579 * attributes.
5580 *
5581 * Return: 0 on success, -errno on failure.
5582 */
5583int workqueue_sysfs_register(struct workqueue_struct *wq)
5584{
5585 struct wq_device *wq_dev;
5586 int ret;
5587
5588 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305589 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005590 * attributes breaks ordering guarantee. Disallow exposing ordered
5591 * workqueues.
5592 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005593 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005594 return -EINVAL;
5595
5596 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5597 if (!wq_dev)
5598 return -ENOMEM;
5599
5600 wq_dev->wq = wq;
5601 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005602 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005603 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005604
5605 /*
5606 * unbound_attrs are created separately. Suppress uevent until
5607 * everything is ready.
5608 */
5609 dev_set_uevent_suppress(&wq_dev->dev, true);
5610
5611 ret = device_register(&wq_dev->dev);
5612 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305613 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005614 wq->wq_dev = NULL;
5615 return ret;
5616 }
5617
5618 if (wq->flags & WQ_UNBOUND) {
5619 struct device_attribute *attr;
5620
5621 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5622 ret = device_create_file(&wq_dev->dev, attr);
5623 if (ret) {
5624 device_unregister(&wq_dev->dev);
5625 wq->wq_dev = NULL;
5626 return ret;
5627 }
5628 }
5629 }
5630
5631 dev_set_uevent_suppress(&wq_dev->dev, false);
5632 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5633 return 0;
5634}
5635
5636/**
5637 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5638 * @wq: the workqueue to unregister
5639 *
5640 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5641 */
5642static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5643{
5644 struct wq_device *wq_dev = wq->wq_dev;
5645
5646 if (!wq->wq_dev)
5647 return;
5648
5649 wq->wq_dev = NULL;
5650 device_unregister(&wq_dev->dev);
5651}
5652#else /* CONFIG_SYSFS */
5653static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5654#endif /* CONFIG_SYSFS */
5655
Tejun Heo82607adc2015-12-08 11:28:04 -05005656/*
5657 * Workqueue watchdog.
5658 *
5659 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5660 * flush dependency, a concurrency managed work item which stays RUNNING
5661 * indefinitely. Workqueue stalls can be very difficult to debug as the
5662 * usual warning mechanisms don't trigger and internal workqueue state is
5663 * largely opaque.
5664 *
5665 * Workqueue watchdog monitors all worker pools periodically and dumps
5666 * state if some pools failed to make forward progress for a while where
5667 * forward progress is defined as the first item on ->worklist changing.
5668 *
5669 * This mechanism is controlled through the kernel parameter
5670 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5671 * corresponding sysfs parameter file.
5672 */
5673#ifdef CONFIG_WQ_WATCHDOG
5674
Tejun Heo82607adc2015-12-08 11:28:04 -05005675static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005676static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005677
5678static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5679static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5680
5681static void wq_watchdog_reset_touched(void)
5682{
5683 int cpu;
5684
5685 wq_watchdog_touched = jiffies;
5686 for_each_possible_cpu(cpu)
5687 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5688}
5689
Kees Cook5cd79d62017-10-04 16:27:00 -07005690static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005691{
5692 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5693 bool lockup_detected = false;
5694 struct worker_pool *pool;
5695 int pi;
5696
5697 if (!thresh)
5698 return;
5699
5700 rcu_read_lock();
5701
5702 for_each_pool(pool, pi) {
5703 unsigned long pool_ts, touched, ts;
5704
5705 if (list_empty(&pool->worklist))
5706 continue;
5707
5708 /* get the latest of pool and touched timestamps */
5709 pool_ts = READ_ONCE(pool->watchdog_ts);
5710 touched = READ_ONCE(wq_watchdog_touched);
5711
5712 if (time_after(pool_ts, touched))
5713 ts = pool_ts;
5714 else
5715 ts = touched;
5716
5717 if (pool->cpu >= 0) {
5718 unsigned long cpu_touched =
5719 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5720 pool->cpu));
5721 if (time_after(cpu_touched, ts))
5722 ts = cpu_touched;
5723 }
5724
5725 /* did we stall? */
5726 if (time_after(jiffies, ts + thresh)) {
5727 lockup_detected = true;
5728 pr_emerg("BUG: workqueue lockup - pool");
5729 pr_cont_pool_info(pool);
5730 pr_cont(" stuck for %us!\n",
5731 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5732 }
5733 }
5734
5735 rcu_read_unlock();
5736
5737 if (lockup_detected)
5738 show_workqueue_state();
5739
5740 wq_watchdog_reset_touched();
5741 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5742}
5743
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005744notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005745{
5746 if (cpu >= 0)
5747 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5748 else
5749 wq_watchdog_touched = jiffies;
5750}
5751
5752static void wq_watchdog_set_thresh(unsigned long thresh)
5753{
5754 wq_watchdog_thresh = 0;
5755 del_timer_sync(&wq_watchdog_timer);
5756
5757 if (thresh) {
5758 wq_watchdog_thresh = thresh;
5759 wq_watchdog_reset_touched();
5760 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5761 }
5762}
5763
5764static int wq_watchdog_param_set_thresh(const char *val,
5765 const struct kernel_param *kp)
5766{
5767 unsigned long thresh;
5768 int ret;
5769
5770 ret = kstrtoul(val, 0, &thresh);
5771 if (ret)
5772 return ret;
5773
5774 if (system_wq)
5775 wq_watchdog_set_thresh(thresh);
5776 else
5777 wq_watchdog_thresh = thresh;
5778
5779 return 0;
5780}
5781
5782static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5783 .set = wq_watchdog_param_set_thresh,
5784 .get = param_get_ulong,
5785};
5786
5787module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5788 0644);
5789
5790static void wq_watchdog_init(void)
5791{
Kees Cook5cd79d62017-10-04 16:27:00 -07005792 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005793 wq_watchdog_set_thresh(wq_watchdog_thresh);
5794}
5795
5796#else /* CONFIG_WQ_WATCHDOG */
5797
5798static inline void wq_watchdog_init(void) { }
5799
5800#endif /* CONFIG_WQ_WATCHDOG */
5801
Tejun Heobce90382013-04-01 11:23:32 -07005802static void __init wq_numa_init(void)
5803{
5804 cpumask_var_t *tbl;
5805 int node, cpu;
5806
Tejun Heobce90382013-04-01 11:23:32 -07005807 if (num_possible_nodes() <= 1)
5808 return;
5809
Tejun Heod55262c2013-04-01 11:23:38 -07005810 if (wq_disable_numa) {
5811 pr_info("workqueue: NUMA affinity support disabled\n");
5812 return;
5813 }
5814
Tejun Heo4c16bd32013-04-01 11:23:36 -07005815 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5816 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5817
Tejun Heobce90382013-04-01 11:23:32 -07005818 /*
5819 * We want masks of possible CPUs of each node which isn't readily
5820 * available. Build one from cpu_to_node() which should have been
5821 * fully initialized by now.
5822 */
Kees Cook6396bb22018-06-12 14:03:40 -07005823 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005824 BUG_ON(!tbl);
5825
5826 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005827 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005828 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005829
5830 for_each_possible_cpu(cpu) {
5831 node = cpu_to_node(cpu);
5832 if (WARN_ON(node == NUMA_NO_NODE)) {
5833 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5834 /* happens iff arch is bonkers, let's just proceed */
5835 return;
5836 }
5837 cpumask_set_cpu(cpu, tbl[node]);
5838 }
5839
5840 wq_numa_possible_cpumask = tbl;
5841 wq_numa_enabled = true;
5842}
5843
Tejun Heo3347fa02016-09-16 15:49:32 -04005844/**
5845 * workqueue_init_early - early init for workqueue subsystem
5846 *
5847 * This is the first half of two-staged workqueue subsystem initialization
5848 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5849 * idr are up. It sets up all the data structures and system workqueues
5850 * and allows early boot code to create workqueues and queue/cancel work
5851 * items. Actual work item execution starts only after kthreads can be
5852 * created and scheduled right before early initcalls.
5853 */
5854int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005855{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005856 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005857 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005858 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005859
Tejun Heoe904e6c2013-03-12 11:29:57 -07005860 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5861
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005862 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005863 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005864
Tejun Heoe904e6c2013-03-12 11:29:57 -07005865 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5866
Tejun Heo706026c2013-01-24 11:01:34 -08005867 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005868 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005869 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005870
Tejun Heo7a4e3442013-03-12 11:30:00 -07005871 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005872 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005873 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005874 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005875 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005876 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005877 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005878
Tejun Heo9daf9e62013-01-24 11:01:33 -08005879 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005880 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005881 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005882 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005883 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005884 }
5885
Tejun Heo8a2b7532013-09-05 12:30:04 -04005886 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005887 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5888 struct workqueue_attrs *attrs;
5889
5890 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005891 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005892 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005893
5894 /*
5895 * An ordered wq should have only one pwq as ordering is
5896 * guaranteed by max_active which is enforced by pwqs.
5897 * Turn off NUMA so that dfl_pwq is used for all nodes.
5898 */
5899 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5900 attrs->nice = std_nice[i];
5901 attrs->no_numa = true;
5902 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005903 }
5904
Tejun Heod320c032010-06-29 10:07:14 +02005905 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005906 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005907 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005908 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5909 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005910 system_freezable_wq = alloc_workqueue("events_freezable",
5911 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305912 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5913 WQ_POWER_EFFICIENT, 0);
5914 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5915 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5916 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005917 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305918 !system_unbound_wq || !system_freezable_wq ||
5919 !system_power_efficient_wq ||
5920 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005921
Tejun Heo3347fa02016-09-16 15:49:32 -04005922 return 0;
5923}
5924
5925/**
5926 * workqueue_init - bring workqueue subsystem fully online
5927 *
5928 * This is the latter half of two-staged workqueue subsystem initialization
5929 * and invoked as soon as kthreads can be created and scheduled.
5930 * Workqueues have been created and work items queued on them, but there
5931 * are no kworkers executing the work items yet. Populate the worker pools
5932 * with the initial workers and enable future kworker creations.
5933 */
5934int __init workqueue_init(void)
5935{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005936 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005937 struct worker_pool *pool;
5938 int cpu, bkt;
5939
Tejun Heo2186d9f2016-10-19 12:01:27 -04005940 /*
5941 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5942 * CPU to node mapping may not be available that early on some
5943 * archs such as power and arm64. As per-cpu pools created
5944 * previously could be missing node hint and unbound pools NUMA
5945 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005946 *
5947 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005948 */
5949 wq_numa_init();
5950
5951 mutex_lock(&wq_pool_mutex);
5952
5953 for_each_possible_cpu(cpu) {
5954 for_each_cpu_worker_pool(pool, cpu) {
5955 pool->node = cpu_to_node(cpu);
5956 }
5957 }
5958
Tejun Heo40c17f72018-01-08 05:38:37 -08005959 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005960 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005961 WARN(init_rescuer(wq),
5962 "workqueue: failed to create early rescuer for %s",
5963 wq->name);
5964 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005965
5966 mutex_unlock(&wq_pool_mutex);
5967
Tejun Heo3347fa02016-09-16 15:49:32 -04005968 /* create the initial workers */
5969 for_each_online_cpu(cpu) {
5970 for_each_cpu_worker_pool(pool, cpu) {
5971 pool->flags &= ~POOL_DISASSOCIATED;
5972 BUG_ON(!create_worker(pool));
5973 }
5974 }
5975
5976 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5977 BUG_ON(!create_worker(pool));
5978
5979 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005980 wq_watchdog_init();
5981
Suresh Siddha6ee05782010-07-30 14:57:37 -07005982 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005983}