blob: 48a4d00f55dc80a24554a526ae33d15149302da0 [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/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020051#include <linux/sched/isolation.h>
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
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080069 * 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 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800126 * A: 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 */
156 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700157
158 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159 int nr_idle; /* L: currently idle ones */
160
161 struct list_head idle_list; /* X: list of idle workers */
162 struct timer_list idle_timer; /* L: worker idle timeout */
163 struct timer_list mayday_timer; /* L: SOS timer for workers */
164
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700165 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800166 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
167 /* L: hash of busy workers */
168
Tejun Heobc3a1af2013-03-13 19:47:39 -0700169 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400170 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800171 struct mutex attach_mutex; /* attach/detach exclusion */
172 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800173 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800174
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800175 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800176
Tejun Heo7a4e3442013-03-12 11:30:00 -0700177 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700178 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
179 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700180
Tejun Heoe19e3972013-01-24 11:39:44 -0800181 /*
182 * The current concurrency level. As it's likely to be accessed
183 * from other CPUs during try_to_wake_up(), put it in a separate
184 * cacheline.
185 */
186 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700187
188 /*
189 * Destruction of pool is sched-RCU protected to allow dereferences
190 * from get_work_pool().
191 */
192 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200193} ____cacheline_aligned_in_smp;
194
195/*
Tejun Heo112202d2013-02-13 19:29:12 -0800196 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
197 * of work_struct->data are used for flags and the remaining high bits
198 * point to the pwq; thus, pwqs need to be aligned at two's power of the
199 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 */
Tejun Heo112202d2013-02-13 19:29:12 -0800201struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700202 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200203 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 int work_color; /* L: current color */
205 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700206 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200207 int nr_in_flight[WORK_NR_COLORS];
208 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200209 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200210 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200211 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700212 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700213 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700214
215 /*
216 * Release of unbound pwq is punted to system_wq. See put_pwq()
217 * and pwq_unbound_release_workfn() for details. pool_workqueue
218 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700219 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700220 */
221 struct work_struct unbound_release_work;
222 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700223} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200226 * Structure used to wait for workqueue flush.
227 */
228struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700229 struct list_head list; /* WQ: list of flushers */
230 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200231 struct completion done; /* flush completion */
232};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Tejun Heo226223a2013-03-12 11:30:05 -0700234struct wq_device;
235
Tejun Heo73f53c42010-06-29 10:07:11 +0200236/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700237 * The externally visible workqueue. It relays the issued work items to
238 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 */
240struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400242 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200243
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700244 struct mutex mutex; /* protects this wq */
245 int work_color; /* WQ: current work color */
246 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800247 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700248 struct wq_flusher *first_flusher; /* WQ: first flusher */
249 struct list_head flusher_queue; /* WQ: flush waiters */
250 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200251
Tejun Heo2e109a22013-03-13 19:47:40 -0700252 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200253 struct worker *rescuer; /* I: rescue worker */
254
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700255 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700256 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700257
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800258 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
259 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700260
Tejun Heo226223a2013-03-12 11:30:05 -0700261#ifdef CONFIG_SYSFS
262 struct wq_device *wq_dev; /* I: for sysfs interface */
263#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700264#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200265 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700266#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700267 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700268
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400269 /*
270 * Destruction of workqueue_struct is sched-RCU protected to allow
271 * walking the workqueues list without grabbing wq_pool_mutex.
272 * This is used to dump all workqueues from sysrq.
273 */
274 struct rcu_head rcu;
275
Tejun Heo2728fd22013-04-01 11:23:35 -0700276 /* hot fields used during command issue, aligned to cacheline */
277 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
278 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800279 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280};
281
Tejun Heoe904e6c2013-03-12 11:29:57 -0700282static struct kmem_cache *pwq_cache;
283
Tejun Heobce90382013-04-01 11:23:32 -0700284static cpumask_var_t *wq_numa_possible_cpumask;
285 /* possible CPUs of each node */
286
Tejun Heod55262c2013-04-01 11:23:38 -0700287static bool wq_disable_numa;
288module_param_named(disable_numa, wq_disable_numa, bool, 0444);
289
Viresh Kumarcee22a12013-04-08 16:45:40 +0530290/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930291static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530292module_param_named(power_efficient, wq_power_efficient, bool, 0444);
293
Tejun Heo863b7102016-09-16 15:49:34 -0400294static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400295
Tejun Heobce90382013-04-01 11:23:32 -0700296static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
297
Tejun Heo4c16bd32013-04-01 11:23:36 -0700298/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
299static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
300
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700301static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun 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 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800404 * This must be called with @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) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800411 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700412 else
413
414/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700415 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
416 * @pwq: iteration cursor
417 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700418 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700419 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18bc2013-03-13 19:47:40 -0700420 * If the pwq needs to be used beyond the locking in effect, the caller is
421 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700422 *
423 * The if/else clause exists only for the lockdep assertion and can be
424 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700425 */
426#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700427 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700428 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700429 else
Tejun Heof3421792010-07-02 10:03:51 +0200430
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900431#ifdef CONFIG_DEBUG_OBJECTS_WORK
432
433static struct debug_obj_descr work_debug_descr;
434
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100435static void *work_debug_hint(void *addr)
436{
437 return ((struct work_struct *) addr)->func;
438}
439
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700440static bool work_is_static_object(void *addr)
441{
442 struct work_struct *work = addr;
443
444 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
445}
446
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900447/*
448 * fixup_init is called when:
449 * - an active object is initialized
450 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700451static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900452{
453 struct work_struct *work = addr;
454
455 switch (state) {
456 case ODEBUG_STATE_ACTIVE:
457 cancel_work_sync(work);
458 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700459 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900460 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700461 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462 }
463}
464
465/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900466 * fixup_free is called when:
467 * - an active object is freed
468 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700469static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900470{
471 struct work_struct *work = addr;
472
473 switch (state) {
474 case ODEBUG_STATE_ACTIVE:
475 cancel_work_sync(work);
476 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700479 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900480 }
481}
482
483static struct debug_obj_descr work_debug_descr = {
484 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100485 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700486 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900487 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900488 .fixup_free = work_fixup_free,
489};
490
491static inline void debug_work_activate(struct work_struct *work)
492{
493 debug_object_activate(work, &work_debug_descr);
494}
495
496static inline void debug_work_deactivate(struct work_struct *work)
497{
498 debug_object_deactivate(work, &work_debug_descr);
499}
500
501void __init_work(struct work_struct *work, int onstack)
502{
503 if (onstack)
504 debug_object_init_on_stack(work, &work_debug_descr);
505 else
506 debug_object_init(work, &work_debug_descr);
507}
508EXPORT_SYMBOL_GPL(__init_work);
509
510void destroy_work_on_stack(struct work_struct *work)
511{
512 debug_object_free(work, &work_debug_descr);
513}
514EXPORT_SYMBOL_GPL(destroy_work_on_stack);
515
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000516void destroy_delayed_work_on_stack(struct delayed_work *work)
517{
518 destroy_timer_on_stack(&work->timer);
519 debug_object_free(&work->work, &work_debug_descr);
520}
521EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
522
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900523#else
524static inline void debug_work_activate(struct work_struct *work) { }
525static inline void debug_work_deactivate(struct work_struct *work) { }
526#endif
527
Li Bin4e8b22b2013-09-10 09:52:35 +0800528/**
529 * worker_pool_assign_id - allocate ID and assing it to @pool
530 * @pool: the pool pointer of interest
531 *
532 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
533 * successfully, -errno on failure.
534 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800535static int worker_pool_assign_id(struct worker_pool *pool)
536{
537 int ret;
538
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700539 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700540
Li Bin4e8b22b2013-09-10 09:52:35 +0800541 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
542 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700543 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700544 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700545 return 0;
546 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800547 return ret;
548}
549
Tejun Heo76af4d92013-03-12 11:30:00 -0700550/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700551 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
552 * @wq: the target workqueue
553 * @node: the node ID
554 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800555 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
556 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700557 * If the pwq needs to be used beyond the locking in effect, the caller is
558 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700559 *
560 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700561 */
562static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563 int node)
564{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800565 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500566
567 /*
568 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
569 * delayed item is pending. The plan is to keep CPU -> NODE
570 * mapping valid and stable across CPU on/offlines. Once that
571 * happens, this workaround can be removed.
572 */
573 if (unlikely(node == NUMA_NO_NODE))
574 return wq->dfl_pwq;
575
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700576 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
577}
578
Tejun Heo73f53c42010-06-29 10:07:11 +0200579static unsigned int work_color_to_flags(int color)
580{
581 return color << WORK_STRUCT_COLOR_SHIFT;
582}
583
584static int get_work_color(struct work_struct *work)
585{
586 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
587 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
588}
589
590static int work_next_color(int color)
591{
592 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700593}
594
David Howells4594bf12006-12-07 11:33:26 +0000595/*
Tejun Heo112202d2013-02-13 19:29:12 -0800596 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
597 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800598 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 *
Tejun Heo112202d2013-02-13 19:29:12 -0800600 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
601 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700602 * work->data. These functions should only be called while the work is
603 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604 *
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800607 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700609 *
610 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
611 * canceled. While being canceled, a work item may have its PENDING set
612 * but stay off timer and worklist for arbitrarily long and nobody should
613 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000614 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200615static inline void set_work_data(struct work_struct *work, unsigned long data,
616 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000617{
Tejun Heo6183c002013-03-12 11:29:57 -0700618 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200619 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000620}
David Howells365970a2006-11-22 14:54:49 +0000621
Tejun Heo112202d2013-02-13 19:29:12 -0800622static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200623 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200624{
Tejun Heo112202d2013-02-13 19:29:12 -0800625 set_work_data(work, (unsigned long)pwq,
626 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200627}
628
Lai Jiangshan4468a002013-02-06 18:04:53 -0800629static void set_work_pool_and_keep_pending(struct work_struct *work,
630 int pool_id)
631{
632 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
633 WORK_STRUCT_PENDING);
634}
635
Tejun Heo7c3eed52013-01-24 11:01:33 -0800636static void set_work_pool_and_clear_pending(struct work_struct *work,
637 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000638{
Tejun Heo23657bb2012-08-13 17:08:19 -0700639 /*
640 * The following wmb is paired with the implied mb in
641 * test_and_set_bit(PENDING) and ensures all updates to @work made
642 * here are visible to and precede any updates by the next PENDING
643 * owner.
644 */
645 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800646 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200647 /*
648 * The following mb guarantees that previous clear of a PENDING bit
649 * will not be reordered with any speculative LOADS or STORES from
650 * work->current_func, which is executed afterwards. This possible
651 * reordering can lead to a missed execution on attempt to qeueue
652 * the same @work. E.g. consider this case:
653 *
654 * CPU#0 CPU#1
655 * ---------------------------- --------------------------------
656 *
657 * 1 STORE event_indicated
658 * 2 queue_work_on() {
659 * 3 test_and_set_bit(PENDING)
660 * 4 } set_..._and_clear_pending() {
661 * 5 set_work_data() # clear bit
662 * 6 smp_mb()
663 * 7 work->current_func() {
664 * 8 LOAD event_indicated
665 * }
666 *
667 * Without an explicit full barrier speculative LOAD on line 8 can
668 * be executed before CPU#0 does STORE on line 1. If that happens,
669 * CPU#0 observes the PENDING bit is still set and new execution of
670 * a @work is not queued in a hope, that CPU#1 will eventually
671 * finish the queued @work. Meanwhile CPU#1 does not see
672 * event_indicated is set, because speculative LOAD was executed
673 * before actual STORE.
674 */
675 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200676}
677
678static void clear_work_data(struct work_struct *work)
679{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800680 smp_wmb(); /* see set_work_pool_and_clear_pending() */
681 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200682}
683
Tejun Heo112202d2013-02-13 19:29:12 -0800684static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685{
Tejun Heoe1201532010-07-22 14:14:25 +0200686 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200687
Tejun Heo112202d2013-02-13 19:29:12 -0800688 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200689 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
690 else
691 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200692}
693
Tejun Heo7c3eed52013-01-24 11:01:33 -0800694/**
695 * get_work_pool - return the worker_pool a given work was associated with
696 * @work: the work item of interest
697 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700698 * Pools are created and destroyed under wq_pool_mutex, and allows read
699 * access under sched-RCU read lock. As such, this function should be
700 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700701 *
702 * All fields of the returned pool are accessible as long as the above
703 * mentioned locking is in effect. If the returned pool needs to be used
704 * beyond the critical section, the caller is responsible for ensuring the
705 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700706 *
707 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800708 */
709static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200710{
Tejun Heoe1201532010-07-22 14:14:25 +0200711 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800712 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200713
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700714 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700715
Tejun Heo112202d2013-02-13 19:29:12 -0800716 if (data & WORK_STRUCT_PWQ)
717 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800718 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200719
Tejun Heo7c3eed52013-01-24 11:01:33 -0800720 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
721 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200722 return NULL;
723
Tejun Heofa1b54e2013-03-12 11:30:00 -0700724 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800725}
726
727/**
728 * get_work_pool_id - return the worker pool ID a given work is associated with
729 * @work: the work item of interest
730 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700731 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800732 * %WORK_OFFQ_POOL_NONE if none.
733 */
734static int get_work_pool_id(struct work_struct *work)
735{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800736 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800737
Tejun Heo112202d2013-02-13 19:29:12 -0800738 if (data & WORK_STRUCT_PWQ)
739 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800740 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
741
742 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800743}
744
Tejun Heobbb68df2012-08-03 10:30:46 -0700745static void mark_work_canceling(struct work_struct *work)
746{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700748
Tejun Heo7c3eed52013-01-24 11:01:33 -0800749 pool_id <<= WORK_OFFQ_POOL_SHIFT;
750 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700751}
752
753static bool work_is_canceling(struct work_struct *work)
754{
755 unsigned long data = atomic_long_read(&work->data);
756
Tejun Heo112202d2013-02-13 19:29:12 -0800757 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700758}
759
David Howells365970a2006-11-22 14:54:49 +0000760/*
Tejun Heo32704762012-07-13 22:16:45 -0700761 * Policy functions. These define the policies on how the global worker
762 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800763 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000764 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200765
Tejun Heo63d95a92012-07-12 14:46:37 -0700766static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000767{
Tejun Heoe19e3972013-01-24 11:39:44 -0800768 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000769}
770
Tejun Heoe22bee72010-06-29 10:07:14 +0200771/*
772 * Need to wake up a worker? Called from anything but currently
773 * running workers.
Tejun Heo974271c42012-07-12 14:46:37 -0700774 *
775 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800776 * function will always return %true for unbound pools as long as the
Tejun Heo974271c42012-07-12 14:46:37 -0700777 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200778 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700779static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000780{
Tejun Heo63d95a92012-07-12 14:46:37 -0700781 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000782}
783
Tejun Heoe22bee72010-06-29 10:07:14 +0200784/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700785static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200786{
Tejun Heo63d95a92012-07-12 14:46:37 -0700787 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200788}
789
790/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700791static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200792{
Tejun Heoe19e3972013-01-24 11:39:44 -0800793 return !list_empty(&pool->worklist) &&
794 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200795}
796
797/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700798static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200799{
Tejun Heo63d95a92012-07-12 14:46:37 -0700800 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200801}
802
Tejun Heoe22bee72010-06-29 10:07:14 +0200803/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700804static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200805{
Tejun Heo692b4822017-10-09 08:04:13 -0700806 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700807 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
808 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200809
810 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
811}
812
813/*
814 * Wake up functions.
815 */
816
Lai Jiangshan1037de32014-05-22 16:44:07 +0800817/* Return the first idle worker. Safe with preemption disabled */
818static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200819{
Tejun Heo63d95a92012-07-12 14:46:37 -0700820 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200821 return NULL;
822
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200824}
825
826/**
827 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200831 *
832 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800833 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200834 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700835static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200836{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800837 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200838
839 if (likely(worker))
840 wake_up_process(worker->task);
841}
842
Tejun Heo4690c4a2010-06-29 10:07:10 +0200843/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 * wq_worker_waking_up - a worker is waking up
845 * @task: task waking up
846 * @cpu: CPU @task is waking up to
847 *
848 * This function is called during try_to_wake_up() when a worker is
849 * being awoken.
850 *
851 * CONTEXT:
852 * spin_lock_irq(rq->lock)
853 */
Tejun Heod84ff052013-03-12 11:29:59 -0700854void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200855{
856 struct worker *worker = kthread_data(task);
857
Joonsoo Kim36576002012-10-26 23:03:49 +0900858 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800859 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800860 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900861 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200862}
863
864/**
865 * wq_worker_sleeping - a worker is going to sleep
866 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200867 *
868 * This function is called during schedule() when a busy worker is
869 * going to sleep. Worker on the same cpu can be woken up by
870 * returning pointer to its task.
871 *
872 * CONTEXT:
873 * spin_lock_irq(rq->lock)
874 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700875 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200876 * Worker task on @cpu to wake up, %NULL if none.
877 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100878struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200879{
880 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800881 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200882
Tejun Heo111c2252013-01-17 17:16:24 -0800883 /*
884 * Rescuers, which may not have all the fields set up like normal
885 * workers, also reach here, let's not access anything before
886 * checking NOT_RUNNING.
887 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500888 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200889 return NULL;
890
Tejun Heo111c2252013-01-17 17:16:24 -0800891 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800892
Tejun Heoe22bee72010-06-29 10:07:14 +0200893 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100894 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700895 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200896
897 /*
898 * The counterpart of the following dec_and_test, implied mb,
899 * worklist not empty test sequence is in insert_work().
900 * Please read comment there.
901 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700902 * NOT_RUNNING is clear. This means that we're bound to and
903 * running on the local cpu w/ rq lock held and preemption
904 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800905 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700906 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200907 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800908 if (atomic_dec_and_test(&pool->nr_running) &&
909 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800910 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 return to_wakeup ? to_wakeup->task : NULL;
912}
913
914/**
915 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200916 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200917 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200918 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800919 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200920 *
Tejun Heocb444762010-07-02 10:03:50 +0200921 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800922 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200923 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800924static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200925{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700926 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200927
Tejun Heocb444762010-07-02 10:03:50 +0200928 WARN_ON_ONCE(worker->task != current);
929
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800930 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200931 if ((flags & WORKER_NOT_RUNNING) &&
932 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800933 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200934 }
935
Tejun Heod302f012010-06-29 10:07:13 +0200936 worker->flags |= flags;
937}
938
939/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200940 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200941 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200942 * @flags: flags to clear
943 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200944 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200945 *
Tejun Heocb444762010-07-02 10:03:50 +0200946 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800947 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200948 */
949static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
950{
Tejun Heo63d95a92012-07-12 14:46:37 -0700951 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200952 unsigned int oflags = worker->flags;
953
Tejun Heocb444762010-07-02 10:03:50 +0200954 WARN_ON_ONCE(worker->task != current);
955
Tejun Heod302f012010-06-29 10:07:13 +0200956 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200957
Tejun Heo42c025f2011-01-11 15:58:49 +0100958 /*
959 * If transitioning out of NOT_RUNNING, increment nr_running. Note
960 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
961 * of multiple flags, not a single flag.
962 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200963 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
964 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800965 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200966}
967
968/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200969 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800970 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200971 * @work: work to find worker for
972 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800973 * Find a worker which is executing @work on @pool by searching
974 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800975 * to match, its current execution should match the address of @work and
976 * its work function. This is to avoid unwanted dependency between
977 * unrelated work executions through a work item being recycled while still
978 * being executed.
979 *
980 * This is a bit tricky. A work item may be freed once its execution
981 * starts and nothing prevents the freed area from being recycled for
982 * another work item. If the same work item address ends up being reused
983 * before the original execution finishes, workqueue will identify the
984 * recycled work item as currently executing and make it wait until the
985 * current execution finishes, introducing an unwanted dependency.
986 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700987 * This function checks the work item address and work function to avoid
988 * false positives. Note that this isn't complete as one may construct a
989 * work function which can introduce dependency onto itself through a
990 * recycled work item. Well, if somebody wants to shoot oneself in the
991 * foot that badly, there's only so much we can do, and if such deadlock
992 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200993 *
994 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800995 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200996 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700997 * Return:
998 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200999 * otherwise.
1000 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001001static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001002 struct work_struct *work)
1003{
Sasha Levin42f85702012-12-17 10:01:23 -05001004 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001005
Sasha Levinb67bfe02013-02-27 17:06:00 -08001006 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001007 (unsigned long)work)
1008 if (worker->current_work == work &&
1009 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001010 return worker;
1011
1012 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001013}
1014
1015/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001016 * move_linked_works - move linked works to a list
1017 * @work: start of series of works to be scheduled
1018 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301019 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001020 *
1021 * Schedule linked works starting from @work to @head. Work series to
1022 * be scheduled starts at @work and includes any consecutive work with
1023 * WORK_STRUCT_LINKED set in its predecessor.
1024 *
1025 * If @nextp is not NULL, it's updated to point to the next work of
1026 * the last scheduled work. This allows move_linked_works() to be
1027 * nested inside outer list_for_each_entry_safe().
1028 *
1029 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001030 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001031 */
1032static void move_linked_works(struct work_struct *work, struct list_head *head,
1033 struct work_struct **nextp)
1034{
1035 struct work_struct *n;
1036
1037 /*
1038 * Linked worklist will always end before the end of the list,
1039 * use NULL for list head.
1040 */
1041 list_for_each_entry_safe_from(work, n, NULL, entry) {
1042 list_move_tail(&work->entry, head);
1043 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1044 break;
1045 }
1046
1047 /*
1048 * If we're already inside safe list traversal and have moved
1049 * multiple works to the scheduled queue, the next position
1050 * needs to be updated.
1051 */
1052 if (nextp)
1053 *nextp = n;
1054}
1055
Tejun Heo8864b4e2013-03-12 11:30:04 -07001056/**
1057 * get_pwq - get an extra reference on the specified pool_workqueue
1058 * @pwq: pool_workqueue to get
1059 *
1060 * Obtain an extra reference on @pwq. The caller should guarantee that
1061 * @pwq has positive refcnt and be holding the matching pool->lock.
1062 */
1063static void get_pwq(struct pool_workqueue *pwq)
1064{
1065 lockdep_assert_held(&pwq->pool->lock);
1066 WARN_ON_ONCE(pwq->refcnt <= 0);
1067 pwq->refcnt++;
1068}
1069
1070/**
1071 * put_pwq - put a pool_workqueue reference
1072 * @pwq: pool_workqueue to put
1073 *
1074 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1075 * destruction. The caller should be holding the matching pool->lock.
1076 */
1077static void put_pwq(struct pool_workqueue *pwq)
1078{
1079 lockdep_assert_held(&pwq->pool->lock);
1080 if (likely(--pwq->refcnt))
1081 return;
1082 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1083 return;
1084 /*
1085 * @pwq can't be released under pool->lock, bounce to
1086 * pwq_unbound_release_workfn(). This never recurses on the same
1087 * pool->lock as this path is taken only for unbound workqueues and
1088 * the release work item is scheduled on a per-cpu workqueue. To
1089 * avoid lockdep warning, unbound pool->locks are given lockdep
1090 * subclass of 1 in get_unbound_pool().
1091 */
1092 schedule_work(&pwq->unbound_release_work);
1093}
1094
Tejun Heodce90d42013-04-01 11:23:35 -07001095/**
1096 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1097 * @pwq: pool_workqueue to put (can be %NULL)
1098 *
1099 * put_pwq() with locking. This function also allows %NULL @pwq.
1100 */
1101static void put_pwq_unlocked(struct pool_workqueue *pwq)
1102{
1103 if (pwq) {
1104 /*
1105 * As both pwqs and pools are sched-RCU protected, the
1106 * following lock operations are safe.
1107 */
1108 spin_lock_irq(&pwq->pool->lock);
1109 put_pwq(pwq);
1110 spin_unlock_irq(&pwq->pool->lock);
1111 }
1112}
1113
Tejun Heo112202d2013-02-13 19:29:12 -08001114static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001115{
Tejun Heo112202d2013-02-13 19:29:12 -08001116 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001117
1118 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001119 if (list_empty(&pwq->pool->worklist))
1120 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001121 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001122 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001123 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001124}
1125
Tejun Heo112202d2013-02-13 19:29:12 -08001126static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001127{
Tejun Heo112202d2013-02-13 19:29:12 -08001128 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001129 struct work_struct, entry);
1130
Tejun Heo112202d2013-02-13 19:29:12 -08001131 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001132}
1133
Tejun Heobf4ede02012-08-03 10:30:46 -07001134/**
Tejun Heo112202d2013-02-13 19:29:12 -08001135 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1136 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001137 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001138 *
1139 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001140 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001141 *
1142 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001143 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001144 */
Tejun Heo112202d2013-02-13 19:29:12 -08001145static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001146{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001147 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001148 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001149 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001150
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001152
Tejun Heo112202d2013-02-13 19:29:12 -08001153 pwq->nr_active--;
1154 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001155 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001156 if (pwq->nr_active < pwq->max_active)
1157 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001158 }
1159
1160 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001161 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001162 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001163
1164 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001165 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001166 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001167
Tejun Heo112202d2013-02-13 19:29:12 -08001168 /* this pwq is done, clear flush_color */
1169 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001170
1171 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001172 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001173 * will handle the rest.
1174 */
Tejun Heo112202d2013-02-13 19:29:12 -08001175 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1176 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001177out_put:
1178 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001179}
1180
Tejun Heo36e227d2012-08-03 10:30:46 -07001181/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001182 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001183 * @work: work item to steal
1184 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001185 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001186 *
1187 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001188 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001189 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001190 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001191 * 1 if @work was pending and we successfully stole PENDING
1192 * 0 if @work was idle and we claimed PENDING
1193 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001194 * -ENOENT if someone else is canceling @work, this state may persist
1195 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001196 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001197 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001198 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001199 * interrupted while holding PENDING and @work off queue, irq must be
1200 * disabled on entry. This, combined with delayed_work->timer being
1201 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001202 *
1203 * On successful return, >= 0, irq is disabled and the caller is
1204 * responsible for releasing it using local_irq_restore(*@flags).
1205 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001206 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001207 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001208static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1209 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001210{
Tejun Heod565ed62013-01-24 11:01:33 -08001211 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001212 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001213
Tejun Heobbb68df2012-08-03 10:30:46 -07001214 local_irq_save(*flags);
1215
Tejun Heo36e227d2012-08-03 10:30:46 -07001216 /* try to steal the timer if it exists */
1217 if (is_dwork) {
1218 struct delayed_work *dwork = to_delayed_work(work);
1219
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001220 /*
1221 * dwork->timer is irqsafe. If del_timer() fails, it's
1222 * guaranteed that the timer is not queued anywhere and not
1223 * running on the local CPU.
1224 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001225 if (likely(del_timer(&dwork->timer)))
1226 return 1;
1227 }
1228
1229 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001230 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1231 return 0;
1232
1233 /*
1234 * The queueing is in progress, or it is already queued. Try to
1235 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1236 */
Tejun Heod565ed62013-01-24 11:01:33 -08001237 pool = get_work_pool(work);
1238 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001239 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001240
Tejun Heod565ed62013-01-24 11:01:33 -08001241 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001242 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001243 * work->data is guaranteed to point to pwq only while the work
1244 * item is queued on pwq->wq, and both updating work->data to point
1245 * to pwq on queueing and to pool on dequeueing are done under
1246 * pwq->pool->lock. This in turn guarantees that, if work->data
1247 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001248 * item is currently queued on that pool.
1249 */
Tejun Heo112202d2013-02-13 19:29:12 -08001250 pwq = get_work_pwq(work);
1251 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001252 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001253
Tejun Heo16062832013-02-06 18:04:53 -08001254 /*
1255 * A delayed work item cannot be grabbed directly because
1256 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001257 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001258 * management later on and cause stall. Make sure the work
1259 * item is activated before grabbing.
1260 */
1261 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001262 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001263
Tejun Heo16062832013-02-06 18:04:53 -08001264 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001265 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001266
Tejun Heo112202d2013-02-13 19:29:12 -08001267 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001268 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001269
Tejun Heo16062832013-02-06 18:04:53 -08001270 spin_unlock(&pool->lock);
1271 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001272 }
Tejun Heod565ed62013-01-24 11:01:33 -08001273 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001274fail:
1275 local_irq_restore(*flags);
1276 if (work_is_canceling(work))
1277 return -ENOENT;
1278 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001279 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001280}
1281
1282/**
Tejun Heo706026c2013-01-24 11:01:34 -08001283 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001284 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001285 * @work: work to insert
1286 * @head: insertion point
1287 * @extra_flags: extra WORK_STRUCT_* flags to set
1288 *
Tejun Heo112202d2013-02-13 19:29:12 -08001289 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001290 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001291 *
1292 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001293 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001294 */
Tejun Heo112202d2013-02-13 19:29:12 -08001295static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1296 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001297{
Tejun Heo112202d2013-02-13 19:29:12 -08001298 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001299
Tejun Heo4690c4a2010-06-29 10:07:10 +02001300 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001301 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001302 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001303 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001304
1305 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001306 * Ensure either wq_worker_sleeping() sees the above
1307 * list_add_tail() or we see zero nr_running to avoid workers lying
1308 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001309 */
1310 smp_mb();
1311
Tejun Heo63d95a92012-07-12 14:46:37 -07001312 if (__need_more_worker(pool))
1313 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001314}
1315
Tejun Heoc8efcc22010-12-20 19:32:04 +01001316/*
1317 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001318 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001319 */
1320static bool is_chained_work(struct workqueue_struct *wq)
1321{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001322 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001323
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001324 worker = current_wq_worker();
1325 /*
1326 * Return %true iff I'm a worker execuing a work item on @wq. If
1327 * I'm @worker, it's safe to dereference it without locking.
1328 */
Tejun Heo112202d2013-02-13 19:29:12 -08001329 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001330}
1331
Mike Galbraithef5571802016-02-09 17:59:38 -05001332/*
1333 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1334 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1335 * avoid perturbing sensitive tasks.
1336 */
1337static int wq_select_unbound_cpu(int cpu)
1338{
Tejun Heof303fccb2016-02-09 17:59:38 -05001339 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001340 int new_cpu;
1341
Tejun Heof303fccb2016-02-09 17:59:38 -05001342 if (likely(!wq_debug_force_rr_cpu)) {
1343 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1344 return cpu;
1345 } else if (!printed_dbg_warning) {
1346 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1347 printed_dbg_warning = true;
1348 }
1349
Mike Galbraithef5571802016-02-09 17:59:38 -05001350 if (cpumask_empty(wq_unbound_cpumask))
1351 return cpu;
1352
1353 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1354 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1355 if (unlikely(new_cpu >= nr_cpu_ids)) {
1356 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1357 if (unlikely(new_cpu >= nr_cpu_ids))
1358 return cpu;
1359 }
1360 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1361
1362 return new_cpu;
1363}
1364
Tejun Heod84ff052013-03-12 11:29:59 -07001365static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 struct work_struct *work)
1367{
Tejun Heo112202d2013-02-13 19:29:12 -08001368 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001369 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001370 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001371 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001372 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001373
1374 /*
1375 * While a work item is PENDING && off queue, a task trying to
1376 * steal the PENDING will busy-loop waiting for it to either get
1377 * queued or lose PENDING. Grabbing PENDING and queueing should
1378 * happen with IRQ disabled.
1379 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001380 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001382 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001383
Li Bin9ef28a72013-09-09 13:13:58 +08001384 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001385 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001386 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001387 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001388retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001389 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001390 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001391
Tejun Heoc9178082013-03-12 11:30:04 -07001392 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001394 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001395 else
1396 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001397
Tejun Heoc9178082013-03-12 11:30:04 -07001398 /*
1399 * If @work was previously on a different pool, it might still be
1400 * running there, in which case the work needs to be queued on that
1401 * pool to guarantee non-reentrancy.
1402 */
1403 last_pool = get_work_pool(work);
1404 if (last_pool && last_pool != pwq->pool) {
1405 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001406
Tejun Heoc9178082013-03-12 11:30:04 -07001407 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001408
Tejun Heoc9178082013-03-12 11:30:04 -07001409 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001410
Tejun Heoc9178082013-03-12 11:30:04 -07001411 if (worker && worker->current_pwq->wq == wq) {
1412 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001413 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001414 /* meh... not running there, queue here */
1415 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001416 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001417 }
Tejun Heof3421792010-07-02 10:03:51 +02001418 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001419 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001420 }
1421
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001422 /*
1423 * pwq is determined and locked. For unbound pools, we could have
1424 * raced with pwq release and it could already be dead. If its
1425 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001426 * without another pwq replacing it in the numa_pwq_tbl or while
1427 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001428 * make forward-progress.
1429 */
1430 if (unlikely(!pwq->refcnt)) {
1431 if (wq->flags & WQ_UNBOUND) {
1432 spin_unlock(&pwq->pool->lock);
1433 cpu_relax();
1434 goto retry;
1435 }
1436 /* oops */
1437 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1438 wq->name, cpu);
1439 }
1440
Tejun Heo112202d2013-02-13 19:29:12 -08001441 /* pwq determined, queue */
1442 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001443
Dan Carpenterf5b25522012-04-13 22:06:58 +03001444 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001445 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001446 return;
1447 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001448
Tejun Heo112202d2013-02-13 19:29:12 -08001449 pwq->nr_in_flight[pwq->work_color]++;
1450 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001451
Tejun Heo112202d2013-02-13 19:29:12 -08001452 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001453 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001454 pwq->nr_active++;
1455 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001456 if (list_empty(worklist))
1457 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001458 } else {
1459 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001460 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001461 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001462
Tejun Heo112202d2013-02-13 19:29:12 -08001463 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001464
Tejun Heo112202d2013-02-13 19:29:12 -08001465 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466}
1467
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001468/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001469 * queue_work_on - queue work on specific cpu
1470 * @cpu: CPU number to execute work on
1471 * @wq: workqueue to use
1472 * @work: work to queue
1473 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001474 * We queue the work to a specific CPU, the caller must ensure it
1475 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001476 *
1477 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001478 */
Tejun Heod4283e92012-08-03 10:30:44 -07001479bool queue_work_on(int cpu, struct workqueue_struct *wq,
1480 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001481{
Tejun Heod4283e92012-08-03 10:30:44 -07001482 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001483 unsigned long flags;
1484
1485 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001486
Tejun Heo22df02b2010-06-29 10:07:10 +02001487 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001488 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001489 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001490 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001491
1492 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001493 return ret;
1494}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001495EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001496
Kees Cook8c20feb2017-10-04 16:27:07 -07001497void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498{
Kees Cook8c20feb2017-10-04 16:27:07 -07001499 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001501 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001502 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001504EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001506static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1507 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001509 struct timer_list *timer = &dwork->timer;
1510 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Tejun Heo637fdba2017-03-06 15:33:42 -05001512 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001513 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001514 WARN_ON_ONCE(timer_pending(timer));
1515 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001516
Tejun Heo8852aac2012-12-01 16:23:42 -08001517 /*
1518 * If @delay is 0, queue @dwork->work immediately. This is for
1519 * both optimization and correctness. The earliest @timer can
1520 * expire is on the closest next tick and delayed_work users depend
1521 * on that there's no such delay when @delay is 0.
1522 */
1523 if (!delay) {
1524 __queue_work(cpu, wq, &dwork->work);
1525 return;
1526 }
1527
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001528 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001529 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001530 timer->expires = jiffies + delay;
1531
Tejun Heo041bd122016-02-09 16:11:26 -05001532 if (unlikely(cpu != WORK_CPU_UNBOUND))
1533 add_timer_on(timer, cpu);
1534 else
1535 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536}
1537
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001538/**
1539 * queue_delayed_work_on - queue work on specific CPU after delay
1540 * @cpu: CPU number to execute work on
1541 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001542 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001543 * @delay: number of jiffies to wait before queueing
1544 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001545 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001546 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1547 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001548 */
Tejun Heod4283e92012-08-03 10:30:44 -07001549bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1550 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001551{
David Howells52bad642006-11-22 14:54:01 +00001552 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001553 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001554 unsigned long flags;
1555
1556 /* read the comment in __queue_work() */
1557 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001558
Tejun Heo22df02b2010-06-29 10:07:10 +02001559 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001560 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001561 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001562 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001563
1564 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001565 return ret;
1566}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001567EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
Tejun Heoc8e55f32010-06-29 10:07:12 +02001569/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001570 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1571 * @cpu: CPU number to execute work on
1572 * @wq: workqueue to use
1573 * @dwork: work to queue
1574 * @delay: number of jiffies to wait before queueing
1575 *
1576 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1577 * modify @dwork's timer so that it expires after @delay. If @delay is
1578 * zero, @work is guaranteed to be scheduled immediately regardless of its
1579 * current state.
1580 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001581 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001582 * pending and its timer was modified.
1583 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001584 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001585 * See try_to_grab_pending() for details.
1586 */
1587bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1588 struct delayed_work *dwork, unsigned long delay)
1589{
1590 unsigned long flags;
1591 int ret;
1592
1593 do {
1594 ret = try_to_grab_pending(&dwork->work, true, &flags);
1595 } while (unlikely(ret == -EAGAIN));
1596
1597 if (likely(ret >= 0)) {
1598 __queue_delayed_work(cpu, wq, dwork, delay);
1599 local_irq_restore(flags);
1600 }
1601
1602 /* -ENOENT from try_to_grab_pending() becomes %true */
1603 return ret;
1604}
1605EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1606
1607/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001608 * worker_enter_idle - enter idle state
1609 * @worker: worker which is entering idle state
1610 *
1611 * @worker is entering idle state. Update stats and idle timer if
1612 * necessary.
1613 *
1614 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001615 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001616 */
1617static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001619 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Tejun Heo6183c002013-03-12 11:29:57 -07001621 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1622 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1623 (worker->hentry.next || worker->hentry.pprev)))
1624 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Lai Jiangshan051e1852014-07-22 13:03:02 +08001626 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001627 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001628 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001629 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001630
Tejun Heoc8e55f32010-06-29 10:07:12 +02001631 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001632 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001633
Tejun Heo628c78e2012-07-17 12:39:27 -07001634 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1635 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001636
Tejun Heo544ecf32012-05-14 15:04:50 -07001637 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001638 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001639 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001640 * nr_running, the warning may trigger spuriously. Check iff
1641 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001642 */
Tejun Heo24647572013-01-24 11:01:33 -08001643 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001644 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001645 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646}
1647
Tejun Heoc8e55f32010-06-29 10:07:12 +02001648/**
1649 * worker_leave_idle - leave idle state
1650 * @worker: worker which is leaving idle state
1651 *
1652 * @worker is leaving idle state. Update stats.
1653 *
1654 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001655 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001656 */
1657static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001659 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
Tejun Heo6183c002013-03-12 11:29:57 -07001661 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1662 return;
Tejun Heod302f012010-06-29 10:07:13 +02001663 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001664 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001665 list_del_init(&worker->entry);
1666}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001668static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001669{
1670 struct worker *worker;
1671
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001672 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001673 if (worker) {
1674 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001675 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001676 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001677 /* on creation a worker is in !idle && prep state */
1678 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001679 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001680 return worker;
1681}
1682
1683/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001684 * worker_attach_to_pool() - attach a worker to a pool
1685 * @worker: worker to be attached
1686 * @pool: the target pool
1687 *
1688 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1689 * cpu-binding of @worker are kept coordinated with the pool across
1690 * cpu-[un]hotplugs.
1691 */
1692static void worker_attach_to_pool(struct worker *worker,
1693 struct worker_pool *pool)
1694{
1695 mutex_lock(&pool->attach_mutex);
1696
1697 /*
1698 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1699 * online CPUs. It'll be re-applied when any of the CPUs come up.
1700 */
1701 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1702
1703 /*
1704 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1705 * stable across this function. See the comments above the
1706 * flag definition for details.
1707 */
1708 if (pool->flags & POOL_DISASSOCIATED)
1709 worker->flags |= WORKER_UNBOUND;
1710
1711 list_add_tail(&worker->node, &pool->workers);
1712
1713 mutex_unlock(&pool->attach_mutex);
1714}
1715
1716/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001717 * worker_detach_from_pool() - detach a worker from its pool
1718 * @worker: worker which is attached to its pool
1719 * @pool: the pool @worker is attached to
1720 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001721 * Undo the attaching which had been done in worker_attach_to_pool(). The
1722 * caller worker shouldn't access to the pool after detached except it has
1723 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001724 */
1725static void worker_detach_from_pool(struct worker *worker,
1726 struct worker_pool *pool)
1727{
1728 struct completion *detach_completion = NULL;
1729
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001730 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001731 list_del(&worker->node);
1732 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001733 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001734 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001735
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001736 /* clear leftover flags without pool->lock after it is detached */
1737 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1738
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001739 if (detach_completion)
1740 complete(detach_completion);
1741}
1742
1743/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001744 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001745 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001746 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001747 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001748 *
1749 * CONTEXT:
1750 * Might sleep. Does GFP_KERNEL allocations.
1751 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001752 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001753 * Pointer to the newly created worker.
1754 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001755static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001756{
Tejun Heoc34056a2010-06-29 10:07:11 +02001757 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001758 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001759 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001760
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001761 /* ID is needed to determine kthread name */
1762 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001763 if (id < 0)
1764 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001765
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001766 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001767 if (!worker)
1768 goto fail;
1769
Tejun Heobd7bdd42012-07-12 14:46:37 -07001770 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001771 worker->id = id;
1772
Tejun Heo29c91e92013-03-12 11:30:03 -07001773 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001774 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1775 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001776 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001777 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1778
Tejun Heof3f90ad2013-04-01 11:23:34 -07001779 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001780 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001781 if (IS_ERR(worker->task))
1782 goto fail;
1783
Oleg Nesterov91151222013-11-14 12:56:18 +01001784 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001785 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001786
Lai Jiangshanda028462014-05-20 17:46:31 +08001787 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001788 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001789
Lai Jiangshan051e1852014-07-22 13:03:02 +08001790 /* start the newly created worker */
1791 spin_lock_irq(&pool->lock);
1792 worker->pool->nr_workers++;
1793 worker_enter_idle(worker);
1794 wake_up_process(worker->task);
1795 spin_unlock_irq(&pool->lock);
1796
Tejun Heoc34056a2010-06-29 10:07:11 +02001797 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001798
Tejun Heoc34056a2010-06-29 10:07:11 +02001799fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001800 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001801 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 kfree(worker);
1803 return NULL;
1804}
1805
1806/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001807 * destroy_worker - destroy a workqueue worker
1808 * @worker: worker to be destroyed
1809 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001810 * Destroy @worker and adjust @pool stats accordingly. The worker should
1811 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001812 *
1813 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001814 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001815 */
1816static void destroy_worker(struct worker *worker)
1817{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001818 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001819
Tejun Heocd549682013-03-13 19:47:39 -07001820 lockdep_assert_held(&pool->lock);
1821
Tejun Heoc34056a2010-06-29 10:07:11 +02001822 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001823 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001824 WARN_ON(!list_empty(&worker->scheduled)) ||
1825 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001826 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001827
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001828 pool->nr_workers--;
1829 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001830
Tejun Heoc8e55f32010-06-29 10:07:12 +02001831 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001832 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001833 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001834}
1835
Kees Cook32a6c722017-10-16 15:58:25 -07001836static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001837{
Kees Cook32a6c722017-10-16 15:58:25 -07001838 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001839
Tejun Heod565ed62013-01-24 11:01:33 -08001840 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001841
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001842 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001843 struct worker *worker;
1844 unsigned long expires;
1845
1846 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001847 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001848 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1849
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001850 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001851 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001852 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001854
1855 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001856 }
1857
Tejun Heod565ed62013-01-24 11:01:33 -08001858 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001859}
1860
Tejun Heo493a1722013-03-12 11:29:59 -07001861static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001862{
Tejun Heo112202d2013-02-13 19:29:12 -08001863 struct pool_workqueue *pwq = get_work_pwq(work);
1864 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001865
Tejun Heo2e109a22013-03-13 19:47:40 -07001866 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001867
Tejun Heo493008a2013-03-12 11:30:03 -07001868 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001869 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001870
1871 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001872 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001873 /*
1874 * If @pwq is for an unbound wq, its base ref may be put at
1875 * any time due to an attribute change. Pin @pwq until the
1876 * rescuer is done with it.
1877 */
1878 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001879 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001881 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001882}
1883
Kees Cook32a6c722017-10-16 15:58:25 -07001884static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001885{
Kees Cook32a6c722017-10-16 15:58:25 -07001886 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 struct work_struct *work;
1888
Tejun Heob2d82902014-12-08 12:39:16 -05001889 spin_lock_irq(&pool->lock);
1890 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001891
Tejun Heo63d95a92012-07-12 14:46:37 -07001892 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001893 /*
1894 * We've been trying to create a new worker but
1895 * haven't been successful. We might be hitting an
1896 * allocation deadlock. Send distress signals to
1897 * rescuers.
1898 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001899 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001900 send_mayday(work);
1901 }
1902
Tejun Heob2d82902014-12-08 12:39:16 -05001903 spin_unlock(&wq_mayday_lock);
1904 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001905
Tejun Heo63d95a92012-07-12 14:46:37 -07001906 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001907}
1908
1909/**
1910 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001913 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 * have at least one idle worker on return from this function. If
1915 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001916 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001917 * possible allocation deadlock.
1918 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001919 * On return, need_to_create_worker() is guaranteed to be %false and
1920 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 *
1922 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001923 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001924 * multiple times. Does GFP_KERNEL allocations. Called only from
1925 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001926 */
Tejun Heo29187a92015-01-16 14:21:16 -05001927static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001928__releases(&pool->lock)
1929__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001930{
Tejun Heoe22bee72010-06-29 10:07:14 +02001931restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001932 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001933
Tejun Heoe22bee72010-06-29 10:07:14 +02001934 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001935 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001936
1937 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001938 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 break;
1940
Lai Jiangshane212f362014-06-03 15:32:17 +08001941 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001942
Tejun Heo63d95a92012-07-12 14:46:37 -07001943 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 break;
1945 }
1946
Tejun Heo63d95a92012-07-12 14:46:37 -07001947 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001948 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001949 /*
1950 * This is necessary even after a new worker was just successfully
1951 * created as @pool->lock was dropped and the new worker might have
1952 * already become busy.
1953 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001954 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001956}
1957
1958/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 * manage_workers - manage worker pool
1960 * @worker: self
1961 *
Tejun Heo706026c2013-01-24 11:01:34 -08001962 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001963 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001964 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 *
1966 * The caller can safely start processing works on false return. On
1967 * true return, it's guaranteed that need_to_create_worker() is false
1968 * and may_start_working() is true.
1969 *
1970 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001971 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 * multiple times. Does GFP_KERNEL allocations.
1973 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001974 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001975 * %false if the pool doesn't need management and the caller can safely
1976 * start processing works, %true if management function was performed and
1977 * the conditions that the caller verified before calling the function may
1978 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001979 */
1980static bool manage_workers(struct worker *worker)
1981{
Tejun Heo63d95a92012-07-12 14:46:37 -07001982 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001983
Tejun Heo692b4822017-10-09 08:04:13 -07001984 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05001985 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07001986
1987 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001988 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001989
Tejun Heo29187a92015-01-16 14:21:16 -05001990 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001991
Tejun Heo2607d7a2015-03-09 09:22:28 -04001992 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07001993 pool->flags &= ~POOL_MANAGER_ACTIVE;
1994 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05001995 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001996}
1997
Tejun Heoa62428c2010-06-29 10:07:10 +02001998/**
1999 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002000 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002001 * @work: work to process
2002 *
2003 * Process @work. This function contains all the logics necessary to
2004 * process a single work including synchronization against and
2005 * interaction with other workers on the same cpu, queueing and
2006 * flushing. As long as context requirement is met, any worker can
2007 * call this function to process a work.
2008 *
2009 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002010 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002011 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002012static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002013__releases(&pool->lock)
2014__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002015{
Tejun Heo112202d2013-02-13 19:29:12 -08002016 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002017 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002018 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002019 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002020 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002021#ifdef CONFIG_LOCKDEP
2022 /*
2023 * It is permissible to free the struct work_struct from
2024 * inside the function that is called from it, this we need to
2025 * take into account for lockdep too. To avoid bogus "held
2026 * lock freed" warnings as well as problems when looking into
2027 * work->lockdep_map, make a copy and use that here.
2028 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002029 struct lockdep_map lockdep_map;
2030
2031 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002032#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002033 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002034 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002035 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002036
Tejun Heo7e116292010-06-29 10:07:13 +02002037 /*
2038 * A single work shouldn't be executed concurrently by
2039 * multiple workers on a single cpu. Check whether anyone is
2040 * already processing the work. If so, defer the work to the
2041 * currently executing one.
2042 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002043 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002044 if (unlikely(collision)) {
2045 move_linked_works(work, &collision->scheduled, NULL);
2046 return;
2047 }
2048
Tejun Heo8930cab2012-08-03 10:30:45 -07002049 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002050 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002051 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002052 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002053 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002054 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002055 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002056
Tejun Heoa62428c2010-06-29 10:07:10 +02002057 list_del_init(&work->entry);
2058
Tejun Heo649027d2010-06-29 10:07:14 +02002059 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002060 * CPU intensive works don't participate in concurrency management.
2061 * They're the scheduler's responsibility. This takes @worker out
2062 * of concurrency management and the next code block will chain
2063 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002064 */
2065 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002066 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002067
Tejun Heo974271c42012-07-12 14:46:37 -07002068 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002069 * Wake up another worker if necessary. The condition is always
2070 * false for normal per-cpu workers since nr_running would always
2071 * be >= 1 at this point. This is used to chain execution of the
2072 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002073 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002074 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002075 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002076 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002077
Tejun Heo8930cab2012-08-03 10:30:45 -07002078 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002079 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002080 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002081 * PENDING and queued state changes happen together while IRQ is
2082 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002083 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002084 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002085
Tejun Heod565ed62013-01-24 11:01:33 -08002086 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002087
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002088 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002089 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002090 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002091 * Strictly speaking we should mark the invariant state without holding
2092 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002093 *
2094 * However, that would result in:
2095 *
2096 * A(W1)
2097 * WFC(C)
2098 * A(W1)
2099 * C(C)
2100 *
2101 * Which would create W1->C->W1 dependencies, even though there is no
2102 * actual deadlock possible. There are two solutions, using a
2103 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002104 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002105 * these locks.
2106 *
2107 * AFAICT there is no possible deadlock scenario between the
2108 * flush_work() and complete() primitives (except for single-threaded
2109 * workqueues), so hiding them isn't a problem.
2110 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002111 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002112 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002113 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002114 /*
2115 * While we must be careful to not use "work" after this, the trace
2116 * point will only record its address.
2117 */
2118 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002119 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002120 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002121
2122 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002123 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2124 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002125 current->comm, preempt_count(), task_pid_nr(current),
2126 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002127 debug_show_held_locks(current);
2128 dump_stack();
2129 }
2130
Tejun Heob22ce272013-08-28 17:33:37 -04002131 /*
2132 * The following prevents a kworker from hogging CPU on !PREEMPT
2133 * kernels, where a requeueing work item waiting for something to
2134 * happen could deadlock with stop_machine as such work item could
2135 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002136 * stop_machine. At the same time, report a quiescent RCU state so
2137 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002138 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002139 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002140
Tejun Heod565ed62013-01-24 11:01:33 -08002141 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002142
Tejun Heofb0e7be2010-06-29 10:07:15 +02002143 /* clear cpu intensive status */
2144 if (unlikely(cpu_intensive))
2145 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2146
Tejun Heoa62428c2010-06-29 10:07:10 +02002147 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002148 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002149 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002150 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002151 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002152 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002153 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002154}
2155
Tejun Heoaffee4b2010-06-29 10:07:12 +02002156/**
2157 * process_scheduled_works - process scheduled works
2158 * @worker: self
2159 *
2160 * Process all scheduled works. Please note that the scheduled list
2161 * may change while processing a work, so this function repeatedly
2162 * fetches a work from the top and executes it.
2163 *
2164 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002165 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002166 * multiple times.
2167 */
2168static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002170 while (!list_empty(&worker->scheduled)) {
2171 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002173 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175}
2176
Tejun Heo4690c4a2010-06-29 10:07:10 +02002177/**
2178 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002179 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002180 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002181 * The worker thread function. All workers belong to a worker_pool -
2182 * either a per-cpu one or dynamic unbound one. These workers process all
2183 * work items regardless of their specific target workqueue. The only
2184 * exception is work items which belong to workqueues with a rescuer which
2185 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002186 *
2187 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002188 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002189static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190{
Tejun Heoc34056a2010-06-29 10:07:11 +02002191 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002192 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193
Tejun Heoe22bee72010-06-29 10:07:14 +02002194 /* tell the scheduler that this is a workqueue worker */
2195 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002196woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002197 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002198
Tejun Heoa9ab7752013-03-19 13:45:21 -07002199 /* am I supposed to die? */
2200 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002201 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002202 WARN_ON_ONCE(!list_empty(&worker->entry));
2203 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002204
2205 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002206 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002207 worker_detach_from_pool(worker, pool);
2208 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002209 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002211
Tejun Heoc8e55f32010-06-29 10:07:12 +02002212 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002213recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002214 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002215 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002216 goto sleep;
2217
2218 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002219 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002220 goto recheck;
2221
Tejun Heoc8e55f32010-06-29 10:07:12 +02002222 /*
2223 * ->scheduled list can only be filled while a worker is
2224 * preparing to process a work or actually processing it.
2225 * Make sure nobody diddled with it while I was sleeping.
2226 */
Tejun Heo6183c002013-03-12 11:29:57 -07002227 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002228
Tejun Heoe22bee72010-06-29 10:07:14 +02002229 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002230 * Finish PREP stage. We're guaranteed to have at least one idle
2231 * worker or that someone else has already assumed the manager
2232 * role. This is where @worker starts participating in concurrency
2233 * management if applicable and concurrency management is restored
2234 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002235 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002236 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002237
2238 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002239 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002240 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002241 struct work_struct, entry);
2242
Tejun Heo82607adc2015-12-08 11:28:04 -05002243 pool->watchdog_ts = jiffies;
2244
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2246 /* optimization path, not strictly necessary */
2247 process_one_work(worker, work);
2248 if (unlikely(!list_empty(&worker->scheduled)))
2249 process_scheduled_works(worker);
2250 } else {
2251 move_linked_works(work, &worker->scheduled, NULL);
2252 process_scheduled_works(worker);
2253 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002254 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002255
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002256 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002257sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002258 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002259 * pool->lock is held and there's no work to process and no need to
2260 * manage, sleep. Workers are woken up only while holding
2261 * pool->lock or from local cpu, so setting the current state
2262 * before releasing pool->lock is enough to prevent losing any
2263 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002264 */
2265 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002266 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002267 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002268 schedule();
2269 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270}
2271
Tejun Heoe22bee72010-06-29 10:07:14 +02002272/**
2273 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002274 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002275 *
2276 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002277 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002278 *
Tejun Heo706026c2013-01-24 11:01:34 -08002279 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002280 * worker which uses GFP_KERNEL allocation which has slight chance of
2281 * developing into deadlock if some works currently on the same queue
2282 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2283 * the problem rescuer solves.
2284 *
Tejun Heo706026c2013-01-24 11:01:34 -08002285 * When such condition is possible, the pool summons rescuers of all
2286 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002287 * those works so that forward progress can be guaranteed.
2288 *
2289 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002290 *
2291 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002292 */
Tejun Heo111c2252013-01-17 17:16:24 -08002293static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002294{
Tejun Heo111c2252013-01-17 17:16:24 -08002295 struct worker *rescuer = __rescuer;
2296 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002297 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002298 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002299
2300 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002301
2302 /*
2303 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2304 * doesn't participate in concurrency management.
2305 */
2306 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002307repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002308 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002309
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002310 /*
2311 * By the time the rescuer is requested to stop, the workqueue
2312 * shouldn't have any work pending, but @wq->maydays may still have
2313 * pwq(s) queued. This can happen by non-rescuer workers consuming
2314 * all the work items before the rescuer got to them. Go through
2315 * @wq->maydays processing before acting on should_stop so that the
2316 * list is always empty on exit.
2317 */
2318 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002319
Tejun Heo493a1722013-03-12 11:29:59 -07002320 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002321 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002322
2323 while (!list_empty(&wq->maydays)) {
2324 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2325 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002326 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002327 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002328 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002329
2330 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002331 list_del_init(&pwq->mayday_node);
2332
Tejun Heo2e109a22013-03-13 19:47:40 -07002333 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002334
Lai Jiangshan51697d392014-05-20 17:46:36 +08002335 worker_attach_to_pool(rescuer, pool);
2336
2337 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002338 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002339
2340 /*
2341 * Slurp in all works issued via this workqueue and
2342 * process'em.
2343 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002344 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002345 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2346 if (get_work_pwq(work) == pwq) {
2347 if (first)
2348 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002349 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002350 }
2351 first = false;
2352 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002353
NeilBrown008847f2014-12-08 12:39:16 -05002354 if (!list_empty(scheduled)) {
2355 process_scheduled_works(rescuer);
2356
2357 /*
2358 * The above execution of rescued work items could
2359 * have created more to rescue through
2360 * pwq_activate_first_delayed() or chained
2361 * queueing. Let's put @pwq back on mayday list so
2362 * that such back-to-back work items, which may be
2363 * being used to relieve memory pressure, don't
2364 * incur MAYDAY_INTERVAL delay inbetween.
2365 */
2366 if (need_to_create_worker(pool)) {
2367 spin_lock(&wq_mayday_lock);
2368 get_pwq(pwq);
2369 list_move_tail(&pwq->mayday_node, &wq->maydays);
2370 spin_unlock(&wq_mayday_lock);
2371 }
2372 }
Tejun Heo75769582011-02-14 14:04:46 +01002373
2374 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002375 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002376 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002377 */
2378 put_pwq(pwq);
2379
2380 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002381 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002382 * regular worker; otherwise, we end up with 0 concurrency
2383 * and stalling the execution.
2384 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002385 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002386 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002387
Lai Jiangshanb3104102013-02-19 12:17:02 -08002388 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002389 spin_unlock_irq(&pool->lock);
2390
2391 worker_detach_from_pool(rescuer, pool);
2392
2393 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002394 }
2395
Tejun Heo2e109a22013-03-13 19:47:40 -07002396 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002397
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002398 if (should_stop) {
2399 __set_current_state(TASK_RUNNING);
2400 rescuer->task->flags &= ~PF_WQ_WORKER;
2401 return 0;
2402 }
2403
Tejun Heo111c2252013-01-17 17:16:24 -08002404 /* rescuers should never participate in concurrency management */
2405 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002406 schedule();
2407 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408}
2409
Tejun Heofca839c2015-12-07 10:58:57 -05002410/**
2411 * check_flush_dependency - check for flush dependency sanity
2412 * @target_wq: workqueue being flushed
2413 * @target_work: work item being flushed (NULL for workqueue flushes)
2414 *
2415 * %current is trying to flush the whole @target_wq or @target_work on it.
2416 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2417 * reclaiming memory or running on a workqueue which doesn't have
2418 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2419 * a deadlock.
2420 */
2421static void check_flush_dependency(struct workqueue_struct *target_wq,
2422 struct work_struct *target_work)
2423{
2424 work_func_t target_func = target_work ? target_work->func : NULL;
2425 struct worker *worker;
2426
2427 if (target_wq->flags & WQ_MEM_RECLAIM)
2428 return;
2429
2430 worker = current_wq_worker();
2431
2432 WARN_ONCE(current->flags & PF_MEMALLOC,
2433 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2434 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002435 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2436 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002437 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2438 worker->current_pwq->wq->name, worker->current_func,
2439 target_wq->name, target_func);
2440}
2441
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002442struct wq_barrier {
2443 struct work_struct work;
2444 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002445 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002446};
2447
2448static void wq_barrier_func(struct work_struct *work)
2449{
2450 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2451 complete(&barr->done);
2452}
2453
Tejun Heo4690c4a2010-06-29 10:07:10 +02002454/**
2455 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002456 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002457 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002458 * @target: target work to attach @barr to
2459 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002460 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002461 * @barr is linked to @target such that @barr is completed only after
2462 * @target finishes execution. Please note that the ordering
2463 * guarantee is observed only with respect to @target and on the local
2464 * cpu.
2465 *
2466 * Currently, a queued barrier can't be canceled. This is because
2467 * try_to_grab_pending() can't determine whether the work to be
2468 * grabbed is at the head of the queue and thus can't clear LINKED
2469 * flag of the previous work while there must be a valid next work
2470 * after a work with LINKED flag set.
2471 *
2472 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002473 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002474 *
2475 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002476 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002477 */
Tejun Heo112202d2013-02-13 19:29:12 -08002478static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002479 struct wq_barrier *barr,
2480 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002481{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002482 struct list_head *head;
2483 unsigned int linked = 0;
2484
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002485 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002486 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002487 * as we know for sure that this will not trigger any of the
2488 * checks and call back into the fixup functions where we
2489 * might deadlock.
2490 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002491 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002492 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002493
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002494 init_completion_map(&barr->done, &target->lockdep_map);
2495
Tejun Heo2607d7a2015-03-09 09:22:28 -04002496 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002497
Tejun Heoaffee4b2010-06-29 10:07:12 +02002498 /*
2499 * If @target is currently being executed, schedule the
2500 * barrier to the worker; otherwise, put it after @target.
2501 */
2502 if (worker)
2503 head = worker->scheduled.next;
2504 else {
2505 unsigned long *bits = work_data_bits(target);
2506
2507 head = target->entry.next;
2508 /* there can already be other linked works, inherit and set */
2509 linked = *bits & WORK_STRUCT_LINKED;
2510 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2511 }
2512
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002513 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002514 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002515 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002516}
2517
Tejun Heo73f53c42010-06-29 10:07:11 +02002518/**
Tejun Heo112202d2013-02-13 19:29:12 -08002519 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002520 * @wq: workqueue being flushed
2521 * @flush_color: new flush color, < 0 for no-op
2522 * @work_color: new work color, < 0 for no-op
2523 *
Tejun Heo112202d2013-02-13 19:29:12 -08002524 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002525 *
Tejun Heo112202d2013-02-13 19:29:12 -08002526 * If @flush_color is non-negative, flush_color on all pwqs should be
2527 * -1. If no pwq has in-flight commands at the specified color, all
2528 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2529 * has in flight commands, its pwq->flush_color is set to
2530 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002531 * wakeup logic is armed and %true is returned.
2532 *
2533 * The caller should have initialized @wq->first_flusher prior to
2534 * calling this function with non-negative @flush_color. If
2535 * @flush_color is negative, no flush color update is done and %false
2536 * is returned.
2537 *
Tejun Heo112202d2013-02-13 19:29:12 -08002538 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002539 * work_color which is previous to @work_color and all will be
2540 * advanced to @work_color.
2541 *
2542 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002543 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002544 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002545 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002546 * %true if @flush_color >= 0 and there's something to flush. %false
2547 * otherwise.
2548 */
Tejun Heo112202d2013-02-13 19:29:12 -08002549static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002550 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551{
Tejun Heo73f53c42010-06-29 10:07:11 +02002552 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002553 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002554
Tejun Heo73f53c42010-06-29 10:07:11 +02002555 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002556 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002557 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002558 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002559
Tejun Heo49e3cf42013-03-12 11:29:58 -07002560 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002561 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002562
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002563 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002564
2565 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002566 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002567
Tejun Heo112202d2013-02-13 19:29:12 -08002568 if (pwq->nr_in_flight[flush_color]) {
2569 pwq->flush_color = flush_color;
2570 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002571 wait = true;
2572 }
2573 }
2574
2575 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002576 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002577 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002578 }
2579
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002580 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002581 }
2582
Tejun Heo112202d2013-02-13 19:29:12 -08002583 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002584 complete(&wq->first_flusher->done);
2585
2586 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587}
2588
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002589/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002591 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002593 * This function sleeps until all work items which were queued on entry
2594 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002596void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597{
Tejun Heo73f53c42010-06-29 10:07:11 +02002598 struct wq_flusher this_flusher = {
2599 .list = LIST_HEAD_INIT(this_flusher.list),
2600 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002601 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002602 };
2603 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002604
Tejun Heo3347fa02016-09-16 15:49:32 -04002605 if (WARN_ON(!wq_online))
2606 return;
2607
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002608 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002609
2610 /*
2611 * Start-to-wait phase
2612 */
2613 next_color = work_next_color(wq->work_color);
2614
2615 if (next_color != wq->flush_color) {
2616 /*
2617 * Color space is not full. The current work_color
2618 * becomes our flush_color and work_color is advanced
2619 * by one.
2620 */
Tejun Heo6183c002013-03-12 11:29:57 -07002621 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002622 this_flusher.flush_color = wq->work_color;
2623 wq->work_color = next_color;
2624
2625 if (!wq->first_flusher) {
2626 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002627 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002628
2629 wq->first_flusher = &this_flusher;
2630
Tejun Heo112202d2013-02-13 19:29:12 -08002631 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002632 wq->work_color)) {
2633 /* nothing to flush, done */
2634 wq->flush_color = next_color;
2635 wq->first_flusher = NULL;
2636 goto out_unlock;
2637 }
2638 } else {
2639 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002640 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002641 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002642 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002643 }
2644 } else {
2645 /*
2646 * Oops, color space is full, wait on overflow queue.
2647 * The next flush completion will assign us
2648 * flush_color and transfer to flusher_queue.
2649 */
2650 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2651 }
2652
Tejun Heofca839c2015-12-07 10:58:57 -05002653 check_flush_dependency(wq, NULL);
2654
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002655 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002656
2657 wait_for_completion(&this_flusher.done);
2658
2659 /*
2660 * Wake-up-and-cascade phase
2661 *
2662 * First flushers are responsible for cascading flushes and
2663 * handling overflow. Non-first flushers can simply return.
2664 */
2665 if (wq->first_flusher != &this_flusher)
2666 return;
2667
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002668 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002669
Tejun Heo4ce48b32010-07-02 10:03:51 +02002670 /* we might have raced, check again with mutex held */
2671 if (wq->first_flusher != &this_flusher)
2672 goto out_unlock;
2673
Tejun Heo73f53c42010-06-29 10:07:11 +02002674 wq->first_flusher = NULL;
2675
Tejun Heo6183c002013-03-12 11:29:57 -07002676 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2677 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002678
2679 while (true) {
2680 struct wq_flusher *next, *tmp;
2681
2682 /* complete all the flushers sharing the current flush color */
2683 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2684 if (next->flush_color != wq->flush_color)
2685 break;
2686 list_del_init(&next->list);
2687 complete(&next->done);
2688 }
2689
Tejun Heo6183c002013-03-12 11:29:57 -07002690 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2691 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002692
2693 /* this flush_color is finished, advance by one */
2694 wq->flush_color = work_next_color(wq->flush_color);
2695
2696 /* one color has been freed, handle overflow queue */
2697 if (!list_empty(&wq->flusher_overflow)) {
2698 /*
2699 * Assign the same color to all overflowed
2700 * flushers, advance work_color and append to
2701 * flusher_queue. This is the start-to-wait
2702 * phase for these overflowed flushers.
2703 */
2704 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2705 tmp->flush_color = wq->work_color;
2706
2707 wq->work_color = work_next_color(wq->work_color);
2708
2709 list_splice_tail_init(&wq->flusher_overflow,
2710 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002711 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002712 }
2713
2714 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002715 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002716 break;
2717 }
2718
2719 /*
2720 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002721 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002722 */
Tejun Heo6183c002013-03-12 11:29:57 -07002723 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2724 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002725
2726 list_del_init(&next->list);
2727 wq->first_flusher = next;
2728
Tejun Heo112202d2013-02-13 19:29:12 -08002729 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002730 break;
2731
2732 /*
2733 * Meh... this color is already done, clear first
2734 * flusher and repeat cascading.
2735 */
2736 wq->first_flusher = NULL;
2737 }
2738
2739out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002740 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002742EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002744/**
2745 * drain_workqueue - drain a workqueue
2746 * @wq: workqueue to drain
2747 *
2748 * Wait until the workqueue becomes empty. While draining is in progress,
2749 * only chain queueing is allowed. IOW, only currently pending or running
2750 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002751 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752 * by the depth of chaining and should be relatively short. Whine if it
2753 * takes too long.
2754 */
2755void drain_workqueue(struct workqueue_struct *wq)
2756{
2757 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002758 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002759
2760 /*
2761 * __queue_work() needs to test whether there are drainers, is much
2762 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002763 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002765 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002766 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002767 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002768 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002769reflush:
2770 flush_workqueue(wq);
2771
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002772 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002773
Tejun Heo49e3cf42013-03-12 11:29:58 -07002774 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002775 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002776
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002777 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002778 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002779 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002780
2781 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002782 continue;
2783
2784 if (++flush_cnt == 10 ||
2785 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002786 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002787 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002788
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002789 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002790 goto reflush;
2791 }
2792
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002793 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002794 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002795 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002796}
2797EXPORT_SYMBOL_GPL(drain_workqueue);
2798
Tejun Heo606a5022012-08-20 14:51:23 -07002799static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002800{
2801 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002802 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002803 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002804
2805 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002806
Tejun Heofa1b54e2013-03-12 11:30:00 -07002807 local_irq_disable();
2808 pool = get_work_pool(work);
2809 if (!pool) {
2810 local_irq_enable();
2811 return false;
2812 }
2813
2814 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002815 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002816 pwq = get_work_pwq(work);
2817 if (pwq) {
2818 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002819 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002820 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002821 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002822 if (!worker)
2823 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002824 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002825 }
Tejun Heobaf59022010-09-16 10:42:16 +02002826
Tejun Heofca839c2015-12-07 10:58:57 -05002827 check_flush_dependency(pwq->wq, work);
2828
Tejun Heo112202d2013-02-13 19:29:12 -08002829 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002830 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002831
Tejun Heoe159489b2011-01-09 23:32:15 +01002832 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002833 * Force a lock recursion deadlock when using flush_work() inside a
2834 * single-threaded or rescuer equipped workqueue.
2835 *
2836 * For single threaded workqueues the deadlock happens when the work
2837 * is after the work issuing the flush_work(). For rescuer equipped
2838 * workqueues the deadlock happens when the rescuer stalls, blocking
2839 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002840 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002841 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002842 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002843 lock_map_release(&pwq->wq->lockdep_map);
2844 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002845
Tejun Heobaf59022010-09-16 10:42:16 +02002846 return true;
2847already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002848 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002849 return false;
2850}
2851
Oleg Nesterovdb700892008-07-25 01:47:49 -07002852/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002853 * flush_work - wait for a work to finish executing the last queueing instance
2854 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002855 *
Tejun Heo606a5022012-08-20 14:51:23 -07002856 * Wait until @work has finished execution. @work is guaranteed to be idle
2857 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002858 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002859 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002860 * %true if flush_work() waited for the work to finish execution,
2861 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002862 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002863bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002864{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002865 struct wq_barrier barr;
2866
Tejun Heo3347fa02016-09-16 15:49:32 -04002867 if (WARN_ON(!wq_online))
2868 return false;
2869
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002870 if (start_flush_work(work, &barr)) {
2871 wait_for_completion(&barr.done);
2872 destroy_work_on_stack(&barr.work);
2873 return true;
2874 } else {
2875 return false;
2876 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002877}
2878EXPORT_SYMBOL_GPL(flush_work);
2879
Tejun Heo8603e1b32015-03-05 08:04:13 -05002880struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002881 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002882 struct work_struct *work;
2883};
2884
Ingo Molnarac6424b2017-06-20 12:06:13 +02002885static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002886{
2887 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2888
2889 if (cwait->work != key)
2890 return 0;
2891 return autoremove_wake_function(wait, mode, sync, key);
2892}
2893
Tejun Heo36e227d2012-08-03 10:30:46 -07002894static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002895{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002896 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002897 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002898 int ret;
2899
2900 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002901 ret = try_to_grab_pending(work, is_dwork, &flags);
2902 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002903 * If someone else is already canceling, wait for it to
2904 * finish. flush_work() doesn't work for PREEMPT_NONE
2905 * because we may get scheduled between @work's completion
2906 * and the other canceling task resuming and clearing
2907 * CANCELING - flush_work() will return false immediately
2908 * as @work is no longer busy, try_to_grab_pending() will
2909 * return -ENOENT as @work is still being canceled and the
2910 * other canceling task won't be able to clear CANCELING as
2911 * we're hogging the CPU.
2912 *
2913 * Let's wait for completion using a waitqueue. As this
2914 * may lead to the thundering herd problem, use a custom
2915 * wake function which matches @work along with exclusive
2916 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002917 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002918 if (unlikely(ret == -ENOENT)) {
2919 struct cwt_wait cwait;
2920
2921 init_wait(&cwait.wait);
2922 cwait.wait.func = cwt_wakefn;
2923 cwait.work = work;
2924
2925 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2926 TASK_UNINTERRUPTIBLE);
2927 if (work_is_canceling(work))
2928 schedule();
2929 finish_wait(&cancel_waitq, &cwait.wait);
2930 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002931 } while (unlikely(ret < 0));
2932
Tejun Heobbb68df2012-08-03 10:30:46 -07002933 /* tell other tasks trying to grab @work to back off */
2934 mark_work_canceling(work);
2935 local_irq_restore(flags);
2936
Tejun Heo3347fa02016-09-16 15:49:32 -04002937 /*
2938 * This allows canceling during early boot. We know that @work
2939 * isn't executing.
2940 */
2941 if (wq_online)
2942 flush_work(work);
2943
Tejun Heo7a22ad72010-06-29 10:07:13 +02002944 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002945
2946 /*
2947 * Paired with prepare_to_wait() above so that either
2948 * waitqueue_active() is visible here or !work_is_canceling() is
2949 * visible there.
2950 */
2951 smp_mb();
2952 if (waitqueue_active(&cancel_waitq))
2953 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2954
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002955 return ret;
2956}
2957
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002958/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002959 * cancel_work_sync - cancel a work and wait for it to finish
2960 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002961 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 * Cancel @work and wait for its execution to finish. This function
2963 * can be used even if the work re-queues itself or migrates to
2964 * another workqueue. On return from this function, @work is
2965 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002966 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002967 * cancel_work_sync(&delayed_work->work) must not be used for
2968 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002969 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002970 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002971 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002972 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002973 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002974 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002975 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002976bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977{
Tejun Heo36e227d2012-08-03 10:30:46 -07002978 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002979}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002980EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002981
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002982/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002983 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2984 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002985 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002986 * Delayed timer is cancelled and the pending work is queued for
2987 * immediate execution. Like flush_work(), this function only
2988 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002989 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002990 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002991 * %true if flush_work() waited for the work to finish execution,
2992 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002993 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002994bool flush_delayed_work(struct delayed_work *dwork)
2995{
Tejun Heo8930cab2012-08-03 10:30:45 -07002996 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002997 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002998 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002999 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003000 return flush_work(&dwork->work);
3001}
3002EXPORT_SYMBOL(flush_delayed_work);
3003
Jens Axboef72b8792016-08-24 15:51:50 -06003004static bool __cancel_work(struct work_struct *work, bool is_dwork)
3005{
3006 unsigned long flags;
3007 int ret;
3008
3009 do {
3010 ret = try_to_grab_pending(work, is_dwork, &flags);
3011 } while (unlikely(ret == -EAGAIN));
3012
3013 if (unlikely(ret < 0))
3014 return false;
3015
3016 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3017 local_irq_restore(flags);
3018 return ret;
3019}
3020
3021/*
3022 * See cancel_delayed_work()
3023 */
3024bool cancel_work(struct work_struct *work)
3025{
3026 return __cancel_work(work, false);
3027}
3028
Tejun Heo401a8d02010-09-16 10:36:00 +02003029/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003030 * cancel_delayed_work - cancel a delayed work
3031 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003032 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003033 * Kill off a pending delayed_work.
3034 *
3035 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3036 * pending.
3037 *
3038 * Note:
3039 * The work callback function may still be running on return, unless
3040 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3041 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003042 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003043 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003044 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003045bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003046{
Jens Axboef72b8792016-08-24 15:51:50 -06003047 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003048}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003049EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003050
3051/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003052 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3053 * @dwork: the delayed work cancel
3054 *
3055 * This is cancel_work_sync() for delayed works.
3056 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003057 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003058 * %true if @dwork was pending, %false otherwise.
3059 */
3060bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003061{
Tejun Heo36e227d2012-08-03 10:30:46 -07003062 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003063}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003064EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003066/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003067 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003068 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003069 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003070 * schedule_on_each_cpu() executes @func on each online CPU using the
3071 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003072 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003073 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003074 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003075 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003076 */
David Howells65f27f32006-11-22 14:55:48 +00003077int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003078{
3079 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003080 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003081
Andrew Mortonb6136772006-06-25 05:47:49 -07003082 works = alloc_percpu(struct work_struct);
3083 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003084 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003085
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003086 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003087
Christoph Lameter15316ba82006-01-08 01:00:43 -08003088 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003089 struct work_struct *work = per_cpu_ptr(works, cpu);
3090
3091 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003092 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003093 }
Tejun Heo93981802009-11-17 14:06:20 -08003094
3095 for_each_online_cpu(cpu)
3096 flush_work(per_cpu_ptr(works, cpu));
3097
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003098 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003099 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003100 return 0;
3101}
3102
Alan Sterneef6a7d2010-02-12 17:39:21 +09003103/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003104 * execute_in_process_context - reliably execute the routine with user context
3105 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003106 * @ew: guaranteed storage for the execute work structure (must
3107 * be available when the work executes)
3108 *
3109 * Executes the function immediately if process context is available,
3110 * otherwise schedules the function for delayed execution.
3111 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003112 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003113 * 1 - function was scheduled for execution
3114 */
David Howells65f27f32006-11-22 14:55:48 +00003115int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003116{
3117 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003118 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003119 return 0;
3120 }
3121
David Howells65f27f32006-11-22 14:55:48 +00003122 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003123 schedule_work(&ew->work);
3124
3125 return 1;
3126}
3127EXPORT_SYMBOL_GPL(execute_in_process_context);
3128
Tejun Heo7a4e3442013-03-12 11:30:00 -07003129/**
3130 * free_workqueue_attrs - free a workqueue_attrs
3131 * @attrs: workqueue_attrs to free
3132 *
3133 * Undo alloc_workqueue_attrs().
3134 */
3135void free_workqueue_attrs(struct workqueue_attrs *attrs)
3136{
3137 if (attrs) {
3138 free_cpumask_var(attrs->cpumask);
3139 kfree(attrs);
3140 }
3141}
3142
3143/**
3144 * alloc_workqueue_attrs - allocate a workqueue_attrs
3145 * @gfp_mask: allocation mask to use
3146 *
3147 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003148 * return it.
3149 *
3150 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003151 */
3152struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3153{
3154 struct workqueue_attrs *attrs;
3155
3156 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3157 if (!attrs)
3158 goto fail;
3159 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3160 goto fail;
3161
Tejun Heo13e2e552013-04-01 11:23:31 -07003162 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003163 return attrs;
3164fail:
3165 free_workqueue_attrs(attrs);
3166 return NULL;
3167}
3168
Tejun Heo29c91e92013-03-12 11:30:03 -07003169static void copy_workqueue_attrs(struct workqueue_attrs *to,
3170 const struct workqueue_attrs *from)
3171{
3172 to->nice = from->nice;
3173 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003174 /*
3175 * Unlike hash and equality test, this function doesn't ignore
3176 * ->no_numa as it is used for both pool and wq attrs. Instead,
3177 * get_unbound_pool() explicitly clears ->no_numa after copying.
3178 */
3179 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003180}
3181
Tejun Heo29c91e92013-03-12 11:30:03 -07003182/* hash value of the content of @attr */
3183static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3184{
3185 u32 hash = 0;
3186
3187 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003188 hash = jhash(cpumask_bits(attrs->cpumask),
3189 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003190 return hash;
3191}
3192
3193/* content equality test */
3194static bool wqattrs_equal(const struct workqueue_attrs *a,
3195 const struct workqueue_attrs *b)
3196{
3197 if (a->nice != b->nice)
3198 return false;
3199 if (!cpumask_equal(a->cpumask, b->cpumask))
3200 return false;
3201 return true;
3202}
3203
Tejun Heo7a4e3442013-03-12 11:30:00 -07003204/**
3205 * init_worker_pool - initialize a newly zalloc'd worker_pool
3206 * @pool: worker_pool to initialize
3207 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303208 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003209 *
3210 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003211 * inside @pool proper are initialized and put_unbound_pool() can be called
3212 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003213 */
3214static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003215{
3216 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003217 pool->id = -1;
3218 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003219 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003220 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003221 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003222 INIT_LIST_HEAD(&pool->worklist);
3223 INIT_LIST_HEAD(&pool->idle_list);
3224 hash_init(pool->busy_hash);
3225
Kees Cook32a6c722017-10-16 15:58:25 -07003226 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003227
Kees Cook32a6c722017-10-16 15:58:25 -07003228 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003229
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003230 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003231 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003232
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003233 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003234 INIT_HLIST_NODE(&pool->hash_node);
3235 pool->refcnt = 1;
3236
3237 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003238 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3239 if (!pool->attrs)
3240 return -ENOMEM;
3241 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003242}
3243
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003244static void rcu_free_wq(struct rcu_head *rcu)
3245{
3246 struct workqueue_struct *wq =
3247 container_of(rcu, struct workqueue_struct, rcu);
3248
3249 if (!(wq->flags & WQ_UNBOUND))
3250 free_percpu(wq->cpu_pwqs);
3251 else
3252 free_workqueue_attrs(wq->unbound_attrs);
3253
3254 kfree(wq->rescuer);
3255 kfree(wq);
3256}
3257
Tejun Heo29c91e92013-03-12 11:30:03 -07003258static void rcu_free_pool(struct rcu_head *rcu)
3259{
3260 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3261
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003262 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003263 free_workqueue_attrs(pool->attrs);
3264 kfree(pool);
3265}
3266
3267/**
3268 * put_unbound_pool - put a worker_pool
3269 * @pool: worker_pool to put
3270 *
3271 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003272 * safe manner. get_unbound_pool() calls this function on its failure path
3273 * and this function should be able to release pools which went through,
3274 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003275 *
3276 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003277 */
3278static void put_unbound_pool(struct worker_pool *pool)
3279{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003280 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003281 struct worker *worker;
3282
Tejun Heoa892cac2013-04-01 11:23:32 -07003283 lockdep_assert_held(&wq_pool_mutex);
3284
3285 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003286 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003287
3288 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003289 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003290 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003291 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003292
3293 /* release id and unhash */
3294 if (pool->id >= 0)
3295 idr_remove(&worker_pool_idr, pool->id);
3296 hash_del(&pool->hash_node);
3297
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003298 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003299 * Become the manager and destroy all workers. This prevents
3300 * @pool's workers from blocking on attach_mutex. We're the last
3301 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003302 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003303 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003304 wait_event_lock_irq(wq_manager_wait,
3305 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3306 pool->flags |= POOL_MANAGER_ACTIVE;
3307
Lai Jiangshan1037de32014-05-22 16:44:07 +08003308 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003309 destroy_worker(worker);
3310 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003311 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003312
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003313 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003314 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003315 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003316 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003317
3318 if (pool->detach_completion)
3319 wait_for_completion(pool->detach_completion);
3320
Tejun Heo29c91e92013-03-12 11:30:03 -07003321 /* shut down the timers */
3322 del_timer_sync(&pool->idle_timer);
3323 del_timer_sync(&pool->mayday_timer);
3324
3325 /* sched-RCU protected to allow dereferences from get_work_pool() */
3326 call_rcu_sched(&pool->rcu, rcu_free_pool);
3327}
3328
3329/**
3330 * get_unbound_pool - get a worker_pool with the specified attributes
3331 * @attrs: the attributes of the worker_pool to get
3332 *
3333 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3334 * reference count and return it. If there already is a matching
3335 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003336 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003337 *
3338 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003339 *
3340 * Return: On success, a worker_pool with the same attributes as @attrs.
3341 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003342 */
3343static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3344{
Tejun Heo29c91e92013-03-12 11:30:03 -07003345 u32 hash = wqattrs_hash(attrs);
3346 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003347 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003348 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003349
Tejun Heoa892cac2013-04-01 11:23:32 -07003350 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003351
3352 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003353 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3354 if (wqattrs_equal(pool->attrs, attrs)) {
3355 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003356 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003357 }
3358 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003359
Xunlei Pange22735842015-10-09 11:53:12 +08003360 /* if cpumask is contained inside a NUMA node, we belong to that node */
3361 if (wq_numa_enabled) {
3362 for_each_node(node) {
3363 if (cpumask_subset(attrs->cpumask,
3364 wq_numa_possible_cpumask[node])) {
3365 target_node = node;
3366 break;
3367 }
3368 }
3369 }
3370
Tejun Heo29c91e92013-03-12 11:30:03 -07003371 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003372 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003373 if (!pool || init_worker_pool(pool) < 0)
3374 goto fail;
3375
Tejun Heo8864b4e2013-03-12 11:30:04 -07003376 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003377 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003378 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003379
Shaohua Li2865a8f2013-08-01 09:56:36 +08003380 /*
3381 * no_numa isn't a worker_pool attribute, always clear it. See
3382 * 'struct workqueue_attrs' comments for detail.
3383 */
3384 pool->attrs->no_numa = false;
3385
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 if (worker_pool_assign_id(pool) < 0)
3387 goto fail;
3388
3389 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003390 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003391 goto fail;
3392
Tejun Heo29c91e92013-03-12 11:30:03 -07003393 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003394 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003395
Tejun Heo29c91e92013-03-12 11:30:03 -07003396 return pool;
3397fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003398 if (pool)
3399 put_unbound_pool(pool);
3400 return NULL;
3401}
3402
Tejun Heo8864b4e2013-03-12 11:30:04 -07003403static void rcu_free_pwq(struct rcu_head *rcu)
3404{
3405 kmem_cache_free(pwq_cache,
3406 container_of(rcu, struct pool_workqueue, rcu));
3407}
3408
3409/*
3410 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3411 * and needs to be destroyed.
3412 */
3413static void pwq_unbound_release_workfn(struct work_struct *work)
3414{
3415 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3416 unbound_release_work);
3417 struct workqueue_struct *wq = pwq->wq;
3418 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003419 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003420
3421 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3422 return;
3423
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003424 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003425 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003426 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003427 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003428
Tejun Heoa892cac2013-04-01 11:23:32 -07003429 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003430 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003431 mutex_unlock(&wq_pool_mutex);
3432
Tejun Heo8864b4e2013-03-12 11:30:04 -07003433 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3434
3435 /*
3436 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003437 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003438 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003439 if (is_last)
3440 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003441}
3442
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003443/**
Tejun Heo699ce092013-03-13 16:51:35 -07003444 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003445 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003446 *
Tejun Heo699ce092013-03-13 16:51:35 -07003447 * If @pwq isn't freezing, set @pwq->max_active to the associated
3448 * workqueue's saved_max_active and activate delayed work items
3449 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003450 */
Tejun Heo699ce092013-03-13 16:51:35 -07003451static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003452{
Tejun Heo699ce092013-03-13 16:51:35 -07003453 struct workqueue_struct *wq = pwq->wq;
3454 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003455 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003456
Tejun Heo699ce092013-03-13 16:51:35 -07003457 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003458 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003459
3460 /* fast exit for non-freezable wqs */
3461 if (!freezable && pwq->max_active == wq->saved_max_active)
3462 return;
3463
Tejun Heo3347fa02016-09-16 15:49:32 -04003464 /* this function can be called during early boot w/ irq disabled */
3465 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003466
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003467 /*
3468 * During [un]freezing, the caller is responsible for ensuring that
3469 * this function is called at least once after @workqueue_freezing
3470 * is updated and visible.
3471 */
3472 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003473 pwq->max_active = wq->saved_max_active;
3474
3475 while (!list_empty(&pwq->delayed_works) &&
3476 pwq->nr_active < pwq->max_active)
3477 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003478
3479 /*
3480 * Need to kick a worker after thawed or an unbound wq's
3481 * max_active is bumped. It's a slow path. Do it always.
3482 */
3483 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003484 } else {
3485 pwq->max_active = 0;
3486 }
3487
Tejun Heo3347fa02016-09-16 15:49:32 -04003488 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003489}
3490
Tejun Heoe50aba92013-04-01 11:23:35 -07003491/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003492static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3493 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003494{
3495 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3496
Tejun Heoe50aba92013-04-01 11:23:35 -07003497 memset(pwq, 0, sizeof(*pwq));
3498
Tejun Heod2c1d402013-03-12 11:30:04 -07003499 pwq->pool = pool;
3500 pwq->wq = wq;
3501 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003502 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003503 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003504 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003505 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003506 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003507}
Tejun Heod2c1d402013-03-12 11:30:04 -07003508
Tejun Heof147f292013-04-01 11:23:35 -07003509/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003510static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003511{
3512 struct workqueue_struct *wq = pwq->wq;
3513
3514 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003515
Tejun Heo1befcf32013-04-01 11:23:35 -07003516 /* may be called multiple times, ignore if already linked */
3517 if (!list_empty(&pwq->pwqs_node))
3518 return;
3519
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003520 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003521 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003522
3523 /* sync max_active to the current setting */
3524 pwq_adjust_max_active(pwq);
3525
3526 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003527 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003528}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003529
Tejun Heof147f292013-04-01 11:23:35 -07003530/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3531static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3532 const struct workqueue_attrs *attrs)
3533{
3534 struct worker_pool *pool;
3535 struct pool_workqueue *pwq;
3536
3537 lockdep_assert_held(&wq_pool_mutex);
3538
3539 pool = get_unbound_pool(attrs);
3540 if (!pool)
3541 return NULL;
3542
Tejun Heoe50aba92013-04-01 11:23:35 -07003543 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003544 if (!pwq) {
3545 put_unbound_pool(pool);
3546 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003547 }
Tejun Heo6029a912013-04-01 11:23:34 -07003548
Tejun Heof147f292013-04-01 11:23:35 -07003549 init_pwq(pwq, wq, pool);
3550 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003551}
3552
Tejun Heo4c16bd32013-04-01 11:23:36 -07003553/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003554 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003555 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003556 * @node: the target NUMA node
3557 * @cpu_going_down: if >= 0, the CPU to consider as offline
3558 * @cpumask: outarg, the resulting cpumask
3559 *
3560 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3561 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003562 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003563 *
3564 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3565 * enabled and @node has online CPUs requested by @attrs, the returned
3566 * cpumask is the intersection of the possible CPUs of @node and
3567 * @attrs->cpumask.
3568 *
3569 * The caller is responsible for ensuring that the cpumask of @node stays
3570 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003571 *
3572 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3573 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003574 */
3575static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3576 int cpu_going_down, cpumask_t *cpumask)
3577{
Tejun Heod55262c2013-04-01 11:23:38 -07003578 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003579 goto use_dfl;
3580
3581 /* does @node have any online CPUs @attrs wants? */
3582 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3583 if (cpu_going_down >= 0)
3584 cpumask_clear_cpu(cpu_going_down, cpumask);
3585
3586 if (cpumask_empty(cpumask))
3587 goto use_dfl;
3588
3589 /* yeap, return possible CPUs in @node that @attrs wants */
3590 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003591
3592 if (cpumask_empty(cpumask)) {
3593 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3594 "possible intersect\n");
3595 return false;
3596 }
3597
Tejun Heo4c16bd32013-04-01 11:23:36 -07003598 return !cpumask_equal(cpumask, attrs->cpumask);
3599
3600use_dfl:
3601 cpumask_copy(cpumask, attrs->cpumask);
3602 return false;
3603}
3604
Tejun Heo1befcf32013-04-01 11:23:35 -07003605/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3606static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3607 int node,
3608 struct pool_workqueue *pwq)
3609{
3610 struct pool_workqueue *old_pwq;
3611
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003612 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003613 lockdep_assert_held(&wq->mutex);
3614
3615 /* link_pwq() can handle duplicate calls */
3616 link_pwq(pwq);
3617
3618 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3619 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3620 return old_pwq;
3621}
3622
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003623/* context to store the prepared attrs & pwqs before applying */
3624struct apply_wqattrs_ctx {
3625 struct workqueue_struct *wq; /* target workqueue */
3626 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003627 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003628 struct pool_workqueue *dfl_pwq;
3629 struct pool_workqueue *pwq_tbl[];
3630};
3631
3632/* free the resources after success or abort */
3633static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3634{
3635 if (ctx) {
3636 int node;
3637
3638 for_each_node(node)
3639 put_pwq_unlocked(ctx->pwq_tbl[node]);
3640 put_pwq_unlocked(ctx->dfl_pwq);
3641
3642 free_workqueue_attrs(ctx->attrs);
3643
3644 kfree(ctx);
3645 }
3646}
3647
3648/* allocate the attrs and pwqs for later installation */
3649static struct apply_wqattrs_ctx *
3650apply_wqattrs_prepare(struct workqueue_struct *wq,
3651 const struct workqueue_attrs *attrs)
3652{
3653 struct apply_wqattrs_ctx *ctx;
3654 struct workqueue_attrs *new_attrs, *tmp_attrs;
3655 int node;
3656
3657 lockdep_assert_held(&wq_pool_mutex);
3658
3659 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3660 GFP_KERNEL);
3661
3662 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3663 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3664 if (!ctx || !new_attrs || !tmp_attrs)
3665 goto out_free;
3666
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003667 /*
3668 * Calculate the attrs of the default pwq.
3669 * If the user configured cpumask doesn't overlap with the
3670 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3671 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003672 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003673 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003674 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3675 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003676
3677 /*
3678 * We may create multiple pwqs with differing cpumasks. Make a
3679 * copy of @new_attrs which will be modified and used to obtain
3680 * pools.
3681 */
3682 copy_workqueue_attrs(tmp_attrs, new_attrs);
3683
3684 /*
3685 * If something goes wrong during CPU up/down, we'll fall back to
3686 * the default pwq covering whole @attrs->cpumask. Always create
3687 * it even if we don't use it immediately.
3688 */
3689 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3690 if (!ctx->dfl_pwq)
3691 goto out_free;
3692
3693 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003694 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003695 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3696 if (!ctx->pwq_tbl[node])
3697 goto out_free;
3698 } else {
3699 ctx->dfl_pwq->refcnt++;
3700 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3701 }
3702 }
3703
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003704 /* save the user configured attrs and sanitize it. */
3705 copy_workqueue_attrs(new_attrs, attrs);
3706 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003707 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003708
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003709 ctx->wq = wq;
3710 free_workqueue_attrs(tmp_attrs);
3711 return ctx;
3712
3713out_free:
3714 free_workqueue_attrs(tmp_attrs);
3715 free_workqueue_attrs(new_attrs);
3716 apply_wqattrs_cleanup(ctx);
3717 return NULL;
3718}
3719
3720/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3721static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3722{
3723 int node;
3724
3725 /* all pwqs have been created successfully, let's install'em */
3726 mutex_lock(&ctx->wq->mutex);
3727
3728 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3729
3730 /* save the previous pwq and install the new one */
3731 for_each_node(node)
3732 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3733 ctx->pwq_tbl[node]);
3734
3735 /* @dfl_pwq might not have been used, ensure it's linked */
3736 link_pwq(ctx->dfl_pwq);
3737 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3738
3739 mutex_unlock(&ctx->wq->mutex);
3740}
3741
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003742static void apply_wqattrs_lock(void)
3743{
3744 /* CPUs should stay stable across pwq creations and installations */
3745 get_online_cpus();
3746 mutex_lock(&wq_pool_mutex);
3747}
3748
3749static void apply_wqattrs_unlock(void)
3750{
3751 mutex_unlock(&wq_pool_mutex);
3752 put_online_cpus();
3753}
3754
3755static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3756 const struct workqueue_attrs *attrs)
3757{
3758 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003759
3760 /* only unbound workqueues can change attributes */
3761 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3762 return -EINVAL;
3763
3764 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003765 if (!list_empty(&wq->pwqs)) {
3766 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3767 return -EINVAL;
3768
3769 wq->flags &= ~__WQ_ORDERED;
3770 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003771
3772 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003773 if (!ctx)
3774 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003775
3776 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003777 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003778 apply_wqattrs_cleanup(ctx);
3779
wanghaibin62011712016-01-07 20:38:59 +08003780 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003781}
3782
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003783/**
3784 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3785 * @wq: the target workqueue
3786 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3787 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003788 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3789 * machines, this function maps a separate pwq to each NUMA node with
3790 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3791 * NUMA node it was issued on. Older pwqs are released as in-flight work
3792 * items finish. Note that a work item which repeatedly requeues itself
3793 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003794 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003795 * Performs GFP_KERNEL allocations.
3796 *
3797 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003798 */
3799int apply_workqueue_attrs(struct workqueue_struct *wq,
3800 const struct workqueue_attrs *attrs)
3801{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003802 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003803
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003804 apply_wqattrs_lock();
3805 ret = apply_workqueue_attrs_locked(wq, attrs);
3806 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003807
Tejun Heo48621252013-04-01 11:23:31 -07003808 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003809}
3810
Tejun Heo4c16bd32013-04-01 11:23:36 -07003811/**
3812 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3813 * @wq: the target workqueue
3814 * @cpu: the CPU coming up or going down
3815 * @online: whether @cpu is coming up or going down
3816 *
3817 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3818 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3819 * @wq accordingly.
3820 *
3821 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3822 * falls back to @wq->dfl_pwq which may not be optimal but is always
3823 * correct.
3824 *
3825 * Note that when the last allowed CPU of a NUMA node goes offline for a
3826 * workqueue with a cpumask spanning multiple nodes, the workers which were
3827 * already executing the work items for the workqueue will lose their CPU
3828 * affinity and may execute on any CPU. This is similar to how per-cpu
3829 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3830 * affinity, it's the user's responsibility to flush the work item from
3831 * CPU_DOWN_PREPARE.
3832 */
3833static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3834 bool online)
3835{
3836 int node = cpu_to_node(cpu);
3837 int cpu_off = online ? -1 : cpu;
3838 struct pool_workqueue *old_pwq = NULL, *pwq;
3839 struct workqueue_attrs *target_attrs;
3840 cpumask_t *cpumask;
3841
3842 lockdep_assert_held(&wq_pool_mutex);
3843
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003844 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3845 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003846 return;
3847
3848 /*
3849 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3850 * Let's use a preallocated one. The following buf is protected by
3851 * CPU hotplug exclusion.
3852 */
3853 target_attrs = wq_update_unbound_numa_attrs_buf;
3854 cpumask = target_attrs->cpumask;
3855
Tejun Heo4c16bd32013-04-01 11:23:36 -07003856 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3857 pwq = unbound_pwq_by_node(wq, node);
3858
3859 /*
3860 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003861 * different from the default pwq's, we need to compare it to @pwq's
3862 * and create a new one if they don't match. If the target cpumask
3863 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003864 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003865 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003866 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003867 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003868 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003869 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003870 }
3871
Tejun Heo4c16bd32013-04-01 11:23:36 -07003872 /* create a new pwq */
3873 pwq = alloc_unbound_pwq(wq, target_attrs);
3874 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003875 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3876 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003877 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003878 }
3879
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003880 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003881 mutex_lock(&wq->mutex);
3882 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3883 goto out_unlock;
3884
3885use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003886 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003887 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3888 get_pwq(wq->dfl_pwq);
3889 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3890 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3891out_unlock:
3892 mutex_unlock(&wq->mutex);
3893 put_pwq_unlocked(old_pwq);
3894}
3895
Tejun Heo30cdf2492013-03-12 11:29:57 -07003896static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003897{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003898 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003899 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003900
Tejun Heo30cdf2492013-03-12 11:29:57 -07003901 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003902 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3903 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003904 return -ENOMEM;
3905
3906 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003907 struct pool_workqueue *pwq =
3908 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003909 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003910 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003911
Tejun Heof147f292013-04-01 11:23:35 -07003912 init_pwq(pwq, wq, &cpu_pools[highpri]);
3913
3914 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003915 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003916 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003917 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003918 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003919 } else if (wq->flags & __WQ_ORDERED) {
3920 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3921 /* there should only be single pwq for ordering guarantee */
3922 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3923 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3924 "ordering guarantee broken for workqueue %s\n", wq->name);
3925 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003926 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003927 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003928 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003929}
3930
Tejun Heof3421792010-07-02 10:03:51 +02003931static int wq_clamp_max_active(int max_active, unsigned int flags,
3932 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003933{
Tejun Heof3421792010-07-02 10:03:51 +02003934 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3935
3936 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003937 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3938 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003939
Tejun Heof3421792010-07-02 10:03:51 +02003940 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003941}
3942
Tejun Heob196be82012-01-10 15:11:35 -08003943struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003944 unsigned int flags,
3945 int max_active,
3946 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003947 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003948{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003949 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003950 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003951 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003952 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003953
Tejun Heo5c0338c2017-07-18 18:41:52 -04003954 /*
3955 * Unbound && max_active == 1 used to imply ordered, which is no
3956 * longer the case on NUMA machines due to per-node pools. While
3957 * alloc_ordered_workqueue() is the right way to create an ordered
3958 * workqueue, keep the previous behavior to avoid subtle breakages
3959 * on NUMA.
3960 */
3961 if ((flags & WQ_UNBOUND) && max_active == 1)
3962 flags |= __WQ_ORDERED;
3963
Viresh Kumarcee22a12013-04-08 16:45:40 +05303964 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3965 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3966 flags |= WQ_UNBOUND;
3967
Tejun Heoecf68812013-04-01 11:23:34 -07003968 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003969 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003970 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003971
3972 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003973 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003974 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003975
Tejun Heo6029a912013-04-01 11:23:34 -07003976 if (flags & WQ_UNBOUND) {
3977 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3978 if (!wq->unbound_attrs)
3979 goto err_free_wq;
3980 }
3981
Tejun Heoecf68812013-04-01 11:23:34 -07003982 va_start(args, lock_name);
3983 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003984 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003985
Tejun Heod320c032010-06-29 10:07:14 +02003986 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003987 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003988
Tejun Heob196be82012-01-10 15:11:35 -08003989 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003990 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003991 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003992 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003993 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003994 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003995 INIT_LIST_HEAD(&wq->flusher_queue);
3996 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003997 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003998
Johannes Bergeb13ba82008-01-16 09:51:58 +01003999 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004000 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004001
Tejun Heo30cdf2492013-03-12 11:29:57 -07004002 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004003 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004004
Tejun Heo493008a2013-03-12 11:30:03 -07004005 /*
4006 * Workqueues which may be used during memory reclaim should
4007 * have a rescuer to guarantee forward progress.
4008 */
4009 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004010 struct worker *rescuer;
4011
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004012 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004013 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004014 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004015
Tejun Heo111c2252013-01-17 17:16:24 -08004016 rescuer->rescue_wq = wq;
4017 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004018 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004019 if (IS_ERR(rescuer->task)) {
4020 kfree(rescuer);
4021 goto err_destroy;
4022 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004023
Tejun Heod2c1d402013-03-12 11:30:04 -07004024 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004025 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004026 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004027 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004028
Tejun Heo226223a2013-03-12 11:30:05 -07004029 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4030 goto err_destroy;
4031
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004032 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004033 * wq_pool_mutex protects global freeze state and workqueues list.
4034 * Grab it, adjust max_active and add the new @wq to workqueues
4035 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004036 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004037 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004038
Lai Jiangshana357fc02013-03-25 16:57:19 -07004039 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004040 for_each_pwq(pwq, wq)
4041 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004042 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004043
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004044 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004045
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004046 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004047
Oleg Nesterov3af244332007-05-09 02:34:09 -07004048 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004049
4050err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004051 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004052 kfree(wq);
4053 return NULL;
4054err_destroy:
4055 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004056 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004057}
Tejun Heod320c032010-06-29 10:07:14 +02004058EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004059
4060/**
4061 * destroy_workqueue - safely terminate a workqueue
4062 * @wq: target workqueue
4063 *
4064 * Safely destroy a workqueue. All work currently pending will be done first.
4065 */
4066void destroy_workqueue(struct workqueue_struct *wq)
4067{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004068 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004069 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004070
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004071 /* drain it before proceeding with destruction */
4072 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004073
Tejun Heo6183c002013-03-12 11:29:57 -07004074 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004075 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004076 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004077 int i;
4078
Tejun Heo76af4d92013-03-12 11:30:00 -07004079 for (i = 0; i < WORK_NR_COLORS; i++) {
4080 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004081 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004082 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004083 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004084 }
4085 }
4086
Lai Jiangshan5c529592013-04-04 10:05:38 +08004087 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004088 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004089 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004090 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004091 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004092 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004093 }
Tejun Heo6183c002013-03-12 11:29:57 -07004094 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004095 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004096
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004097 /*
4098 * wq list is used to freeze wq, remove from list after
4099 * flushing is complete in case freeze races us.
4100 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004101 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004102 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004103 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004104
Tejun Heo226223a2013-03-12 11:30:05 -07004105 workqueue_sysfs_unregister(wq);
4106
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004107 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004108 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004109
Tejun Heo8864b4e2013-03-12 11:30:04 -07004110 if (!(wq->flags & WQ_UNBOUND)) {
4111 /*
4112 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004113 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004114 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004115 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004116 } else {
4117 /*
4118 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004119 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4120 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004121 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004122 for_each_node(node) {
4123 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4124 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4125 put_pwq_unlocked(pwq);
4126 }
4127
4128 /*
4129 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4130 * put. Don't access it afterwards.
4131 */
4132 pwq = wq->dfl_pwq;
4133 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004134 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004135 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004136}
4137EXPORT_SYMBOL_GPL(destroy_workqueue);
4138
Tejun Heodcd989c2010-06-29 10:07:14 +02004139/**
4140 * workqueue_set_max_active - adjust max_active of a workqueue
4141 * @wq: target workqueue
4142 * @max_active: new max_active value.
4143 *
4144 * Set max_active of @wq to @max_active.
4145 *
4146 * CONTEXT:
4147 * Don't call from IRQ context.
4148 */
4149void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4150{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004151 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004152
Tejun Heo8719dce2013-03-12 11:30:04 -07004153 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004154 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004155 return;
4156
Tejun Heof3421792010-07-02 10:03:51 +02004157 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004158
Lai Jiangshana357fc02013-03-25 16:57:19 -07004159 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004160
Tejun Heo0a94efb2017-07-23 08:36:15 -04004161 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004162 wq->saved_max_active = max_active;
4163
Tejun Heo699ce092013-03-13 16:51:35 -07004164 for_each_pwq(pwq, wq)
4165 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004166
Lai Jiangshana357fc02013-03-25 16:57:19 -07004167 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004168}
4169EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4170
4171/**
Tejun Heoe62676162013-03-12 17:41:37 -07004172 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4173 *
4174 * Determine whether %current is a workqueue rescuer. Can be used from
4175 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004176 *
4177 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004178 */
4179bool current_is_workqueue_rescuer(void)
4180{
4181 struct worker *worker = current_wq_worker();
4182
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004183 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004184}
4185
4186/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004187 * workqueue_congested - test whether a workqueue is congested
4188 * @cpu: CPU in question
4189 * @wq: target workqueue
4190 *
4191 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4192 * no synchronization around this function and the test result is
4193 * unreliable and only useful as advisory hints or for debugging.
4194 *
Tejun Heod3251852013-05-10 11:10:17 -07004195 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4196 * Note that both per-cpu and unbound workqueues may be associated with
4197 * multiple pool_workqueues which have separate congested states. A
4198 * workqueue being congested on one CPU doesn't mean the workqueue is also
4199 * contested on other CPUs / NUMA nodes.
4200 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004201 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004202 * %true if congested, %false otherwise.
4203 */
Tejun Heod84ff052013-03-12 11:29:59 -07004204bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004205{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004206 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004207 bool ret;
4208
Lai Jiangshan88109452013-03-20 03:28:10 +08004209 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004210
Tejun Heod3251852013-05-10 11:10:17 -07004211 if (cpu == WORK_CPU_UNBOUND)
4212 cpu = smp_processor_id();
4213
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004214 if (!(wq->flags & WQ_UNBOUND))
4215 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4216 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004217 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004218
Tejun Heo76af4d92013-03-12 11:30:00 -07004219 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004220 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004221
4222 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004223}
4224EXPORT_SYMBOL_GPL(workqueue_congested);
4225
4226/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004227 * work_busy - test whether a work is currently pending or running
4228 * @work: the work to be tested
4229 *
4230 * Test whether @work is currently pending or running. There is no
4231 * synchronization around this function and the test result is
4232 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004233 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004234 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004235 * OR'd bitmask of WORK_BUSY_* bits.
4236 */
4237unsigned int work_busy(struct work_struct *work)
4238{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004239 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004240 unsigned long flags;
4241 unsigned int ret = 0;
4242
Tejun Heodcd989c2010-06-29 10:07:14 +02004243 if (work_pending(work))
4244 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004245
Tejun Heofa1b54e2013-03-12 11:30:00 -07004246 local_irq_save(flags);
4247 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004248 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004249 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004250 if (find_worker_executing_work(pool, work))
4251 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004252 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004253 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004254 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004255
4256 return ret;
4257}
4258EXPORT_SYMBOL_GPL(work_busy);
4259
Tejun Heo3d1cb202013-04-30 15:27:22 -07004260/**
4261 * set_worker_desc - set description for the current work item
4262 * @fmt: printf-style format string
4263 * @...: arguments for the format string
4264 *
4265 * This function can be called by a running work function to describe what
4266 * the work item is about. If the worker task gets dumped, this
4267 * information will be printed out together to help debugging. The
4268 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4269 */
4270void set_worker_desc(const char *fmt, ...)
4271{
4272 struct worker *worker = current_wq_worker();
4273 va_list args;
4274
4275 if (worker) {
4276 va_start(args, fmt);
4277 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4278 va_end(args);
4279 worker->desc_valid = true;
4280 }
4281}
4282
4283/**
4284 * print_worker_info - print out worker information and description
4285 * @log_lvl: the log level to use when printing
4286 * @task: target task
4287 *
4288 * If @task is a worker and currently executing a work item, print out the
4289 * name of the workqueue being serviced and worker description set with
4290 * set_worker_desc() by the currently executing work item.
4291 *
4292 * This function can be safely called on any task as long as the
4293 * task_struct itself is accessible. While safe, this function isn't
4294 * synchronized and may print out mixups or garbages of limited length.
4295 */
4296void print_worker_info(const char *log_lvl, struct task_struct *task)
4297{
4298 work_func_t *fn = NULL;
4299 char name[WQ_NAME_LEN] = { };
4300 char desc[WORKER_DESC_LEN] = { };
4301 struct pool_workqueue *pwq = NULL;
4302 struct workqueue_struct *wq = NULL;
4303 bool desc_valid = false;
4304 struct worker *worker;
4305
4306 if (!(task->flags & PF_WQ_WORKER))
4307 return;
4308
4309 /*
4310 * This function is called without any synchronization and @task
4311 * could be in any state. Be careful with dereferences.
4312 */
Petr Mladeke7005912016-10-11 13:55:17 -07004313 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004314
4315 /*
4316 * Carefully copy the associated workqueue's workfn and name. Keep
4317 * the original last '\0' in case the original contains garbage.
4318 */
4319 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4320 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4321 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4322 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4323
4324 /* copy worker description */
4325 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4326 if (desc_valid)
4327 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4328
4329 if (fn || name[0] || desc[0]) {
4330 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4331 if (desc[0])
4332 pr_cont(" (%s)", desc);
4333 pr_cont("\n");
4334 }
4335}
4336
Tejun Heo3494fc32015-03-09 09:22:28 -04004337static void pr_cont_pool_info(struct worker_pool *pool)
4338{
4339 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4340 if (pool->node != NUMA_NO_NODE)
4341 pr_cont(" node=%d", pool->node);
4342 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4343}
4344
4345static void pr_cont_work(bool comma, struct work_struct *work)
4346{
4347 if (work->func == wq_barrier_func) {
4348 struct wq_barrier *barr;
4349
4350 barr = container_of(work, struct wq_barrier, work);
4351
4352 pr_cont("%s BAR(%d)", comma ? "," : "",
4353 task_pid_nr(barr->task));
4354 } else {
4355 pr_cont("%s %pf", comma ? "," : "", work->func);
4356 }
4357}
4358
4359static void show_pwq(struct pool_workqueue *pwq)
4360{
4361 struct worker_pool *pool = pwq->pool;
4362 struct work_struct *work;
4363 struct worker *worker;
4364 bool has_in_flight = false, has_pending = false;
4365 int bkt;
4366
4367 pr_info(" pwq %d:", pool->id);
4368 pr_cont_pool_info(pool);
4369
4370 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4371 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4372
4373 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4374 if (worker->current_pwq == pwq) {
4375 has_in_flight = true;
4376 break;
4377 }
4378 }
4379 if (has_in_flight) {
4380 bool comma = false;
4381
4382 pr_info(" in-flight:");
4383 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4384 if (worker->current_pwq != pwq)
4385 continue;
4386
4387 pr_cont("%s %d%s:%pf", comma ? "," : "",
4388 task_pid_nr(worker->task),
4389 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4390 worker->current_func);
4391 list_for_each_entry(work, &worker->scheduled, entry)
4392 pr_cont_work(false, work);
4393 comma = true;
4394 }
4395 pr_cont("\n");
4396 }
4397
4398 list_for_each_entry(work, &pool->worklist, entry) {
4399 if (get_work_pwq(work) == pwq) {
4400 has_pending = true;
4401 break;
4402 }
4403 }
4404 if (has_pending) {
4405 bool comma = false;
4406
4407 pr_info(" pending:");
4408 list_for_each_entry(work, &pool->worklist, entry) {
4409 if (get_work_pwq(work) != pwq)
4410 continue;
4411
4412 pr_cont_work(comma, work);
4413 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4414 }
4415 pr_cont("\n");
4416 }
4417
4418 if (!list_empty(&pwq->delayed_works)) {
4419 bool comma = false;
4420
4421 pr_info(" delayed:");
4422 list_for_each_entry(work, &pwq->delayed_works, entry) {
4423 pr_cont_work(comma, work);
4424 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4425 }
4426 pr_cont("\n");
4427 }
4428}
4429
4430/**
4431 * show_workqueue_state - dump workqueue state
4432 *
Roger Lu7b776af2016-07-01 11:05:02 +08004433 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4434 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004435 */
4436void show_workqueue_state(void)
4437{
4438 struct workqueue_struct *wq;
4439 struct worker_pool *pool;
4440 unsigned long flags;
4441 int pi;
4442
4443 rcu_read_lock_sched();
4444
4445 pr_info("Showing busy workqueues and worker pools:\n");
4446
4447 list_for_each_entry_rcu(wq, &workqueues, list) {
4448 struct pool_workqueue *pwq;
4449 bool idle = true;
4450
4451 for_each_pwq(pwq, wq) {
4452 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4453 idle = false;
4454 break;
4455 }
4456 }
4457 if (idle)
4458 continue;
4459
4460 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4461
4462 for_each_pwq(pwq, wq) {
4463 spin_lock_irqsave(&pwq->pool->lock, flags);
4464 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4465 show_pwq(pwq);
4466 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4467 }
4468 }
4469
4470 for_each_pool(pool, pi) {
4471 struct worker *worker;
4472 bool first = true;
4473
4474 spin_lock_irqsave(&pool->lock, flags);
4475 if (pool->nr_workers == pool->nr_idle)
4476 goto next_pool;
4477
4478 pr_info("pool %d:", pool->id);
4479 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004480 pr_cont(" hung=%us workers=%d",
4481 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4482 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004483 if (pool->manager)
4484 pr_cont(" manager: %d",
4485 task_pid_nr(pool->manager->task));
4486 list_for_each_entry(worker, &pool->idle_list, entry) {
4487 pr_cont(" %s%d", first ? "idle: " : "",
4488 task_pid_nr(worker->task));
4489 first = false;
4490 }
4491 pr_cont("\n");
4492 next_pool:
4493 spin_unlock_irqrestore(&pool->lock, flags);
4494 }
4495
4496 rcu_read_unlock_sched();
4497}
4498
Tejun Heodb7bccf2010-06-29 10:07:12 +02004499/*
4500 * CPU hotplug.
4501 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004502 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004503 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004504 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004505 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004506 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004507 * blocked draining impractical.
4508 *
Tejun Heo24647572013-01-24 11:01:33 -08004509 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004510 * running as an unbound one and allowing it to be reattached later if the
4511 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004512 */
4513
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004514static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004515{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004516 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004517 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004518
Tejun Heof02ae732013-03-12 11:30:03 -07004519 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004520 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004521 spin_lock_irq(&pool->lock);
4522
4523 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004524 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004525 * unbound and set DISASSOCIATED. Before this, all workers
4526 * except for the ones which are still executing works from
4527 * before the last CPU down must be on the cpu. After
4528 * this, they may become diasporas.
4529 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004530 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004531 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004532
Tejun Heo24647572013-01-24 11:01:33 -08004533 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004534
Tejun Heo94cf58b2013-01-24 11:01:33 -08004535 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004536 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004537
Lai Jiangshaneb283422013-03-08 15:18:28 -08004538 /*
4539 * Call schedule() so that we cross rq->lock and thus can
4540 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4541 * This is necessary as scheduler callbacks may be invoked
4542 * from other cpus.
4543 */
4544 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004545
Lai Jiangshaneb283422013-03-08 15:18:28 -08004546 /*
4547 * Sched callbacks are disabled now. Zap nr_running.
4548 * After this, nr_running stays zero and need_more_worker()
4549 * and keep_working() are always true as long as the
4550 * worklist is not empty. This pool now behaves as an
4551 * unbound (in terms of concurrency management) pool which
4552 * are served by workers tied to the pool.
4553 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004554 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004555
4556 /*
4557 * With concurrency management just turned off, a busy
4558 * worker blocking could lead to lengthy stalls. Kick off
4559 * unbound chain execution of currently pending work items.
4560 */
4561 spin_lock_irq(&pool->lock);
4562 wake_up_worker(pool);
4563 spin_unlock_irq(&pool->lock);
4564 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004565}
4566
Tejun Heobd7c0892013-03-19 13:45:21 -07004567/**
4568 * rebind_workers - rebind all workers of a pool to the associated CPU
4569 * @pool: pool of interest
4570 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004571 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004572 */
4573static void rebind_workers(struct worker_pool *pool)
4574{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004575 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004576
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004577 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004578
Tejun Heoa9ab7752013-03-19 13:45:21 -07004579 /*
4580 * Restore CPU affinity of all workers. As all idle workers should
4581 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304582 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004583 * of all workers first and then clear UNBOUND. As we're called
4584 * from CPU_ONLINE, the following shouldn't fail.
4585 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004586 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004587 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4588 pool->attrs->cpumask) < 0);
4589
4590 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004591
4592 /*
4593 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4594 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4595 * being reworked and this can go away in time.
4596 */
4597 if (!(pool->flags & POOL_DISASSOCIATED)) {
4598 spin_unlock_irq(&pool->lock);
4599 return;
4600 }
4601
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004602 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004603
Lai Jiangshanda028462014-05-20 17:46:31 +08004604 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004605 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004606
4607 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004608 * A bound idle worker should actually be on the runqueue
4609 * of the associated CPU for local wake-ups targeting it to
4610 * work. Kick all idle workers so that they migrate to the
4611 * associated CPU. Doing this in the same loop as
4612 * replacing UNBOUND with REBOUND is safe as no worker will
4613 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004614 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004615 if (worker_flags & WORKER_IDLE)
4616 wake_up_process(worker->task);
4617
4618 /*
4619 * We want to clear UNBOUND but can't directly call
4620 * worker_clr_flags() or adjust nr_running. Atomically
4621 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4622 * @worker will clear REBOUND using worker_clr_flags() when
4623 * it initiates the next execution cycle thus restoring
4624 * concurrency management. Note that when or whether
4625 * @worker clears REBOUND doesn't affect correctness.
4626 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004627 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004628 * tested without holding any lock in
4629 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4630 * fail incorrectly leading to premature concurrency
4631 * management operations.
4632 */
4633 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4634 worker_flags |= WORKER_REBOUND;
4635 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004636 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004637 }
4638
Tejun Heoa9ab7752013-03-19 13:45:21 -07004639 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004640}
4641
Tejun Heo7dbc7252013-03-19 13:45:21 -07004642/**
4643 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4644 * @pool: unbound pool of interest
4645 * @cpu: the CPU which is coming up
4646 *
4647 * An unbound pool may end up with a cpumask which doesn't have any online
4648 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4649 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4650 * online CPU before, cpus_allowed of all its workers should be restored.
4651 */
4652static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4653{
4654 static cpumask_t cpumask;
4655 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004656
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004657 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004658
4659 /* is @cpu allowed for @pool? */
4660 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4661 return;
4662
Tejun Heo7dbc7252013-03-19 13:45:21 -07004663 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004664
4665 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004666 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004667 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004668}
4669
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004670int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004671{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004672 struct worker_pool *pool;
4673
4674 for_each_cpu_worker_pool(pool, cpu) {
4675 if (pool->nr_workers)
4676 continue;
4677 if (!create_worker(pool))
4678 return -ENOMEM;
4679 }
4680 return 0;
4681}
4682
4683int workqueue_online_cpu(unsigned int cpu)
4684{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004685 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004686 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004687 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004688
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004689 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004690
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004691 for_each_pool(pool, pi) {
4692 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004693
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004694 if (pool->cpu == cpu)
4695 rebind_workers(pool);
4696 else if (pool->cpu < 0)
4697 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004698
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004699 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004700 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004701
4702 /* update NUMA affinity of unbound workqueues */
4703 list_for_each_entry(wq, &workqueues, list)
4704 wq_update_unbound_numa(wq, cpu, true);
4705
4706 mutex_unlock(&wq_pool_mutex);
4707 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004708}
4709
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004710int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004711{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004712 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004713
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004714 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004715 if (WARN_ON(cpu != smp_processor_id()))
4716 return -1;
4717
4718 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004719
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004720 /* update NUMA affinity of unbound workqueues */
4721 mutex_lock(&wq_pool_mutex);
4722 list_for_each_entry(wq, &workqueues, list)
4723 wq_update_unbound_numa(wq, cpu, false);
4724 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004725
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004726 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004727}
4728
Rusty Russell2d3854a2008-11-05 13:39:10 +11004729#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004730
Rusty Russell2d3854a2008-11-05 13:39:10 +11004731struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004732 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004733 long (*fn)(void *);
4734 void *arg;
4735 long ret;
4736};
4737
Tejun Heoed48ece2012-09-18 12:48:43 -07004738static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004739{
Tejun Heoed48ece2012-09-18 12:48:43 -07004740 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4741
Rusty Russell2d3854a2008-11-05 13:39:10 +11004742 wfc->ret = wfc->fn(wfc->arg);
4743}
4744
4745/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004746 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004747 * @cpu: the cpu to run on
4748 * @fn: the function to run
4749 * @arg: the function arg
4750 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004751 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004752 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004753 *
4754 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004755 */
Tejun Heod84ff052013-03-12 11:29:59 -07004756long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004757{
Tejun Heoed48ece2012-09-18 12:48:43 -07004758 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004759
Tejun Heoed48ece2012-09-18 12:48:43 -07004760 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4761 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004762 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004763 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004764 return wfc.ret;
4765}
4766EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004767
4768/**
4769 * work_on_cpu_safe - run a function in thread context on a particular cpu
4770 * @cpu: the cpu to run on
4771 * @fn: the function to run
4772 * @arg: the function argument
4773 *
4774 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4775 * any locks which would prevent @fn from completing.
4776 *
4777 * Return: The value @fn returns.
4778 */
4779long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4780{
4781 long ret = -ENODEV;
4782
4783 get_online_cpus();
4784 if (cpu_online(cpu))
4785 ret = work_on_cpu(cpu, fn, arg);
4786 put_online_cpus();
4787 return ret;
4788}
4789EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004790#endif /* CONFIG_SMP */
4791
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004792#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304793
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004794/**
4795 * freeze_workqueues_begin - begin freezing workqueues
4796 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004797 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004798 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004799 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004800 *
4801 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004802 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004803 */
4804void freeze_workqueues_begin(void)
4805{
Tejun Heo24b8a842013-03-12 11:29:58 -07004806 struct workqueue_struct *wq;
4807 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004808
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004809 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004810
Tejun Heo6183c002013-03-12 11:29:57 -07004811 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004812 workqueue_freezing = true;
4813
Tejun Heo24b8a842013-03-12 11:29:58 -07004814 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004815 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004816 for_each_pwq(pwq, wq)
4817 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004818 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004819 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004820
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004821 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004822}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004823
4824/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004825 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004826 *
4827 * Check whether freezing is complete. This function must be called
4828 * between freeze_workqueues_begin() and thaw_workqueues().
4829 *
4830 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004831 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004832 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004833 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004834 * %true if some freezable workqueues are still busy. %false if freezing
4835 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004836 */
4837bool freeze_workqueues_busy(void)
4838{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004839 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004840 struct workqueue_struct *wq;
4841 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004842
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004843 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004844
Tejun Heo6183c002013-03-12 11:29:57 -07004845 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004846
Tejun Heo24b8a842013-03-12 11:29:58 -07004847 list_for_each_entry(wq, &workqueues, list) {
4848 if (!(wq->flags & WQ_FREEZABLE))
4849 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004850 /*
4851 * nr_active is monotonically decreasing. It's safe
4852 * to peek without lock.
4853 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004854 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004855 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004856 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004857 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004858 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004859 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004860 goto out_unlock;
4861 }
4862 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004863 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004864 }
4865out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004866 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004867 return busy;
4868}
4869
4870/**
4871 * thaw_workqueues - thaw workqueues
4872 *
4873 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004874 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004875 *
4876 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004877 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004878 */
4879void thaw_workqueues(void)
4880{
Tejun Heo24b8a842013-03-12 11:29:58 -07004881 struct workqueue_struct *wq;
4882 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004883
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004884 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004885
4886 if (!workqueue_freezing)
4887 goto out_unlock;
4888
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004889 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004890
Tejun Heo24b8a842013-03-12 11:29:58 -07004891 /* restore max_active and repopulate worklist */
4892 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004893 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004894 for_each_pwq(pwq, wq)
4895 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004896 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004897 }
4898
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004899out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004900 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004901}
4902#endif /* CONFIG_FREEZER */
4903
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004904static int workqueue_apply_unbound_cpumask(void)
4905{
4906 LIST_HEAD(ctxs);
4907 int ret = 0;
4908 struct workqueue_struct *wq;
4909 struct apply_wqattrs_ctx *ctx, *n;
4910
4911 lockdep_assert_held(&wq_pool_mutex);
4912
4913 list_for_each_entry(wq, &workqueues, list) {
4914 if (!(wq->flags & WQ_UNBOUND))
4915 continue;
4916 /* creating multiple pwqs breaks ordering guarantee */
4917 if (wq->flags & __WQ_ORDERED)
4918 continue;
4919
4920 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4921 if (!ctx) {
4922 ret = -ENOMEM;
4923 break;
4924 }
4925
4926 list_add_tail(&ctx->list, &ctxs);
4927 }
4928
4929 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4930 if (!ret)
4931 apply_wqattrs_commit(ctx);
4932 apply_wqattrs_cleanup(ctx);
4933 }
4934
4935 return ret;
4936}
4937
4938/**
4939 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4940 * @cpumask: the cpumask to set
4941 *
4942 * The low-level workqueues cpumask is a global cpumask that limits
4943 * the affinity of all unbound workqueues. This function check the @cpumask
4944 * and apply it to all unbound workqueues and updates all pwqs of them.
4945 *
4946 * Retun: 0 - Success
4947 * -EINVAL - Invalid @cpumask
4948 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4949 */
4950int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4951{
4952 int ret = -EINVAL;
4953 cpumask_var_t saved_cpumask;
4954
4955 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4956 return -ENOMEM;
4957
Tal Shorerc98a9802017-11-03 17:27:50 +02004958 /*
4959 * Not excluding isolated cpus on purpose.
4960 * If the user wishes to include them, we allow that.
4961 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004962 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4963 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004964 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004965
4966 /* save the old wq_unbound_cpumask. */
4967 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4968
4969 /* update wq_unbound_cpumask at first and apply it to wqs. */
4970 cpumask_copy(wq_unbound_cpumask, cpumask);
4971 ret = workqueue_apply_unbound_cpumask();
4972
4973 /* restore the wq_unbound_cpumask when failed. */
4974 if (ret < 0)
4975 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4976
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004977 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004978 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004979
4980 free_cpumask_var(saved_cpumask);
4981 return ret;
4982}
4983
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004984#ifdef CONFIG_SYSFS
4985/*
4986 * Workqueues with WQ_SYSFS flag set is visible to userland via
4987 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4988 * following attributes.
4989 *
4990 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4991 * max_active RW int : maximum number of in-flight work items
4992 *
4993 * Unbound workqueues have the following extra attributes.
4994 *
Wang Long9a19b462017-11-02 23:05:12 -04004995 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004996 * nice RW int : nice value of the workers
4997 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04004998 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004999 */
5000struct wq_device {
5001 struct workqueue_struct *wq;
5002 struct device dev;
5003};
5004
5005static struct workqueue_struct *dev_to_wq(struct device *dev)
5006{
5007 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5008
5009 return wq_dev->wq;
5010}
5011
5012static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5013 char *buf)
5014{
5015 struct workqueue_struct *wq = dev_to_wq(dev);
5016
5017 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5018}
5019static DEVICE_ATTR_RO(per_cpu);
5020
5021static ssize_t max_active_show(struct device *dev,
5022 struct device_attribute *attr, char *buf)
5023{
5024 struct workqueue_struct *wq = dev_to_wq(dev);
5025
5026 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5027}
5028
5029static ssize_t max_active_store(struct device *dev,
5030 struct device_attribute *attr, const char *buf,
5031 size_t count)
5032{
5033 struct workqueue_struct *wq = dev_to_wq(dev);
5034 int val;
5035
5036 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5037 return -EINVAL;
5038
5039 workqueue_set_max_active(wq, val);
5040 return count;
5041}
5042static DEVICE_ATTR_RW(max_active);
5043
5044static struct attribute *wq_sysfs_attrs[] = {
5045 &dev_attr_per_cpu.attr,
5046 &dev_attr_max_active.attr,
5047 NULL,
5048};
5049ATTRIBUTE_GROUPS(wq_sysfs);
5050
5051static ssize_t wq_pool_ids_show(struct device *dev,
5052 struct device_attribute *attr, char *buf)
5053{
5054 struct workqueue_struct *wq = dev_to_wq(dev);
5055 const char *delim = "";
5056 int node, written = 0;
5057
5058 rcu_read_lock_sched();
5059 for_each_node(node) {
5060 written += scnprintf(buf + written, PAGE_SIZE - written,
5061 "%s%d:%d", delim, node,
5062 unbound_pwq_by_node(wq, node)->pool->id);
5063 delim = " ";
5064 }
5065 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5066 rcu_read_unlock_sched();
5067
5068 return written;
5069}
5070
5071static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5072 char *buf)
5073{
5074 struct workqueue_struct *wq = dev_to_wq(dev);
5075 int written;
5076
5077 mutex_lock(&wq->mutex);
5078 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5079 mutex_unlock(&wq->mutex);
5080
5081 return written;
5082}
5083
5084/* prepare workqueue_attrs for sysfs store operations */
5085static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5086{
5087 struct workqueue_attrs *attrs;
5088
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005089 lockdep_assert_held(&wq_pool_mutex);
5090
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005091 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5092 if (!attrs)
5093 return NULL;
5094
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005095 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005096 return attrs;
5097}
5098
5099static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5100 const char *buf, size_t count)
5101{
5102 struct workqueue_struct *wq = dev_to_wq(dev);
5103 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005104 int ret = -ENOMEM;
5105
5106 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005107
5108 attrs = wq_sysfs_prep_attrs(wq);
5109 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005110 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005111
5112 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5113 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005114 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005115 else
5116 ret = -EINVAL;
5117
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005118out_unlock:
5119 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005120 free_workqueue_attrs(attrs);
5121 return ret ?: count;
5122}
5123
5124static ssize_t wq_cpumask_show(struct device *dev,
5125 struct device_attribute *attr, char *buf)
5126{
5127 struct workqueue_struct *wq = dev_to_wq(dev);
5128 int written;
5129
5130 mutex_lock(&wq->mutex);
5131 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5132 cpumask_pr_args(wq->unbound_attrs->cpumask));
5133 mutex_unlock(&wq->mutex);
5134 return written;
5135}
5136
5137static ssize_t wq_cpumask_store(struct device *dev,
5138 struct device_attribute *attr,
5139 const char *buf, size_t count)
5140{
5141 struct workqueue_struct *wq = dev_to_wq(dev);
5142 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005143 int ret = -ENOMEM;
5144
5145 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005146
5147 attrs = wq_sysfs_prep_attrs(wq);
5148 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005149 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005150
5151 ret = cpumask_parse(buf, attrs->cpumask);
5152 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005153 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005154
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005155out_unlock:
5156 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005157 free_workqueue_attrs(attrs);
5158 return ret ?: count;
5159}
5160
5161static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5162 char *buf)
5163{
5164 struct workqueue_struct *wq = dev_to_wq(dev);
5165 int written;
5166
5167 mutex_lock(&wq->mutex);
5168 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5169 !wq->unbound_attrs->no_numa);
5170 mutex_unlock(&wq->mutex);
5171
5172 return written;
5173}
5174
5175static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5176 const char *buf, size_t count)
5177{
5178 struct workqueue_struct *wq = dev_to_wq(dev);
5179 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005180 int v, ret = -ENOMEM;
5181
5182 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005183
5184 attrs = wq_sysfs_prep_attrs(wq);
5185 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005186 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005187
5188 ret = -EINVAL;
5189 if (sscanf(buf, "%d", &v) == 1) {
5190 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005191 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005192 }
5193
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005194out_unlock:
5195 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005196 free_workqueue_attrs(attrs);
5197 return ret ?: count;
5198}
5199
5200static struct device_attribute wq_sysfs_unbound_attrs[] = {
5201 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5202 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5203 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5204 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5205 __ATTR_NULL,
5206};
5207
5208static struct bus_type wq_subsys = {
5209 .name = "workqueue",
5210 .dev_groups = wq_sysfs_groups,
5211};
5212
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005213static ssize_t wq_unbound_cpumask_show(struct device *dev,
5214 struct device_attribute *attr, char *buf)
5215{
5216 int written;
5217
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005218 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005219 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5220 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005221 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005222
5223 return written;
5224}
5225
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005226static ssize_t wq_unbound_cpumask_store(struct device *dev,
5227 struct device_attribute *attr, const char *buf, size_t count)
5228{
5229 cpumask_var_t cpumask;
5230 int ret;
5231
5232 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5233 return -ENOMEM;
5234
5235 ret = cpumask_parse(buf, cpumask);
5236 if (!ret)
5237 ret = workqueue_set_unbound_cpumask(cpumask);
5238
5239 free_cpumask_var(cpumask);
5240 return ret ? ret : count;
5241}
5242
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005243static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005244 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5245 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005246
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005247static int __init wq_sysfs_init(void)
5248{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005249 int err;
5250
5251 err = subsys_virtual_register(&wq_subsys, NULL);
5252 if (err)
5253 return err;
5254
5255 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005256}
5257core_initcall(wq_sysfs_init);
5258
5259static void wq_device_release(struct device *dev)
5260{
5261 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5262
5263 kfree(wq_dev);
5264}
5265
5266/**
5267 * workqueue_sysfs_register - make a workqueue visible in sysfs
5268 * @wq: the workqueue to register
5269 *
5270 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5271 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5272 * which is the preferred method.
5273 *
5274 * Workqueue user should use this function directly iff it wants to apply
5275 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5276 * apply_workqueue_attrs() may race against userland updating the
5277 * attributes.
5278 *
5279 * Return: 0 on success, -errno on failure.
5280 */
5281int workqueue_sysfs_register(struct workqueue_struct *wq)
5282{
5283 struct wq_device *wq_dev;
5284 int ret;
5285
5286 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305287 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005288 * attributes breaks ordering guarantee. Disallow exposing ordered
5289 * workqueues.
5290 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005291 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005292 return -EINVAL;
5293
5294 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5295 if (!wq_dev)
5296 return -ENOMEM;
5297
5298 wq_dev->wq = wq;
5299 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005300 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005301 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005302
5303 /*
5304 * unbound_attrs are created separately. Suppress uevent until
5305 * everything is ready.
5306 */
5307 dev_set_uevent_suppress(&wq_dev->dev, true);
5308
5309 ret = device_register(&wq_dev->dev);
5310 if (ret) {
5311 kfree(wq_dev);
5312 wq->wq_dev = NULL;
5313 return ret;
5314 }
5315
5316 if (wq->flags & WQ_UNBOUND) {
5317 struct device_attribute *attr;
5318
5319 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5320 ret = device_create_file(&wq_dev->dev, attr);
5321 if (ret) {
5322 device_unregister(&wq_dev->dev);
5323 wq->wq_dev = NULL;
5324 return ret;
5325 }
5326 }
5327 }
5328
5329 dev_set_uevent_suppress(&wq_dev->dev, false);
5330 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5331 return 0;
5332}
5333
5334/**
5335 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5336 * @wq: the workqueue to unregister
5337 *
5338 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5339 */
5340static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5341{
5342 struct wq_device *wq_dev = wq->wq_dev;
5343
5344 if (!wq->wq_dev)
5345 return;
5346
5347 wq->wq_dev = NULL;
5348 device_unregister(&wq_dev->dev);
5349}
5350#else /* CONFIG_SYSFS */
5351static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5352#endif /* CONFIG_SYSFS */
5353
Tejun Heo82607adc2015-12-08 11:28:04 -05005354/*
5355 * Workqueue watchdog.
5356 *
5357 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5358 * flush dependency, a concurrency managed work item which stays RUNNING
5359 * indefinitely. Workqueue stalls can be very difficult to debug as the
5360 * usual warning mechanisms don't trigger and internal workqueue state is
5361 * largely opaque.
5362 *
5363 * Workqueue watchdog monitors all worker pools periodically and dumps
5364 * state if some pools failed to make forward progress for a while where
5365 * forward progress is defined as the first item on ->worklist changing.
5366 *
5367 * This mechanism is controlled through the kernel parameter
5368 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5369 * corresponding sysfs parameter file.
5370 */
5371#ifdef CONFIG_WQ_WATCHDOG
5372
Tejun Heo82607adc2015-12-08 11:28:04 -05005373static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005374static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005375
5376static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5377static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5378
5379static void wq_watchdog_reset_touched(void)
5380{
5381 int cpu;
5382
5383 wq_watchdog_touched = jiffies;
5384 for_each_possible_cpu(cpu)
5385 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5386}
5387
Kees Cook5cd79d62017-10-04 16:27:00 -07005388static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005389{
5390 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5391 bool lockup_detected = false;
5392 struct worker_pool *pool;
5393 int pi;
5394
5395 if (!thresh)
5396 return;
5397
5398 rcu_read_lock();
5399
5400 for_each_pool(pool, pi) {
5401 unsigned long pool_ts, touched, ts;
5402
5403 if (list_empty(&pool->worklist))
5404 continue;
5405
5406 /* get the latest of pool and touched timestamps */
5407 pool_ts = READ_ONCE(pool->watchdog_ts);
5408 touched = READ_ONCE(wq_watchdog_touched);
5409
5410 if (time_after(pool_ts, touched))
5411 ts = pool_ts;
5412 else
5413 ts = touched;
5414
5415 if (pool->cpu >= 0) {
5416 unsigned long cpu_touched =
5417 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5418 pool->cpu));
5419 if (time_after(cpu_touched, ts))
5420 ts = cpu_touched;
5421 }
5422
5423 /* did we stall? */
5424 if (time_after(jiffies, ts + thresh)) {
5425 lockup_detected = true;
5426 pr_emerg("BUG: workqueue lockup - pool");
5427 pr_cont_pool_info(pool);
5428 pr_cont(" stuck for %us!\n",
5429 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5430 }
5431 }
5432
5433 rcu_read_unlock();
5434
5435 if (lockup_detected)
5436 show_workqueue_state();
5437
5438 wq_watchdog_reset_touched();
5439 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5440}
5441
5442void wq_watchdog_touch(int cpu)
5443{
5444 if (cpu >= 0)
5445 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5446 else
5447 wq_watchdog_touched = jiffies;
5448}
5449
5450static void wq_watchdog_set_thresh(unsigned long thresh)
5451{
5452 wq_watchdog_thresh = 0;
5453 del_timer_sync(&wq_watchdog_timer);
5454
5455 if (thresh) {
5456 wq_watchdog_thresh = thresh;
5457 wq_watchdog_reset_touched();
5458 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5459 }
5460}
5461
5462static int wq_watchdog_param_set_thresh(const char *val,
5463 const struct kernel_param *kp)
5464{
5465 unsigned long thresh;
5466 int ret;
5467
5468 ret = kstrtoul(val, 0, &thresh);
5469 if (ret)
5470 return ret;
5471
5472 if (system_wq)
5473 wq_watchdog_set_thresh(thresh);
5474 else
5475 wq_watchdog_thresh = thresh;
5476
5477 return 0;
5478}
5479
5480static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5481 .set = wq_watchdog_param_set_thresh,
5482 .get = param_get_ulong,
5483};
5484
5485module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5486 0644);
5487
5488static void wq_watchdog_init(void)
5489{
Kees Cook5cd79d62017-10-04 16:27:00 -07005490 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005491 wq_watchdog_set_thresh(wq_watchdog_thresh);
5492}
5493
5494#else /* CONFIG_WQ_WATCHDOG */
5495
5496static inline void wq_watchdog_init(void) { }
5497
5498#endif /* CONFIG_WQ_WATCHDOG */
5499
Tejun Heobce90382013-04-01 11:23:32 -07005500static void __init wq_numa_init(void)
5501{
5502 cpumask_var_t *tbl;
5503 int node, cpu;
5504
Tejun Heobce90382013-04-01 11:23:32 -07005505 if (num_possible_nodes() <= 1)
5506 return;
5507
Tejun Heod55262c2013-04-01 11:23:38 -07005508 if (wq_disable_numa) {
5509 pr_info("workqueue: NUMA affinity support disabled\n");
5510 return;
5511 }
5512
Tejun Heo4c16bd32013-04-01 11:23:36 -07005513 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5514 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5515
Tejun Heobce90382013-04-01 11:23:32 -07005516 /*
5517 * We want masks of possible CPUs of each node which isn't readily
5518 * available. Build one from cpu_to_node() which should have been
5519 * fully initialized by now.
5520 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005521 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005522 BUG_ON(!tbl);
5523
5524 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005525 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005526 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005527
5528 for_each_possible_cpu(cpu) {
5529 node = cpu_to_node(cpu);
5530 if (WARN_ON(node == NUMA_NO_NODE)) {
5531 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5532 /* happens iff arch is bonkers, let's just proceed */
5533 return;
5534 }
5535 cpumask_set_cpu(cpu, tbl[node]);
5536 }
5537
5538 wq_numa_possible_cpumask = tbl;
5539 wq_numa_enabled = true;
5540}
5541
Tejun Heo3347fa02016-09-16 15:49:32 -04005542/**
5543 * workqueue_init_early - early init for workqueue subsystem
5544 *
5545 * This is the first half of two-staged workqueue subsystem initialization
5546 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5547 * idr are up. It sets up all the data structures and system workqueues
5548 * and allows early boot code to create workqueues and queue/cancel work
5549 * items. Actual work item execution starts only after kthreads can be
5550 * created and scheduled right before early initcalls.
5551 */
5552int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005553{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005554 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5555 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005556
Tejun Heoe904e6c2013-03-12 11:29:57 -07005557 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5558
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005559 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Tal Shorerc98a9802017-11-03 17:27:50 +02005560 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(HK_FLAG_DOMAIN));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005561
Tejun Heoe904e6c2013-03-12 11:29:57 -07005562 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5563
Tejun Heo706026c2013-01-24 11:01:34 -08005564 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005565 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005566 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005567
Tejun Heo7a4e3442013-03-12 11:30:00 -07005568 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005569 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005570 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005571 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005572 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005573 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005574 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005575
Tejun Heo9daf9e62013-01-24 11:01:33 -08005576 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005577 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005578 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005579 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005580 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005581 }
5582
Tejun Heo8a2b7532013-09-05 12:30:04 -04005583 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005584 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5585 struct workqueue_attrs *attrs;
5586
5587 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005588 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005589 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005590
5591 /*
5592 * An ordered wq should have only one pwq as ordering is
5593 * guaranteed by max_active which is enforced by pwqs.
5594 * Turn off NUMA so that dfl_pwq is used for all nodes.
5595 */
5596 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5597 attrs->nice = std_nice[i];
5598 attrs->no_numa = true;
5599 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005600 }
5601
Tejun Heod320c032010-06-29 10:07:14 +02005602 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005603 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005604 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005605 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5606 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005607 system_freezable_wq = alloc_workqueue("events_freezable",
5608 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305609 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5610 WQ_POWER_EFFICIENT, 0);
5611 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5612 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5613 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005614 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305615 !system_unbound_wq || !system_freezable_wq ||
5616 !system_power_efficient_wq ||
5617 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005618
Tejun Heo3347fa02016-09-16 15:49:32 -04005619 return 0;
5620}
5621
5622/**
5623 * workqueue_init - bring workqueue subsystem fully online
5624 *
5625 * This is the latter half of two-staged workqueue subsystem initialization
5626 * and invoked as soon as kthreads can be created and scheduled.
5627 * Workqueues have been created and work items queued on them, but there
5628 * are no kworkers executing the work items yet. Populate the worker pools
5629 * with the initial workers and enable future kworker creations.
5630 */
5631int __init workqueue_init(void)
5632{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005633 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005634 struct worker_pool *pool;
5635 int cpu, bkt;
5636
Tejun Heo2186d9f2016-10-19 12:01:27 -04005637 /*
5638 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5639 * CPU to node mapping may not be available that early on some
5640 * archs such as power and arm64. As per-cpu pools created
5641 * previously could be missing node hint and unbound pools NUMA
5642 * affinity, fix them up.
5643 */
5644 wq_numa_init();
5645
5646 mutex_lock(&wq_pool_mutex);
5647
5648 for_each_possible_cpu(cpu) {
5649 for_each_cpu_worker_pool(pool, cpu) {
5650 pool->node = cpu_to_node(cpu);
5651 }
5652 }
5653
5654 list_for_each_entry(wq, &workqueues, list)
5655 wq_update_unbound_numa(wq, smp_processor_id(), true);
5656
5657 mutex_unlock(&wq_pool_mutex);
5658
Tejun Heo3347fa02016-09-16 15:49:32 -04005659 /* create the initial workers */
5660 for_each_online_cpu(cpu) {
5661 for_each_cpu_worker_pool(pool, cpu) {
5662 pool->flags &= ~POOL_DISASSOCIATED;
5663 BUG_ON(!create_worker(pool));
5664 }
5665 }
5666
5667 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5668 BUG_ON(!create_worker(pool));
5669
5670 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005671 wq_watchdog_init();
5672
Suresh Siddha6ee05782010-07-30 14:57:37 -07005673 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005674}