blob: 7df85fa9f651054530477c3569fa8823d36e125e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070024 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070044#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050045#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070046#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070047#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070048#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070049#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020050#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090051#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020052
Tejun Heoea138442013-01-18 14:05:55 -080053#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070056 /*
Tejun Heo24647572013-01-24 11:01:33 -080057 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 *
Tejun Heo24647572013-01-24 11:01:33 -080059 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 * While associated (!DISASSOCIATED), all workers are bound to the
61 * CPU and none has %WORKER_UNBOUND set and concurrency management
62 * is in effect.
63 *
64 * While DISASSOCIATED, the cpu may be offline and all workers have
65 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080066 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070067 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070068 * Note that DISASSOCIATED should be flipped only while holding
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
Tejun Heo05f0fe62018-03-14 12:45:13 -07001607static void rcu_work_rcufn(struct rcu_head *rcu)
1608{
1609 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1610
1611 /* read the comment in __queue_work() */
1612 local_irq_disable();
1613 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1614 local_irq_enable();
1615}
1616
1617/**
1618 * queue_rcu_work - queue work after a RCU grace period
1619 * @wq: workqueue to use
1620 * @rwork: work to queue
1621 *
1622 * Return: %false if @rwork was already pending, %true otherwise. Note
1623 * that a full RCU grace period is guaranteed only after a %true return.
1624 * While @rwork is guarnateed to be executed after a %false return, the
1625 * execution may happen before a full RCU grace period has passed.
1626 */
1627bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1628{
1629 struct work_struct *work = &rwork->work;
1630
1631 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1632 rwork->wq = wq;
1633 call_rcu(&rwork->rcu, rcu_work_rcufn);
1634 return true;
1635 }
1636
1637 return false;
1638}
1639EXPORT_SYMBOL(queue_rcu_work);
1640
Tejun Heo8376fe22012-08-03 10:30:47 -07001641/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001642 * worker_enter_idle - enter idle state
1643 * @worker: worker which is entering idle state
1644 *
1645 * @worker is entering idle state. Update stats and idle timer if
1646 * necessary.
1647 *
1648 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001649 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001650 */
1651static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001653 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Tejun Heo6183c002013-03-12 11:29:57 -07001655 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1656 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1657 (worker->hentry.next || worker->hentry.pprev)))
1658 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
Lai Jiangshan051e1852014-07-22 13:03:02 +08001660 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001661 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001662 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001663 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001664
Tejun Heoc8e55f32010-06-29 10:07:12 +02001665 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001666 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001667
Tejun Heo628c78e2012-07-17 12:39:27 -07001668 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1669 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001670
Tejun Heo544ecf32012-05-14 15:04:50 -07001671 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001672 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001673 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001674 * nr_running, the warning may trigger spuriously. Check iff
1675 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001676 */
Tejun Heo24647572013-01-24 11:01:33 -08001677 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001678 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001679 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680}
1681
Tejun Heoc8e55f32010-06-29 10:07:12 +02001682/**
1683 * worker_leave_idle - leave idle state
1684 * @worker: worker which is leaving idle state
1685 *
1686 * @worker is leaving idle state. Update stats.
1687 *
1688 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001689 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001690 */
1691static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001693 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
Tejun Heo6183c002013-03-12 11:29:57 -07001695 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1696 return;
Tejun Heod302f012010-06-29 10:07:13 +02001697 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001698 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001699 list_del_init(&worker->entry);
1700}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001702static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001703{
1704 struct worker *worker;
1705
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001706 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001707 if (worker) {
1708 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001709 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001710 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001711 /* on creation a worker is in !idle && prep state */
1712 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001713 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001714 return worker;
1715}
1716
1717/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001718 * worker_attach_to_pool() - attach a worker to a pool
1719 * @worker: worker to be attached
1720 * @pool: the target pool
1721 *
1722 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1723 * cpu-binding of @worker are kept coordinated with the pool across
1724 * cpu-[un]hotplugs.
1725 */
1726static void worker_attach_to_pool(struct worker *worker,
1727 struct worker_pool *pool)
1728{
1729 mutex_lock(&pool->attach_mutex);
1730
1731 /*
1732 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1733 * online CPUs. It'll be re-applied when any of the CPUs come up.
1734 */
1735 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1736
1737 /*
1738 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1739 * stable across this function. See the comments above the
1740 * flag definition for details.
1741 */
1742 if (pool->flags & POOL_DISASSOCIATED)
1743 worker->flags |= WORKER_UNBOUND;
1744
1745 list_add_tail(&worker->node, &pool->workers);
1746
1747 mutex_unlock(&pool->attach_mutex);
1748}
1749
1750/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001751 * worker_detach_from_pool() - detach a worker from its pool
1752 * @worker: worker which is attached to its pool
1753 * @pool: the pool @worker is attached to
1754 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001755 * Undo the attaching which had been done in worker_attach_to_pool(). The
1756 * caller worker shouldn't access to the pool after detached except it has
1757 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001758 */
1759static void worker_detach_from_pool(struct worker *worker,
1760 struct worker_pool *pool)
1761{
1762 struct completion *detach_completion = NULL;
1763
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001764 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001765 list_del(&worker->node);
1766 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001767 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001768 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001769
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001770 /* clear leftover flags without pool->lock after it is detached */
1771 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1772
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001773 if (detach_completion)
1774 complete(detach_completion);
1775}
1776
1777/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001778 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001779 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001781 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 *
1783 * CONTEXT:
1784 * Might sleep. Does GFP_KERNEL allocations.
1785 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001786 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001787 * Pointer to the newly created worker.
1788 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001789static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001790{
Tejun Heoc34056a2010-06-29 10:07:11 +02001791 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001792 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001793 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001794
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001795 /* ID is needed to determine kthread name */
1796 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001797 if (id < 0)
1798 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001799
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001800 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 if (!worker)
1802 goto fail;
1803
Tejun Heobd7bdd42012-07-12 14:46:37 -07001804 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001805 worker->id = id;
1806
Tejun Heo29c91e92013-03-12 11:30:03 -07001807 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001808 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1809 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001810 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001811 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1812
Tejun Heof3f90ad2013-04-01 11:23:34 -07001813 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001814 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001815 if (IS_ERR(worker->task))
1816 goto fail;
1817
Oleg Nesterov91151222013-11-14 12:56:18 +01001818 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001819 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001820
Lai Jiangshanda028462014-05-20 17:46:31 +08001821 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001822 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001823
Lai Jiangshan051e1852014-07-22 13:03:02 +08001824 /* start the newly created worker */
1825 spin_lock_irq(&pool->lock);
1826 worker->pool->nr_workers++;
1827 worker_enter_idle(worker);
1828 wake_up_process(worker->task);
1829 spin_unlock_irq(&pool->lock);
1830
Tejun Heoc34056a2010-06-29 10:07:11 +02001831 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001832
Tejun Heoc34056a2010-06-29 10:07:11 +02001833fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001834 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001835 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001836 kfree(worker);
1837 return NULL;
1838}
1839
1840/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001841 * destroy_worker - destroy a workqueue worker
1842 * @worker: worker to be destroyed
1843 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001844 * Destroy @worker and adjust @pool stats accordingly. The worker should
1845 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001846 *
1847 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001848 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001849 */
1850static void destroy_worker(struct worker *worker)
1851{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001852 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001853
Tejun Heocd549682013-03-13 19:47:39 -07001854 lockdep_assert_held(&pool->lock);
1855
Tejun Heoc34056a2010-06-29 10:07:11 +02001856 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001857 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001858 WARN_ON(!list_empty(&worker->scheduled)) ||
1859 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001860 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001861
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001862 pool->nr_workers--;
1863 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001864
Tejun Heoc8e55f32010-06-29 10:07:12 +02001865 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001866 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001867 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001868}
1869
Kees Cook32a6c722017-10-16 15:58:25 -07001870static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001871{
Kees Cook32a6c722017-10-16 15:58:25 -07001872 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873
Tejun Heod565ed62013-01-24 11:01:33 -08001874 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001875
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001876 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001877 struct worker *worker;
1878 unsigned long expires;
1879
1880 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001881 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001882 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1883
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001884 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001885 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001886 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001888
1889 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001890 }
1891
Tejun Heod565ed62013-01-24 11:01:33 -08001892 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001893}
1894
Tejun Heo493a1722013-03-12 11:29:59 -07001895static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001896{
Tejun Heo112202d2013-02-13 19:29:12 -08001897 struct pool_workqueue *pwq = get_work_pwq(work);
1898 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001899
Tejun Heo2e109a22013-03-13 19:47:40 -07001900 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
Tejun Heo493008a2013-03-12 11:30:03 -07001902 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001903 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001904
1905 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001906 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001907 /*
1908 * If @pwq is for an unbound wq, its base ref may be put at
1909 * any time due to an attribute change. Pin @pwq until the
1910 * rescuer is done with it.
1911 */
1912 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001913 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001915 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001916}
1917
Kees Cook32a6c722017-10-16 15:58:25 -07001918static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001919{
Kees Cook32a6c722017-10-16 15:58:25 -07001920 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 struct work_struct *work;
1922
Tejun Heob2d82902014-12-08 12:39:16 -05001923 spin_lock_irq(&pool->lock);
1924 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001925
Tejun Heo63d95a92012-07-12 14:46:37 -07001926 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001927 /*
1928 * We've been trying to create a new worker but
1929 * haven't been successful. We might be hitting an
1930 * allocation deadlock. Send distress signals to
1931 * rescuers.
1932 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001933 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001934 send_mayday(work);
1935 }
1936
Tejun Heob2d82902014-12-08 12:39:16 -05001937 spin_unlock(&wq_mayday_lock);
1938 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001939
Tejun Heo63d95a92012-07-12 14:46:37 -07001940 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001941}
1942
1943/**
1944 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001947 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001948 * have at least one idle worker on return from this function. If
1949 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001950 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001951 * possible allocation deadlock.
1952 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001953 * On return, need_to_create_worker() is guaranteed to be %false and
1954 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 *
1956 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001957 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 * multiple times. Does GFP_KERNEL allocations. Called only from
1959 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001960 */
Tejun Heo29187a92015-01-16 14:21:16 -05001961static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001962__releases(&pool->lock)
1963__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001964{
Tejun Heoe22bee72010-06-29 10:07:14 +02001965restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001966 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001967
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001970
1971 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001972 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 break;
1974
Lai Jiangshane212f362014-06-03 15:32:17 +08001975 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001976
Tejun Heo63d95a92012-07-12 14:46:37 -07001977 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 break;
1979 }
1980
Tejun Heo63d95a92012-07-12 14:46:37 -07001981 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001982 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001983 /*
1984 * This is necessary even after a new worker was just successfully
1985 * created as @pool->lock was dropped and the new worker might have
1986 * already become busy.
1987 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001988 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001989 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001990}
1991
1992/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 * manage_workers - manage worker pool
1994 * @worker: self
1995 *
Tejun Heo706026c2013-01-24 11:01:34 -08001996 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001998 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 *
2000 * The caller can safely start processing works on false return. On
2001 * true return, it's guaranteed that need_to_create_worker() is false
2002 * and may_start_working() is true.
2003 *
2004 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002005 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002006 * multiple times. Does GFP_KERNEL allocations.
2007 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002008 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002009 * %false if the pool doesn't need management and the caller can safely
2010 * start processing works, %true if management function was performed and
2011 * the conditions that the caller verified before calling the function may
2012 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 */
2014static bool manage_workers(struct worker *worker)
2015{
Tejun Heo63d95a92012-07-12 14:46:37 -07002016 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002017
Tejun Heo692b4822017-10-09 08:04:13 -07002018 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002019 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002020
2021 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002022 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002023
Tejun Heo29187a92015-01-16 14:21:16 -05002024 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002025
Tejun Heo2607d7a2015-03-09 09:22:28 -04002026 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002027 pool->flags &= ~POOL_MANAGER_ACTIVE;
2028 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002029 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002030}
2031
Tejun Heoa62428c2010-06-29 10:07:10 +02002032/**
2033 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002034 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002035 * @work: work to process
2036 *
2037 * Process @work. This function contains all the logics necessary to
2038 * process a single work including synchronization against and
2039 * interaction with other workers on the same cpu, queueing and
2040 * flushing. As long as context requirement is met, any worker can
2041 * call this function to process a work.
2042 *
2043 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002044 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002045 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002046static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002047__releases(&pool->lock)
2048__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002049{
Tejun Heo112202d2013-02-13 19:29:12 -08002050 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002051 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002052 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002053 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002054 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002055#ifdef CONFIG_LOCKDEP
2056 /*
2057 * It is permissible to free the struct work_struct from
2058 * inside the function that is called from it, this we need to
2059 * take into account for lockdep too. To avoid bogus "held
2060 * lock freed" warnings as well as problems when looking into
2061 * work->lockdep_map, make a copy and use that here.
2062 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002063 struct lockdep_map lockdep_map;
2064
2065 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002066#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002067 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002068 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002069 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002070
Tejun Heo7e116292010-06-29 10:07:13 +02002071 /*
2072 * A single work shouldn't be executed concurrently by
2073 * multiple workers on a single cpu. Check whether anyone is
2074 * already processing the work. If so, defer the work to the
2075 * currently executing one.
2076 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002077 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002078 if (unlikely(collision)) {
2079 move_linked_works(work, &collision->scheduled, NULL);
2080 return;
2081 }
2082
Tejun Heo8930cab2012-08-03 10:30:45 -07002083 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002084 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002085 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002086 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002087 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002088 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002089 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002090
Tejun Heoa62428c2010-06-29 10:07:10 +02002091 list_del_init(&work->entry);
2092
Tejun Heo649027d2010-06-29 10:07:14 +02002093 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002094 * CPU intensive works don't participate in concurrency management.
2095 * They're the scheduler's responsibility. This takes @worker out
2096 * of concurrency management and the next code block will chain
2097 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002098 */
2099 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002100 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002101
Tejun Heo974271c42012-07-12 14:46:37 -07002102 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002103 * Wake up another worker if necessary. The condition is always
2104 * false for normal per-cpu workers since nr_running would always
2105 * be >= 1 at this point. This is used to chain execution of the
2106 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002107 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002108 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002109 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002110 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002111
Tejun Heo8930cab2012-08-03 10:30:45 -07002112 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002113 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002114 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002115 * PENDING and queued state changes happen together while IRQ is
2116 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002117 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002118 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002119
Tejun Heod565ed62013-01-24 11:01:33 -08002120 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002121
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002122 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002123 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002124 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002125 * Strictly speaking we should mark the invariant state without holding
2126 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002127 *
2128 * However, that would result in:
2129 *
2130 * A(W1)
2131 * WFC(C)
2132 * A(W1)
2133 * C(C)
2134 *
2135 * Which would create W1->C->W1 dependencies, even though there is no
2136 * actual deadlock possible. There are two solutions, using a
2137 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002138 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002139 * these locks.
2140 *
2141 * AFAICT there is no possible deadlock scenario between the
2142 * flush_work() and complete() primitives (except for single-threaded
2143 * workqueues), so hiding them isn't a problem.
2144 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002145 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002146 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002147 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002148 /*
2149 * While we must be careful to not use "work" after this, the trace
2150 * point will only record its address.
2151 */
2152 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002153 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002154 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002155
2156 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002157 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2158 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002159 current->comm, preempt_count(), task_pid_nr(current),
2160 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002161 debug_show_held_locks(current);
2162 dump_stack();
2163 }
2164
Tejun Heob22ce272013-08-28 17:33:37 -04002165 /*
2166 * The following prevents a kworker from hogging CPU on !PREEMPT
2167 * kernels, where a requeueing work item waiting for something to
2168 * happen could deadlock with stop_machine as such work item could
2169 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002170 * stop_machine. At the same time, report a quiescent RCU state so
2171 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002172 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002173 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002174
Tejun Heod565ed62013-01-24 11:01:33 -08002175 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002176
Tejun Heofb0e7be2010-06-29 10:07:15 +02002177 /* clear cpu intensive status */
2178 if (unlikely(cpu_intensive))
2179 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2180
Tejun Heoa62428c2010-06-29 10:07:10 +02002181 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002182 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002183 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002184 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002185 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002186 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002187 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002188}
2189
Tejun Heoaffee4b2010-06-29 10:07:12 +02002190/**
2191 * process_scheduled_works - process scheduled works
2192 * @worker: self
2193 *
2194 * Process all scheduled works. Please note that the scheduled list
2195 * may change while processing a work, so this function repeatedly
2196 * fetches a work from the top and executes it.
2197 *
2198 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002199 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002200 * multiple times.
2201 */
2202static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002204 while (!list_empty(&worker->scheduled)) {
2205 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002207 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209}
2210
Tejun Heo4690c4a2010-06-29 10:07:10 +02002211/**
2212 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002213 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002214 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002215 * The worker thread function. All workers belong to a worker_pool -
2216 * either a per-cpu one or dynamic unbound one. These workers process all
2217 * work items regardless of their specific target workqueue. The only
2218 * exception is work items which belong to workqueues with a rescuer which
2219 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002220 *
2221 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002222 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002223static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224{
Tejun Heoc34056a2010-06-29 10:07:11 +02002225 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002226 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
Tejun Heoe22bee72010-06-29 10:07:14 +02002228 /* tell the scheduler that this is a workqueue worker */
2229 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002230woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002231 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002232
Tejun Heoa9ab7752013-03-19 13:45:21 -07002233 /* am I supposed to die? */
2234 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002235 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002236 WARN_ON_ONCE(!list_empty(&worker->entry));
2237 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002238
2239 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002240 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002241 worker_detach_from_pool(worker, pool);
2242 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002243 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002245
Tejun Heoc8e55f32010-06-29 10:07:12 +02002246 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002247recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002248 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002249 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002250 goto sleep;
2251
2252 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002253 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002254 goto recheck;
2255
Tejun Heoc8e55f32010-06-29 10:07:12 +02002256 /*
2257 * ->scheduled list can only be filled while a worker is
2258 * preparing to process a work or actually processing it.
2259 * Make sure nobody diddled with it while I was sleeping.
2260 */
Tejun Heo6183c002013-03-12 11:29:57 -07002261 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002262
Tejun Heoe22bee72010-06-29 10:07:14 +02002263 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002264 * Finish PREP stage. We're guaranteed to have at least one idle
2265 * worker or that someone else has already assumed the manager
2266 * role. This is where @worker starts participating in concurrency
2267 * management if applicable and concurrency management is restored
2268 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002269 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002270 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002271
2272 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002273 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002274 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002275 struct work_struct, entry);
2276
Tejun Heo82607adc2015-12-08 11:28:04 -05002277 pool->watchdog_ts = jiffies;
2278
Tejun Heoc8e55f32010-06-29 10:07:12 +02002279 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2280 /* optimization path, not strictly necessary */
2281 process_one_work(worker, work);
2282 if (unlikely(!list_empty(&worker->scheduled)))
2283 process_scheduled_works(worker);
2284 } else {
2285 move_linked_works(work, &worker->scheduled, NULL);
2286 process_scheduled_works(worker);
2287 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002288 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002289
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002290 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002291sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002292 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002293 * pool->lock is held and there's no work to process and no need to
2294 * manage, sleep. Workers are woken up only while holding
2295 * pool->lock or from local cpu, so setting the current state
2296 * before releasing pool->lock is enough to prevent losing any
2297 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002298 */
2299 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002300 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002301 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002302 schedule();
2303 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304}
2305
Tejun Heoe22bee72010-06-29 10:07:14 +02002306/**
2307 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002308 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002309 *
2310 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002311 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002312 *
Tejun Heo706026c2013-01-24 11:01:34 -08002313 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002314 * worker which uses GFP_KERNEL allocation which has slight chance of
2315 * developing into deadlock if some works currently on the same queue
2316 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2317 * the problem rescuer solves.
2318 *
Tejun Heo706026c2013-01-24 11:01:34 -08002319 * When such condition is possible, the pool summons rescuers of all
2320 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002321 * those works so that forward progress can be guaranteed.
2322 *
2323 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002324 *
2325 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002326 */
Tejun Heo111c2252013-01-17 17:16:24 -08002327static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002328{
Tejun Heo111c2252013-01-17 17:16:24 -08002329 struct worker *rescuer = __rescuer;
2330 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002331 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002332 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002333
2334 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002335
2336 /*
2337 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2338 * doesn't participate in concurrency management.
2339 */
2340 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002341repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002342 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002343
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002344 /*
2345 * By the time the rescuer is requested to stop, the workqueue
2346 * shouldn't have any work pending, but @wq->maydays may still have
2347 * pwq(s) queued. This can happen by non-rescuer workers consuming
2348 * all the work items before the rescuer got to them. Go through
2349 * @wq->maydays processing before acting on should_stop so that the
2350 * list is always empty on exit.
2351 */
2352 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002353
Tejun Heo493a1722013-03-12 11:29:59 -07002354 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002355 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002356
2357 while (!list_empty(&wq->maydays)) {
2358 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2359 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002360 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002361 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002362 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002363
2364 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002365 list_del_init(&pwq->mayday_node);
2366
Tejun Heo2e109a22013-03-13 19:47:40 -07002367 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002368
Lai Jiangshan51697d392014-05-20 17:46:36 +08002369 worker_attach_to_pool(rescuer, pool);
2370
2371 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002372 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002373
2374 /*
2375 * Slurp in all works issued via this workqueue and
2376 * process'em.
2377 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002378 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002379 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2380 if (get_work_pwq(work) == pwq) {
2381 if (first)
2382 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002383 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002384 }
2385 first = false;
2386 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002387
NeilBrown008847f2014-12-08 12:39:16 -05002388 if (!list_empty(scheduled)) {
2389 process_scheduled_works(rescuer);
2390
2391 /*
2392 * The above execution of rescued work items could
2393 * have created more to rescue through
2394 * pwq_activate_first_delayed() or chained
2395 * queueing. Let's put @pwq back on mayday list so
2396 * that such back-to-back work items, which may be
2397 * being used to relieve memory pressure, don't
2398 * incur MAYDAY_INTERVAL delay inbetween.
2399 */
2400 if (need_to_create_worker(pool)) {
2401 spin_lock(&wq_mayday_lock);
2402 get_pwq(pwq);
2403 list_move_tail(&pwq->mayday_node, &wq->maydays);
2404 spin_unlock(&wq_mayday_lock);
2405 }
2406 }
Tejun Heo75769582011-02-14 14:04:46 +01002407
2408 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002409 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002410 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002411 */
2412 put_pwq(pwq);
2413
2414 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002415 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002416 * regular worker; otherwise, we end up with 0 concurrency
2417 * and stalling the execution.
2418 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002419 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002420 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002421
Lai Jiangshanb3104102013-02-19 12:17:02 -08002422 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002423 spin_unlock_irq(&pool->lock);
2424
2425 worker_detach_from_pool(rescuer, pool);
2426
2427 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002428 }
2429
Tejun Heo2e109a22013-03-13 19:47:40 -07002430 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002431
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002432 if (should_stop) {
2433 __set_current_state(TASK_RUNNING);
2434 rescuer->task->flags &= ~PF_WQ_WORKER;
2435 return 0;
2436 }
2437
Tejun Heo111c2252013-01-17 17:16:24 -08002438 /* rescuers should never participate in concurrency management */
2439 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002440 schedule();
2441 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442}
2443
Tejun Heofca839c2015-12-07 10:58:57 -05002444/**
2445 * check_flush_dependency - check for flush dependency sanity
2446 * @target_wq: workqueue being flushed
2447 * @target_work: work item being flushed (NULL for workqueue flushes)
2448 *
2449 * %current is trying to flush the whole @target_wq or @target_work on it.
2450 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2451 * reclaiming memory or running on a workqueue which doesn't have
2452 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2453 * a deadlock.
2454 */
2455static void check_flush_dependency(struct workqueue_struct *target_wq,
2456 struct work_struct *target_work)
2457{
2458 work_func_t target_func = target_work ? target_work->func : NULL;
2459 struct worker *worker;
2460
2461 if (target_wq->flags & WQ_MEM_RECLAIM)
2462 return;
2463
2464 worker = current_wq_worker();
2465
2466 WARN_ONCE(current->flags & PF_MEMALLOC,
2467 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2468 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002469 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2470 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002471 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2472 worker->current_pwq->wq->name, worker->current_func,
2473 target_wq->name, target_func);
2474}
2475
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002476struct wq_barrier {
2477 struct work_struct work;
2478 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002479 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002480};
2481
2482static void wq_barrier_func(struct work_struct *work)
2483{
2484 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2485 complete(&barr->done);
2486}
2487
Tejun Heo4690c4a2010-06-29 10:07:10 +02002488/**
2489 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002490 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002491 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002492 * @target: target work to attach @barr to
2493 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002494 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002495 * @barr is linked to @target such that @barr is completed only after
2496 * @target finishes execution. Please note that the ordering
2497 * guarantee is observed only with respect to @target and on the local
2498 * cpu.
2499 *
2500 * Currently, a queued barrier can't be canceled. This is because
2501 * try_to_grab_pending() can't determine whether the work to be
2502 * grabbed is at the head of the queue and thus can't clear LINKED
2503 * flag of the previous work while there must be a valid next work
2504 * after a work with LINKED flag set.
2505 *
2506 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002507 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002508 *
2509 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002510 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002511 */
Tejun Heo112202d2013-02-13 19:29:12 -08002512static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002513 struct wq_barrier *barr,
2514 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002515{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002516 struct list_head *head;
2517 unsigned int linked = 0;
2518
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002519 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002520 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002521 * as we know for sure that this will not trigger any of the
2522 * checks and call back into the fixup functions where we
2523 * might deadlock.
2524 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002525 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002526 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002527
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002528 init_completion_map(&barr->done, &target->lockdep_map);
2529
Tejun Heo2607d7a2015-03-09 09:22:28 -04002530 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002531
Tejun Heoaffee4b2010-06-29 10:07:12 +02002532 /*
2533 * If @target is currently being executed, schedule the
2534 * barrier to the worker; otherwise, put it after @target.
2535 */
2536 if (worker)
2537 head = worker->scheduled.next;
2538 else {
2539 unsigned long *bits = work_data_bits(target);
2540
2541 head = target->entry.next;
2542 /* there can already be other linked works, inherit and set */
2543 linked = *bits & WORK_STRUCT_LINKED;
2544 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2545 }
2546
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002547 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002548 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002549 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002550}
2551
Tejun Heo73f53c42010-06-29 10:07:11 +02002552/**
Tejun Heo112202d2013-02-13 19:29:12 -08002553 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 * @wq: workqueue being flushed
2555 * @flush_color: new flush color, < 0 for no-op
2556 * @work_color: new work color, < 0 for no-op
2557 *
Tejun Heo112202d2013-02-13 19:29:12 -08002558 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002559 *
Tejun Heo112202d2013-02-13 19:29:12 -08002560 * If @flush_color is non-negative, flush_color on all pwqs should be
2561 * -1. If no pwq has in-flight commands at the specified color, all
2562 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2563 * has in flight commands, its pwq->flush_color is set to
2564 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002565 * wakeup logic is armed and %true is returned.
2566 *
2567 * The caller should have initialized @wq->first_flusher prior to
2568 * calling this function with non-negative @flush_color. If
2569 * @flush_color is negative, no flush color update is done and %false
2570 * is returned.
2571 *
Tejun Heo112202d2013-02-13 19:29:12 -08002572 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 * work_color which is previous to @work_color and all will be
2574 * advanced to @work_color.
2575 *
2576 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002577 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002578 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002579 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002580 * %true if @flush_color >= 0 and there's something to flush. %false
2581 * otherwise.
2582 */
Tejun Heo112202d2013-02-13 19:29:12 -08002583static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002584 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585{
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002587 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002588
Tejun Heo73f53c42010-06-29 10:07:11 +02002589 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002590 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002591 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002592 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002593
Tejun Heo49e3cf42013-03-12 11:29:58 -07002594 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002595 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002596
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002597 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002598
2599 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002600 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002601
Tejun Heo112202d2013-02-13 19:29:12 -08002602 if (pwq->nr_in_flight[flush_color]) {
2603 pwq->flush_color = flush_color;
2604 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002605 wait = true;
2606 }
2607 }
2608
2609 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002610 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002611 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002612 }
2613
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002614 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002615 }
2616
Tejun Heo112202d2013-02-13 19:29:12 -08002617 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002618 complete(&wq->first_flusher->done);
2619
2620 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621}
2622
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002623/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002625 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002627 * This function sleeps until all work items which were queued on entry
2628 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002630void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631{
Tejun Heo73f53c42010-06-29 10:07:11 +02002632 struct wq_flusher this_flusher = {
2633 .list = LIST_HEAD_INIT(this_flusher.list),
2634 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002635 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002636 };
2637 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002638
Tejun Heo3347fa02016-09-16 15:49:32 -04002639 if (WARN_ON(!wq_online))
2640 return;
2641
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002642 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002643
2644 /*
2645 * Start-to-wait phase
2646 */
2647 next_color = work_next_color(wq->work_color);
2648
2649 if (next_color != wq->flush_color) {
2650 /*
2651 * Color space is not full. The current work_color
2652 * becomes our flush_color and work_color is advanced
2653 * by one.
2654 */
Tejun Heo6183c002013-03-12 11:29:57 -07002655 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002656 this_flusher.flush_color = wq->work_color;
2657 wq->work_color = next_color;
2658
2659 if (!wq->first_flusher) {
2660 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002661 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002662
2663 wq->first_flusher = &this_flusher;
2664
Tejun Heo112202d2013-02-13 19:29:12 -08002665 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002666 wq->work_color)) {
2667 /* nothing to flush, done */
2668 wq->flush_color = next_color;
2669 wq->first_flusher = NULL;
2670 goto out_unlock;
2671 }
2672 } else {
2673 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002674 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002675 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002676 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002677 }
2678 } else {
2679 /*
2680 * Oops, color space is full, wait on overflow queue.
2681 * The next flush completion will assign us
2682 * flush_color and transfer to flusher_queue.
2683 */
2684 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2685 }
2686
Tejun Heofca839c2015-12-07 10:58:57 -05002687 check_flush_dependency(wq, NULL);
2688
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002689 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002690
2691 wait_for_completion(&this_flusher.done);
2692
2693 /*
2694 * Wake-up-and-cascade phase
2695 *
2696 * First flushers are responsible for cascading flushes and
2697 * handling overflow. Non-first flushers can simply return.
2698 */
2699 if (wq->first_flusher != &this_flusher)
2700 return;
2701
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002702 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002703
Tejun Heo4ce48b32010-07-02 10:03:51 +02002704 /* we might have raced, check again with mutex held */
2705 if (wq->first_flusher != &this_flusher)
2706 goto out_unlock;
2707
Tejun Heo73f53c42010-06-29 10:07:11 +02002708 wq->first_flusher = NULL;
2709
Tejun Heo6183c002013-03-12 11:29:57 -07002710 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2711 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002712
2713 while (true) {
2714 struct wq_flusher *next, *tmp;
2715
2716 /* complete all the flushers sharing the current flush color */
2717 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2718 if (next->flush_color != wq->flush_color)
2719 break;
2720 list_del_init(&next->list);
2721 complete(&next->done);
2722 }
2723
Tejun Heo6183c002013-03-12 11:29:57 -07002724 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2725 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002726
2727 /* this flush_color is finished, advance by one */
2728 wq->flush_color = work_next_color(wq->flush_color);
2729
2730 /* one color has been freed, handle overflow queue */
2731 if (!list_empty(&wq->flusher_overflow)) {
2732 /*
2733 * Assign the same color to all overflowed
2734 * flushers, advance work_color and append to
2735 * flusher_queue. This is the start-to-wait
2736 * phase for these overflowed flushers.
2737 */
2738 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2739 tmp->flush_color = wq->work_color;
2740
2741 wq->work_color = work_next_color(wq->work_color);
2742
2743 list_splice_tail_init(&wq->flusher_overflow,
2744 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002745 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002746 }
2747
2748 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002749 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002750 break;
2751 }
2752
2753 /*
2754 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002755 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002756 */
Tejun Heo6183c002013-03-12 11:29:57 -07002757 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2758 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002759
2760 list_del_init(&next->list);
2761 wq->first_flusher = next;
2762
Tejun Heo112202d2013-02-13 19:29:12 -08002763 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002764 break;
2765
2766 /*
2767 * Meh... this color is already done, clear first
2768 * flusher and repeat cascading.
2769 */
2770 wq->first_flusher = NULL;
2771 }
2772
2773out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002774 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002776EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002778/**
2779 * drain_workqueue - drain a workqueue
2780 * @wq: workqueue to drain
2781 *
2782 * Wait until the workqueue becomes empty. While draining is in progress,
2783 * only chain queueing is allowed. IOW, only currently pending or running
2784 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002785 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002786 * by the depth of chaining and should be relatively short. Whine if it
2787 * takes too long.
2788 */
2789void drain_workqueue(struct workqueue_struct *wq)
2790{
2791 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002792 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002793
2794 /*
2795 * __queue_work() needs to test whether there are drainers, is much
2796 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002797 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002798 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002799 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002800 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002801 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002802 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002803reflush:
2804 flush_workqueue(wq);
2805
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002806 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002807
Tejun Heo49e3cf42013-03-12 11:29:58 -07002808 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002809 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002810
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002811 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002812 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002813 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002814
2815 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002816 continue;
2817
2818 if (++flush_cnt == 10 ||
2819 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002820 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002821 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002822
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002823 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002824 goto reflush;
2825 }
2826
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002827 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002828 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002829 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002830}
2831EXPORT_SYMBOL_GPL(drain_workqueue);
2832
Tejun Heo606a5022012-08-20 14:51:23 -07002833static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002834{
2835 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002836 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002837 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002838
2839 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002840
Tejun Heofa1b54e2013-03-12 11:30:00 -07002841 local_irq_disable();
2842 pool = get_work_pool(work);
2843 if (!pool) {
2844 local_irq_enable();
2845 return false;
2846 }
2847
2848 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002849 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002850 pwq = get_work_pwq(work);
2851 if (pwq) {
2852 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002853 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002854 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002855 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002856 if (!worker)
2857 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002858 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002859 }
Tejun Heobaf59022010-09-16 10:42:16 +02002860
Tejun Heofca839c2015-12-07 10:58:57 -05002861 check_flush_dependency(pwq->wq, work);
2862
Tejun Heo112202d2013-02-13 19:29:12 -08002863 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002864 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002865
Tejun Heoe159489b2011-01-09 23:32:15 +01002866 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002867 * Force a lock recursion deadlock when using flush_work() inside a
2868 * single-threaded or rescuer equipped workqueue.
2869 *
2870 * For single threaded workqueues the deadlock happens when the work
2871 * is after the work issuing the flush_work(). For rescuer equipped
2872 * workqueues the deadlock happens when the rescuer stalls, blocking
2873 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002874 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002875 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002876 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002877 lock_map_release(&pwq->wq->lockdep_map);
2878 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002879
Tejun Heobaf59022010-09-16 10:42:16 +02002880 return true;
2881already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002882 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002883 return false;
2884}
2885
Oleg Nesterovdb700892008-07-25 01:47:49 -07002886/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002887 * flush_work - wait for a work to finish executing the last queueing instance
2888 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002889 *
Tejun Heo606a5022012-08-20 14:51:23 -07002890 * Wait until @work has finished execution. @work is guaranteed to be idle
2891 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002892 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002893 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002894 * %true if flush_work() waited for the work to finish execution,
2895 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002896 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002897bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002898{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002899 struct wq_barrier barr;
2900
Tejun Heo3347fa02016-09-16 15:49:32 -04002901 if (WARN_ON(!wq_online))
2902 return false;
2903
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002904 if (start_flush_work(work, &barr)) {
2905 wait_for_completion(&barr.done);
2906 destroy_work_on_stack(&barr.work);
2907 return true;
2908 } else {
2909 return false;
2910 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002911}
2912EXPORT_SYMBOL_GPL(flush_work);
2913
Tejun Heo8603e1b32015-03-05 08:04:13 -05002914struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002915 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002916 struct work_struct *work;
2917};
2918
Ingo Molnarac6424b2017-06-20 12:06:13 +02002919static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002920{
2921 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2922
2923 if (cwait->work != key)
2924 return 0;
2925 return autoremove_wake_function(wait, mode, sync, key);
2926}
2927
Tejun Heo36e227d2012-08-03 10:30:46 -07002928static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002929{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002930 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002931 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002932 int ret;
2933
2934 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002935 ret = try_to_grab_pending(work, is_dwork, &flags);
2936 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002937 * If someone else is already canceling, wait for it to
2938 * finish. flush_work() doesn't work for PREEMPT_NONE
2939 * because we may get scheduled between @work's completion
2940 * and the other canceling task resuming and clearing
2941 * CANCELING - flush_work() will return false immediately
2942 * as @work is no longer busy, try_to_grab_pending() will
2943 * return -ENOENT as @work is still being canceled and the
2944 * other canceling task won't be able to clear CANCELING as
2945 * we're hogging the CPU.
2946 *
2947 * Let's wait for completion using a waitqueue. As this
2948 * may lead to the thundering herd problem, use a custom
2949 * wake function which matches @work along with exclusive
2950 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002951 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002952 if (unlikely(ret == -ENOENT)) {
2953 struct cwt_wait cwait;
2954
2955 init_wait(&cwait.wait);
2956 cwait.wait.func = cwt_wakefn;
2957 cwait.work = work;
2958
2959 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2960 TASK_UNINTERRUPTIBLE);
2961 if (work_is_canceling(work))
2962 schedule();
2963 finish_wait(&cancel_waitq, &cwait.wait);
2964 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002965 } while (unlikely(ret < 0));
2966
Tejun Heobbb68df2012-08-03 10:30:46 -07002967 /* tell other tasks trying to grab @work to back off */
2968 mark_work_canceling(work);
2969 local_irq_restore(flags);
2970
Tejun Heo3347fa02016-09-16 15:49:32 -04002971 /*
2972 * This allows canceling during early boot. We know that @work
2973 * isn't executing.
2974 */
2975 if (wq_online)
2976 flush_work(work);
2977
Tejun Heo7a22ad72010-06-29 10:07:13 +02002978 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002979
2980 /*
2981 * Paired with prepare_to_wait() above so that either
2982 * waitqueue_active() is visible here or !work_is_canceling() is
2983 * visible there.
2984 */
2985 smp_mb();
2986 if (waitqueue_active(&cancel_waitq))
2987 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2988
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002989 return ret;
2990}
2991
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002992/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002993 * cancel_work_sync - cancel a work and wait for it to finish
2994 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002995 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002996 * Cancel @work and wait for its execution to finish. This function
2997 * can be used even if the work re-queues itself or migrates to
2998 * another workqueue. On return from this function, @work is
2999 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003000 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003001 * cancel_work_sync(&delayed_work->work) must not be used for
3002 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003003 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003004 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003005 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003006 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003007 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003008 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003009 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003010bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003011{
Tejun Heo36e227d2012-08-03 10:30:46 -07003012 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003013}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003014EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003015
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003016/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003017 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3018 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003019 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003020 * Delayed timer is cancelled and the pending work is queued for
3021 * immediate execution. Like flush_work(), this function only
3022 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003023 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003024 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003025 * %true if flush_work() waited for the work to finish execution,
3026 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003027 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003028bool flush_delayed_work(struct delayed_work *dwork)
3029{
Tejun Heo8930cab2012-08-03 10:30:45 -07003030 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003031 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003032 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003033 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003034 return flush_work(&dwork->work);
3035}
3036EXPORT_SYMBOL(flush_delayed_work);
3037
Tejun Heo05f0fe62018-03-14 12:45:13 -07003038/**
3039 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3040 * @rwork: the rcu work to flush
3041 *
3042 * Return:
3043 * %true if flush_rcu_work() waited for the work to finish execution,
3044 * %false if it was already idle.
3045 */
3046bool flush_rcu_work(struct rcu_work *rwork)
3047{
3048 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3049 rcu_barrier();
3050 flush_work(&rwork->work);
3051 return true;
3052 } else {
3053 return flush_work(&rwork->work);
3054 }
3055}
3056EXPORT_SYMBOL(flush_rcu_work);
3057
Jens Axboef72b8792016-08-24 15:51:50 -06003058static bool __cancel_work(struct work_struct *work, bool is_dwork)
3059{
3060 unsigned long flags;
3061 int ret;
3062
3063 do {
3064 ret = try_to_grab_pending(work, is_dwork, &flags);
3065 } while (unlikely(ret == -EAGAIN));
3066
3067 if (unlikely(ret < 0))
3068 return false;
3069
3070 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3071 local_irq_restore(flags);
3072 return ret;
3073}
3074
3075/*
3076 * See cancel_delayed_work()
3077 */
3078bool cancel_work(struct work_struct *work)
3079{
3080 return __cancel_work(work, false);
3081}
3082
Tejun Heo401a8d02010-09-16 10:36:00 +02003083/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003084 * cancel_delayed_work - cancel a delayed work
3085 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003086 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003087 * Kill off a pending delayed_work.
3088 *
3089 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3090 * pending.
3091 *
3092 * Note:
3093 * The work callback function may still be running on return, unless
3094 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3095 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003096 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003097 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003098 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003099bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003100{
Jens Axboef72b8792016-08-24 15:51:50 -06003101 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003102}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003103EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003104
3105/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003106 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3107 * @dwork: the delayed work cancel
3108 *
3109 * This is cancel_work_sync() for delayed works.
3110 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003111 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003112 * %true if @dwork was pending, %false otherwise.
3113 */
3114bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003115{
Tejun Heo36e227d2012-08-03 10:30:46 -07003116 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003117}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003118EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003120/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003121 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003122 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003123 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003124 * schedule_on_each_cpu() executes @func on each online CPU using the
3125 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003126 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003127 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003128 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003129 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003130 */
David Howells65f27f32006-11-22 14:55:48 +00003131int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003132{
3133 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003134 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003135
Andrew Mortonb6136772006-06-25 05:47:49 -07003136 works = alloc_percpu(struct work_struct);
3137 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003138 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003139
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003140 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003141
Christoph Lameter15316ba82006-01-08 01:00:43 -08003142 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003143 struct work_struct *work = per_cpu_ptr(works, cpu);
3144
3145 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003146 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003147 }
Tejun Heo93981802009-11-17 14:06:20 -08003148
3149 for_each_online_cpu(cpu)
3150 flush_work(per_cpu_ptr(works, cpu));
3151
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003152 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003153 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003154 return 0;
3155}
3156
Alan Sterneef6a7d2010-02-12 17:39:21 +09003157/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003158 * execute_in_process_context - reliably execute the routine with user context
3159 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003160 * @ew: guaranteed storage for the execute work structure (must
3161 * be available when the work executes)
3162 *
3163 * Executes the function immediately if process context is available,
3164 * otherwise schedules the function for delayed execution.
3165 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003166 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003167 * 1 - function was scheduled for execution
3168 */
David Howells65f27f32006-11-22 14:55:48 +00003169int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003170{
3171 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003172 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003173 return 0;
3174 }
3175
David Howells65f27f32006-11-22 14:55:48 +00003176 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003177 schedule_work(&ew->work);
3178
3179 return 1;
3180}
3181EXPORT_SYMBOL_GPL(execute_in_process_context);
3182
Tejun Heo7a4e3442013-03-12 11:30:00 -07003183/**
3184 * free_workqueue_attrs - free a workqueue_attrs
3185 * @attrs: workqueue_attrs to free
3186 *
3187 * Undo alloc_workqueue_attrs().
3188 */
3189void free_workqueue_attrs(struct workqueue_attrs *attrs)
3190{
3191 if (attrs) {
3192 free_cpumask_var(attrs->cpumask);
3193 kfree(attrs);
3194 }
3195}
3196
3197/**
3198 * alloc_workqueue_attrs - allocate a workqueue_attrs
3199 * @gfp_mask: allocation mask to use
3200 *
3201 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003202 * return it.
3203 *
3204 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003205 */
3206struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3207{
3208 struct workqueue_attrs *attrs;
3209
3210 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3211 if (!attrs)
3212 goto fail;
3213 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3214 goto fail;
3215
Tejun Heo13e2e552013-04-01 11:23:31 -07003216 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003217 return attrs;
3218fail:
3219 free_workqueue_attrs(attrs);
3220 return NULL;
3221}
3222
Tejun Heo29c91e92013-03-12 11:30:03 -07003223static void copy_workqueue_attrs(struct workqueue_attrs *to,
3224 const struct workqueue_attrs *from)
3225{
3226 to->nice = from->nice;
3227 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003228 /*
3229 * Unlike hash and equality test, this function doesn't ignore
3230 * ->no_numa as it is used for both pool and wq attrs. Instead,
3231 * get_unbound_pool() explicitly clears ->no_numa after copying.
3232 */
3233 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003234}
3235
Tejun Heo29c91e92013-03-12 11:30:03 -07003236/* hash value of the content of @attr */
3237static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3238{
3239 u32 hash = 0;
3240
3241 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003242 hash = jhash(cpumask_bits(attrs->cpumask),
3243 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003244 return hash;
3245}
3246
3247/* content equality test */
3248static bool wqattrs_equal(const struct workqueue_attrs *a,
3249 const struct workqueue_attrs *b)
3250{
3251 if (a->nice != b->nice)
3252 return false;
3253 if (!cpumask_equal(a->cpumask, b->cpumask))
3254 return false;
3255 return true;
3256}
3257
Tejun Heo7a4e3442013-03-12 11:30:00 -07003258/**
3259 * init_worker_pool - initialize a newly zalloc'd worker_pool
3260 * @pool: worker_pool to initialize
3261 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303262 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003263 *
3264 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003265 * inside @pool proper are initialized and put_unbound_pool() can be called
3266 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003267 */
3268static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003269{
3270 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003271 pool->id = -1;
3272 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003273 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003274 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003275 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003276 INIT_LIST_HEAD(&pool->worklist);
3277 INIT_LIST_HEAD(&pool->idle_list);
3278 hash_init(pool->busy_hash);
3279
Kees Cook32a6c722017-10-16 15:58:25 -07003280 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003281
Kees Cook32a6c722017-10-16 15:58:25 -07003282 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003283
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003284 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003285 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003286
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003287 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003288 INIT_HLIST_NODE(&pool->hash_node);
3289 pool->refcnt = 1;
3290
3291 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003292 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3293 if (!pool->attrs)
3294 return -ENOMEM;
3295 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003296}
3297
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003298static void rcu_free_wq(struct rcu_head *rcu)
3299{
3300 struct workqueue_struct *wq =
3301 container_of(rcu, struct workqueue_struct, rcu);
3302
3303 if (!(wq->flags & WQ_UNBOUND))
3304 free_percpu(wq->cpu_pwqs);
3305 else
3306 free_workqueue_attrs(wq->unbound_attrs);
3307
3308 kfree(wq->rescuer);
3309 kfree(wq);
3310}
3311
Tejun Heo29c91e92013-03-12 11:30:03 -07003312static void rcu_free_pool(struct rcu_head *rcu)
3313{
3314 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3315
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003316 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003317 free_workqueue_attrs(pool->attrs);
3318 kfree(pool);
3319}
3320
3321/**
3322 * put_unbound_pool - put a worker_pool
3323 * @pool: worker_pool to put
3324 *
3325 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003326 * safe manner. get_unbound_pool() calls this function on its failure path
3327 * and this function should be able to release pools which went through,
3328 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003329 *
3330 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003331 */
3332static void put_unbound_pool(struct worker_pool *pool)
3333{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003334 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003335 struct worker *worker;
3336
Tejun Heoa892cac2013-04-01 11:23:32 -07003337 lockdep_assert_held(&wq_pool_mutex);
3338
3339 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003340 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003341
3342 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003343 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003344 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003345 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003346
3347 /* release id and unhash */
3348 if (pool->id >= 0)
3349 idr_remove(&worker_pool_idr, pool->id);
3350 hash_del(&pool->hash_node);
3351
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003352 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003353 * Become the manager and destroy all workers. This prevents
3354 * @pool's workers from blocking on attach_mutex. We're the last
3355 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003356 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003357 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003358 wait_event_lock_irq(wq_manager_wait,
3359 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3360 pool->flags |= POOL_MANAGER_ACTIVE;
3361
Lai Jiangshan1037de32014-05-22 16:44:07 +08003362 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003363 destroy_worker(worker);
3364 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003365 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003366
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003367 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003368 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003369 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003370 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003371
3372 if (pool->detach_completion)
3373 wait_for_completion(pool->detach_completion);
3374
Tejun Heo29c91e92013-03-12 11:30:03 -07003375 /* shut down the timers */
3376 del_timer_sync(&pool->idle_timer);
3377 del_timer_sync(&pool->mayday_timer);
3378
3379 /* sched-RCU protected to allow dereferences from get_work_pool() */
3380 call_rcu_sched(&pool->rcu, rcu_free_pool);
3381}
3382
3383/**
3384 * get_unbound_pool - get a worker_pool with the specified attributes
3385 * @attrs: the attributes of the worker_pool to get
3386 *
3387 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3388 * reference count and return it. If there already is a matching
3389 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003390 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003391 *
3392 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003393 *
3394 * Return: On success, a worker_pool with the same attributes as @attrs.
3395 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003396 */
3397static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3398{
Tejun Heo29c91e92013-03-12 11:30:03 -07003399 u32 hash = wqattrs_hash(attrs);
3400 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003401 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003402 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003403
Tejun Heoa892cac2013-04-01 11:23:32 -07003404 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003405
3406 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3408 if (wqattrs_equal(pool->attrs, attrs)) {
3409 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003410 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003411 }
3412 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003413
Xunlei Pange22735842015-10-09 11:53:12 +08003414 /* if cpumask is contained inside a NUMA node, we belong to that node */
3415 if (wq_numa_enabled) {
3416 for_each_node(node) {
3417 if (cpumask_subset(attrs->cpumask,
3418 wq_numa_possible_cpumask[node])) {
3419 target_node = node;
3420 break;
3421 }
3422 }
3423 }
3424
Tejun Heo29c91e92013-03-12 11:30:03 -07003425 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003426 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003427 if (!pool || init_worker_pool(pool) < 0)
3428 goto fail;
3429
Tejun Heo8864b4e2013-03-12 11:30:04 -07003430 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003431 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003432 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003433
Shaohua Li2865a8f2013-08-01 09:56:36 +08003434 /*
3435 * no_numa isn't a worker_pool attribute, always clear it. See
3436 * 'struct workqueue_attrs' comments for detail.
3437 */
3438 pool->attrs->no_numa = false;
3439
Tejun Heo29c91e92013-03-12 11:30:03 -07003440 if (worker_pool_assign_id(pool) < 0)
3441 goto fail;
3442
3443 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003444 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003445 goto fail;
3446
Tejun Heo29c91e92013-03-12 11:30:03 -07003447 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003448 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003449
Tejun Heo29c91e92013-03-12 11:30:03 -07003450 return pool;
3451fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003452 if (pool)
3453 put_unbound_pool(pool);
3454 return NULL;
3455}
3456
Tejun Heo8864b4e2013-03-12 11:30:04 -07003457static void rcu_free_pwq(struct rcu_head *rcu)
3458{
3459 kmem_cache_free(pwq_cache,
3460 container_of(rcu, struct pool_workqueue, rcu));
3461}
3462
3463/*
3464 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3465 * and needs to be destroyed.
3466 */
3467static void pwq_unbound_release_workfn(struct work_struct *work)
3468{
3469 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3470 unbound_release_work);
3471 struct workqueue_struct *wq = pwq->wq;
3472 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003473 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003474
3475 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3476 return;
3477
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003478 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003479 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003480 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003481 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003482
Tejun Heoa892cac2013-04-01 11:23:32 -07003483 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003484 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003485 mutex_unlock(&wq_pool_mutex);
3486
Tejun Heo8864b4e2013-03-12 11:30:04 -07003487 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3488
3489 /*
3490 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003491 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003492 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003493 if (is_last)
3494 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003495}
3496
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003497/**
Tejun Heo699ce092013-03-13 16:51:35 -07003498 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003499 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003500 *
Tejun Heo699ce092013-03-13 16:51:35 -07003501 * If @pwq isn't freezing, set @pwq->max_active to the associated
3502 * workqueue's saved_max_active and activate delayed work items
3503 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003504 */
Tejun Heo699ce092013-03-13 16:51:35 -07003505static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003506{
Tejun Heo699ce092013-03-13 16:51:35 -07003507 struct workqueue_struct *wq = pwq->wq;
3508 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003509 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003510
Tejun Heo699ce092013-03-13 16:51:35 -07003511 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003512 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003513
3514 /* fast exit for non-freezable wqs */
3515 if (!freezable && pwq->max_active == wq->saved_max_active)
3516 return;
3517
Tejun Heo3347fa02016-09-16 15:49:32 -04003518 /* this function can be called during early boot w/ irq disabled */
3519 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003520
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003521 /*
3522 * During [un]freezing, the caller is responsible for ensuring that
3523 * this function is called at least once after @workqueue_freezing
3524 * is updated and visible.
3525 */
3526 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003527 pwq->max_active = wq->saved_max_active;
3528
3529 while (!list_empty(&pwq->delayed_works) &&
3530 pwq->nr_active < pwq->max_active)
3531 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003532
3533 /*
3534 * Need to kick a worker after thawed or an unbound wq's
3535 * max_active is bumped. It's a slow path. Do it always.
3536 */
3537 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003538 } else {
3539 pwq->max_active = 0;
3540 }
3541
Tejun Heo3347fa02016-09-16 15:49:32 -04003542 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003543}
3544
Tejun Heoe50aba92013-04-01 11:23:35 -07003545/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003546static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3547 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003548{
3549 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3550
Tejun Heoe50aba92013-04-01 11:23:35 -07003551 memset(pwq, 0, sizeof(*pwq));
3552
Tejun Heod2c1d402013-03-12 11:30:04 -07003553 pwq->pool = pool;
3554 pwq->wq = wq;
3555 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003556 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003557 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003558 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003559 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003560 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003561}
Tejun Heod2c1d402013-03-12 11:30:04 -07003562
Tejun Heof147f292013-04-01 11:23:35 -07003563/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003564static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003565{
3566 struct workqueue_struct *wq = pwq->wq;
3567
3568 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003569
Tejun Heo1befcf32013-04-01 11:23:35 -07003570 /* may be called multiple times, ignore if already linked */
3571 if (!list_empty(&pwq->pwqs_node))
3572 return;
3573
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003574 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003575 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003576
3577 /* sync max_active to the current setting */
3578 pwq_adjust_max_active(pwq);
3579
3580 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003581 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003582}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003583
Tejun Heof147f292013-04-01 11:23:35 -07003584/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3585static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3586 const struct workqueue_attrs *attrs)
3587{
3588 struct worker_pool *pool;
3589 struct pool_workqueue *pwq;
3590
3591 lockdep_assert_held(&wq_pool_mutex);
3592
3593 pool = get_unbound_pool(attrs);
3594 if (!pool)
3595 return NULL;
3596
Tejun Heoe50aba92013-04-01 11:23:35 -07003597 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003598 if (!pwq) {
3599 put_unbound_pool(pool);
3600 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003601 }
Tejun Heo6029a912013-04-01 11:23:34 -07003602
Tejun Heof147f292013-04-01 11:23:35 -07003603 init_pwq(pwq, wq, pool);
3604 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003605}
3606
Tejun Heo4c16bd32013-04-01 11:23:36 -07003607/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003608 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003609 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003610 * @node: the target NUMA node
3611 * @cpu_going_down: if >= 0, the CPU to consider as offline
3612 * @cpumask: outarg, the resulting cpumask
3613 *
3614 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3615 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003616 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003617 *
3618 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3619 * enabled and @node has online CPUs requested by @attrs, the returned
3620 * cpumask is the intersection of the possible CPUs of @node and
3621 * @attrs->cpumask.
3622 *
3623 * The caller is responsible for ensuring that the cpumask of @node stays
3624 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003625 *
3626 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3627 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003628 */
3629static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3630 int cpu_going_down, cpumask_t *cpumask)
3631{
Tejun Heod55262c2013-04-01 11:23:38 -07003632 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003633 goto use_dfl;
3634
3635 /* does @node have any online CPUs @attrs wants? */
3636 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3637 if (cpu_going_down >= 0)
3638 cpumask_clear_cpu(cpu_going_down, cpumask);
3639
3640 if (cpumask_empty(cpumask))
3641 goto use_dfl;
3642
3643 /* yeap, return possible CPUs in @node that @attrs wants */
3644 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003645
3646 if (cpumask_empty(cpumask)) {
3647 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3648 "possible intersect\n");
3649 return false;
3650 }
3651
Tejun Heo4c16bd32013-04-01 11:23:36 -07003652 return !cpumask_equal(cpumask, attrs->cpumask);
3653
3654use_dfl:
3655 cpumask_copy(cpumask, attrs->cpumask);
3656 return false;
3657}
3658
Tejun Heo1befcf32013-04-01 11:23:35 -07003659/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3660static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3661 int node,
3662 struct pool_workqueue *pwq)
3663{
3664 struct pool_workqueue *old_pwq;
3665
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003666 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003667 lockdep_assert_held(&wq->mutex);
3668
3669 /* link_pwq() can handle duplicate calls */
3670 link_pwq(pwq);
3671
3672 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3673 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3674 return old_pwq;
3675}
3676
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003677/* context to store the prepared attrs & pwqs before applying */
3678struct apply_wqattrs_ctx {
3679 struct workqueue_struct *wq; /* target workqueue */
3680 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003681 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003682 struct pool_workqueue *dfl_pwq;
3683 struct pool_workqueue *pwq_tbl[];
3684};
3685
3686/* free the resources after success or abort */
3687static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3688{
3689 if (ctx) {
3690 int node;
3691
3692 for_each_node(node)
3693 put_pwq_unlocked(ctx->pwq_tbl[node]);
3694 put_pwq_unlocked(ctx->dfl_pwq);
3695
3696 free_workqueue_attrs(ctx->attrs);
3697
3698 kfree(ctx);
3699 }
3700}
3701
3702/* allocate the attrs and pwqs for later installation */
3703static struct apply_wqattrs_ctx *
3704apply_wqattrs_prepare(struct workqueue_struct *wq,
3705 const struct workqueue_attrs *attrs)
3706{
3707 struct apply_wqattrs_ctx *ctx;
3708 struct workqueue_attrs *new_attrs, *tmp_attrs;
3709 int node;
3710
3711 lockdep_assert_held(&wq_pool_mutex);
3712
3713 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3714 GFP_KERNEL);
3715
3716 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3717 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3718 if (!ctx || !new_attrs || !tmp_attrs)
3719 goto out_free;
3720
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003721 /*
3722 * Calculate the attrs of the default pwq.
3723 * If the user configured cpumask doesn't overlap with the
3724 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3725 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003726 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003727 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003728 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3729 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003730
3731 /*
3732 * We may create multiple pwqs with differing cpumasks. Make a
3733 * copy of @new_attrs which will be modified and used to obtain
3734 * pools.
3735 */
3736 copy_workqueue_attrs(tmp_attrs, new_attrs);
3737
3738 /*
3739 * If something goes wrong during CPU up/down, we'll fall back to
3740 * the default pwq covering whole @attrs->cpumask. Always create
3741 * it even if we don't use it immediately.
3742 */
3743 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3744 if (!ctx->dfl_pwq)
3745 goto out_free;
3746
3747 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003748 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003749 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3750 if (!ctx->pwq_tbl[node])
3751 goto out_free;
3752 } else {
3753 ctx->dfl_pwq->refcnt++;
3754 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3755 }
3756 }
3757
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003758 /* save the user configured attrs and sanitize it. */
3759 copy_workqueue_attrs(new_attrs, attrs);
3760 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003761 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003762
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003763 ctx->wq = wq;
3764 free_workqueue_attrs(tmp_attrs);
3765 return ctx;
3766
3767out_free:
3768 free_workqueue_attrs(tmp_attrs);
3769 free_workqueue_attrs(new_attrs);
3770 apply_wqattrs_cleanup(ctx);
3771 return NULL;
3772}
3773
3774/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3775static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3776{
3777 int node;
3778
3779 /* all pwqs have been created successfully, let's install'em */
3780 mutex_lock(&ctx->wq->mutex);
3781
3782 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3783
3784 /* save the previous pwq and install the new one */
3785 for_each_node(node)
3786 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3787 ctx->pwq_tbl[node]);
3788
3789 /* @dfl_pwq might not have been used, ensure it's linked */
3790 link_pwq(ctx->dfl_pwq);
3791 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3792
3793 mutex_unlock(&ctx->wq->mutex);
3794}
3795
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003796static void apply_wqattrs_lock(void)
3797{
3798 /* CPUs should stay stable across pwq creations and installations */
3799 get_online_cpus();
3800 mutex_lock(&wq_pool_mutex);
3801}
3802
3803static void apply_wqattrs_unlock(void)
3804{
3805 mutex_unlock(&wq_pool_mutex);
3806 put_online_cpus();
3807}
3808
3809static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3810 const struct workqueue_attrs *attrs)
3811{
3812 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003813
3814 /* only unbound workqueues can change attributes */
3815 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3816 return -EINVAL;
3817
3818 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003819 if (!list_empty(&wq->pwqs)) {
3820 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3821 return -EINVAL;
3822
3823 wq->flags &= ~__WQ_ORDERED;
3824 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003825
3826 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003827 if (!ctx)
3828 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003829
3830 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003831 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003832 apply_wqattrs_cleanup(ctx);
3833
wanghaibin62011712016-01-07 20:38:59 +08003834 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003835}
3836
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003837/**
3838 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3839 * @wq: the target workqueue
3840 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3841 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003842 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3843 * machines, this function maps a separate pwq to each NUMA node with
3844 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3845 * NUMA node it was issued on. Older pwqs are released as in-flight work
3846 * items finish. Note that a work item which repeatedly requeues itself
3847 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003848 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003849 * Performs GFP_KERNEL allocations.
3850 *
3851 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003852 */
3853int apply_workqueue_attrs(struct workqueue_struct *wq,
3854 const struct workqueue_attrs *attrs)
3855{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003856 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003857
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003858 apply_wqattrs_lock();
3859 ret = apply_workqueue_attrs_locked(wq, attrs);
3860 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003861
Tejun Heo48621252013-04-01 11:23:31 -07003862 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003863}
NeilBrown6106c0f2018-01-11 15:06:40 +11003864EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003865
Tejun Heo4c16bd32013-04-01 11:23:36 -07003866/**
3867 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3868 * @wq: the target workqueue
3869 * @cpu: the CPU coming up or going down
3870 * @online: whether @cpu is coming up or going down
3871 *
3872 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3873 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3874 * @wq accordingly.
3875 *
3876 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3877 * falls back to @wq->dfl_pwq which may not be optimal but is always
3878 * correct.
3879 *
3880 * Note that when the last allowed CPU of a NUMA node goes offline for a
3881 * workqueue with a cpumask spanning multiple nodes, the workers which were
3882 * already executing the work items for the workqueue will lose their CPU
3883 * affinity and may execute on any CPU. This is similar to how per-cpu
3884 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3885 * affinity, it's the user's responsibility to flush the work item from
3886 * CPU_DOWN_PREPARE.
3887 */
3888static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3889 bool online)
3890{
3891 int node = cpu_to_node(cpu);
3892 int cpu_off = online ? -1 : cpu;
3893 struct pool_workqueue *old_pwq = NULL, *pwq;
3894 struct workqueue_attrs *target_attrs;
3895 cpumask_t *cpumask;
3896
3897 lockdep_assert_held(&wq_pool_mutex);
3898
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003899 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3900 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003901 return;
3902
3903 /*
3904 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3905 * Let's use a preallocated one. The following buf is protected by
3906 * CPU hotplug exclusion.
3907 */
3908 target_attrs = wq_update_unbound_numa_attrs_buf;
3909 cpumask = target_attrs->cpumask;
3910
Tejun Heo4c16bd32013-04-01 11:23:36 -07003911 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3912 pwq = unbound_pwq_by_node(wq, node);
3913
3914 /*
3915 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003916 * different from the default pwq's, we need to compare it to @pwq's
3917 * and create a new one if they don't match. If the target cpumask
3918 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003919 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003920 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003921 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003922 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003923 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003924 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003925 }
3926
Tejun Heo4c16bd32013-04-01 11:23:36 -07003927 /* create a new pwq */
3928 pwq = alloc_unbound_pwq(wq, target_attrs);
3929 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003930 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3931 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003932 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003933 }
3934
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003935 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003936 mutex_lock(&wq->mutex);
3937 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3938 goto out_unlock;
3939
3940use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003941 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003942 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3943 get_pwq(wq->dfl_pwq);
3944 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3945 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3946out_unlock:
3947 mutex_unlock(&wq->mutex);
3948 put_pwq_unlocked(old_pwq);
3949}
3950
Tejun Heo30cdf2492013-03-12 11:29:57 -07003951static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003952{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003953 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003954 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003955
Tejun Heo30cdf2492013-03-12 11:29:57 -07003956 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003957 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3958 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003959 return -ENOMEM;
3960
3961 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003962 struct pool_workqueue *pwq =
3963 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003964 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003965 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003966
Tejun Heof147f292013-04-01 11:23:35 -07003967 init_pwq(pwq, wq, &cpu_pools[highpri]);
3968
3969 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003970 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003971 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003972 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003973 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003974 } else if (wq->flags & __WQ_ORDERED) {
3975 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3976 /* there should only be single pwq for ordering guarantee */
3977 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3978 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3979 "ordering guarantee broken for workqueue %s\n", wq->name);
3980 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003981 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003982 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003983 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003984}
3985
Tejun Heof3421792010-07-02 10:03:51 +02003986static int wq_clamp_max_active(int max_active, unsigned int flags,
3987 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003988{
Tejun Heof3421792010-07-02 10:03:51 +02003989 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3990
3991 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003992 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3993 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003994
Tejun Heof3421792010-07-02 10:03:51 +02003995 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003996}
3997
Tejun Heo983c7512018-01-08 05:38:32 -08003998/*
3999 * Workqueues which may be used during memory reclaim should have a rescuer
4000 * to guarantee forward progress.
4001 */
4002static int init_rescuer(struct workqueue_struct *wq)
4003{
4004 struct worker *rescuer;
4005 int ret;
4006
4007 if (!(wq->flags & WQ_MEM_RECLAIM))
4008 return 0;
4009
4010 rescuer = alloc_worker(NUMA_NO_NODE);
4011 if (!rescuer)
4012 return -ENOMEM;
4013
4014 rescuer->rescue_wq = wq;
4015 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4016 ret = PTR_ERR_OR_ZERO(rescuer->task);
4017 if (ret) {
4018 kfree(rescuer);
4019 return ret;
4020 }
4021
4022 wq->rescuer = rescuer;
4023 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4024 wake_up_process(rescuer->task);
4025
4026 return 0;
4027}
4028
Tejun Heob196be82012-01-10 15:11:35 -08004029struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004030 unsigned int flags,
4031 int max_active,
4032 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004033 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004034{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004035 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004036 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004037 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004038 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004039
Tejun Heo5c0338c2017-07-18 18:41:52 -04004040 /*
4041 * Unbound && max_active == 1 used to imply ordered, which is no
4042 * longer the case on NUMA machines due to per-node pools. While
4043 * alloc_ordered_workqueue() is the right way to create an ordered
4044 * workqueue, keep the previous behavior to avoid subtle breakages
4045 * on NUMA.
4046 */
4047 if ((flags & WQ_UNBOUND) && max_active == 1)
4048 flags |= __WQ_ORDERED;
4049
Viresh Kumarcee22a12013-04-08 16:45:40 +05304050 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4051 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4052 flags |= WQ_UNBOUND;
4053
Tejun Heoecf68812013-04-01 11:23:34 -07004054 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004055 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004056 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004057
4058 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004059 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004060 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004061
Tejun Heo6029a912013-04-01 11:23:34 -07004062 if (flags & WQ_UNBOUND) {
4063 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4064 if (!wq->unbound_attrs)
4065 goto err_free_wq;
4066 }
4067
Tejun Heoecf68812013-04-01 11:23:34 -07004068 va_start(args, lock_name);
4069 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004070 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004071
Tejun Heod320c032010-06-29 10:07:14 +02004072 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004073 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004074
Tejun Heob196be82012-01-10 15:11:35 -08004075 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004076 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004077 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004078 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004079 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004080 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004081 INIT_LIST_HEAD(&wq->flusher_queue);
4082 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004083 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004084
Johannes Bergeb13ba82008-01-16 09:51:58 +01004085 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004086 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004087
Tejun Heo30cdf2492013-03-12 11:29:57 -07004088 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004089 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004090
Tejun Heo40c17f72018-01-08 05:38:37 -08004091 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004092 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004093
Tejun Heo226223a2013-03-12 11:30:05 -07004094 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4095 goto err_destroy;
4096
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004097 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004098 * wq_pool_mutex protects global freeze state and workqueues list.
4099 * Grab it, adjust max_active and add the new @wq to workqueues
4100 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004101 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004102 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004103
Lai Jiangshana357fc02013-03-25 16:57:19 -07004104 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004105 for_each_pwq(pwq, wq)
4106 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004107 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004108
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004109 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004110
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004111 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004112
Oleg Nesterov3af244332007-05-09 02:34:09 -07004113 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004114
4115err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004116 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004117 kfree(wq);
4118 return NULL;
4119err_destroy:
4120 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004121 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004122}
Tejun Heod320c032010-06-29 10:07:14 +02004123EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004124
4125/**
4126 * destroy_workqueue - safely terminate a workqueue
4127 * @wq: target workqueue
4128 *
4129 * Safely destroy a workqueue. All work currently pending will be done first.
4130 */
4131void destroy_workqueue(struct workqueue_struct *wq)
4132{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004133 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004134 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004135
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004136 /* drain it before proceeding with destruction */
4137 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004138
Tejun Heo6183c002013-03-12 11:29:57 -07004139 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004140 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004141 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004142 int i;
4143
Tejun Heo76af4d92013-03-12 11:30:00 -07004144 for (i = 0; i < WORK_NR_COLORS; i++) {
4145 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004146 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004147 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004148 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004149 }
4150 }
4151
Lai Jiangshan5c529592013-04-04 10:05:38 +08004152 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004153 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004154 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004155 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004156 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004157 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004158 }
Tejun Heo6183c002013-03-12 11:29:57 -07004159 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004160 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004161
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004162 /*
4163 * wq list is used to freeze wq, remove from list after
4164 * flushing is complete in case freeze races us.
4165 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004166 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004167 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004168 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004169
Tejun Heo226223a2013-03-12 11:30:05 -07004170 workqueue_sysfs_unregister(wq);
4171
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004172 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004173 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004174
Tejun Heo8864b4e2013-03-12 11:30:04 -07004175 if (!(wq->flags & WQ_UNBOUND)) {
4176 /*
4177 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004178 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004179 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004180 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004181 } else {
4182 /*
4183 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004184 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4185 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004186 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004187 for_each_node(node) {
4188 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4189 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4190 put_pwq_unlocked(pwq);
4191 }
4192
4193 /*
4194 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4195 * put. Don't access it afterwards.
4196 */
4197 pwq = wq->dfl_pwq;
4198 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004199 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004200 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004201}
4202EXPORT_SYMBOL_GPL(destroy_workqueue);
4203
Tejun Heodcd989c2010-06-29 10:07:14 +02004204/**
4205 * workqueue_set_max_active - adjust max_active of a workqueue
4206 * @wq: target workqueue
4207 * @max_active: new max_active value.
4208 *
4209 * Set max_active of @wq to @max_active.
4210 *
4211 * CONTEXT:
4212 * Don't call from IRQ context.
4213 */
4214void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4215{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004216 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004217
Tejun Heo8719dce2013-03-12 11:30:04 -07004218 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004219 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004220 return;
4221
Tejun Heof3421792010-07-02 10:03:51 +02004222 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004223
Lai Jiangshana357fc02013-03-25 16:57:19 -07004224 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004225
Tejun Heo0a94efb2017-07-23 08:36:15 -04004226 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004227 wq->saved_max_active = max_active;
4228
Tejun Heo699ce092013-03-13 16:51:35 -07004229 for_each_pwq(pwq, wq)
4230 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004231
Lai Jiangshana357fc02013-03-25 16:57:19 -07004232 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004233}
4234EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4235
4236/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004237 * current_work - retrieve %current task's work struct
4238 *
4239 * Determine if %current task is a workqueue worker and what it's working on.
4240 * Useful to find out the context that the %current task is running in.
4241 *
4242 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4243 */
4244struct work_struct *current_work(void)
4245{
4246 struct worker *worker = current_wq_worker();
4247
4248 return worker ? worker->current_work : NULL;
4249}
4250EXPORT_SYMBOL(current_work);
4251
4252/**
Tejun Heoe62676162013-03-12 17:41:37 -07004253 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4254 *
4255 * Determine whether %current is a workqueue rescuer. Can be used from
4256 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004257 *
4258 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004259 */
4260bool current_is_workqueue_rescuer(void)
4261{
4262 struct worker *worker = current_wq_worker();
4263
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004264 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004265}
4266
4267/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004268 * workqueue_congested - test whether a workqueue is congested
4269 * @cpu: CPU in question
4270 * @wq: target workqueue
4271 *
4272 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4273 * no synchronization around this function and the test result is
4274 * unreliable and only useful as advisory hints or for debugging.
4275 *
Tejun Heod3251852013-05-10 11:10:17 -07004276 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4277 * Note that both per-cpu and unbound workqueues may be associated with
4278 * multiple pool_workqueues which have separate congested states. A
4279 * workqueue being congested on one CPU doesn't mean the workqueue is also
4280 * contested on other CPUs / NUMA nodes.
4281 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004282 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004283 * %true if congested, %false otherwise.
4284 */
Tejun Heod84ff052013-03-12 11:29:59 -07004285bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004286{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004287 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004288 bool ret;
4289
Lai Jiangshan88109452013-03-20 03:28:10 +08004290 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004291
Tejun Heod3251852013-05-10 11:10:17 -07004292 if (cpu == WORK_CPU_UNBOUND)
4293 cpu = smp_processor_id();
4294
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004295 if (!(wq->flags & WQ_UNBOUND))
4296 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4297 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004298 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004299
Tejun Heo76af4d92013-03-12 11:30:00 -07004300 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004301 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004302
4303 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004304}
4305EXPORT_SYMBOL_GPL(workqueue_congested);
4306
4307/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004308 * work_busy - test whether a work is currently pending or running
4309 * @work: the work to be tested
4310 *
4311 * Test whether @work is currently pending or running. There is no
4312 * synchronization around this function and the test result is
4313 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004314 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004315 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004316 * OR'd bitmask of WORK_BUSY_* bits.
4317 */
4318unsigned int work_busy(struct work_struct *work)
4319{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004320 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004321 unsigned long flags;
4322 unsigned int ret = 0;
4323
Tejun Heodcd989c2010-06-29 10:07:14 +02004324 if (work_pending(work))
4325 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004326
Tejun Heofa1b54e2013-03-12 11:30:00 -07004327 local_irq_save(flags);
4328 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004329 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004330 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004331 if (find_worker_executing_work(pool, work))
4332 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004333 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004334 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004335 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004336
4337 return ret;
4338}
4339EXPORT_SYMBOL_GPL(work_busy);
4340
Tejun Heo3d1cb202013-04-30 15:27:22 -07004341/**
4342 * set_worker_desc - set description for the current work item
4343 * @fmt: printf-style format string
4344 * @...: arguments for the format string
4345 *
4346 * This function can be called by a running work function to describe what
4347 * the work item is about. If the worker task gets dumped, this
4348 * information will be printed out together to help debugging. The
4349 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4350 */
4351void set_worker_desc(const char *fmt, ...)
4352{
4353 struct worker *worker = current_wq_worker();
4354 va_list args;
4355
4356 if (worker) {
4357 va_start(args, fmt);
4358 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4359 va_end(args);
4360 worker->desc_valid = true;
4361 }
4362}
4363
4364/**
4365 * print_worker_info - print out worker information and description
4366 * @log_lvl: the log level to use when printing
4367 * @task: target task
4368 *
4369 * If @task is a worker and currently executing a work item, print out the
4370 * name of the workqueue being serviced and worker description set with
4371 * set_worker_desc() by the currently executing work item.
4372 *
4373 * This function can be safely called on any task as long as the
4374 * task_struct itself is accessible. While safe, this function isn't
4375 * synchronized and may print out mixups or garbages of limited length.
4376 */
4377void print_worker_info(const char *log_lvl, struct task_struct *task)
4378{
4379 work_func_t *fn = NULL;
4380 char name[WQ_NAME_LEN] = { };
4381 char desc[WORKER_DESC_LEN] = { };
4382 struct pool_workqueue *pwq = NULL;
4383 struct workqueue_struct *wq = NULL;
4384 bool desc_valid = false;
4385 struct worker *worker;
4386
4387 if (!(task->flags & PF_WQ_WORKER))
4388 return;
4389
4390 /*
4391 * This function is called without any synchronization and @task
4392 * could be in any state. Be careful with dereferences.
4393 */
Petr Mladeke7005912016-10-11 13:55:17 -07004394 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004395
4396 /*
4397 * Carefully copy the associated workqueue's workfn and name. Keep
4398 * the original last '\0' in case the original contains garbage.
4399 */
4400 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4401 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4402 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4403 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4404
4405 /* copy worker description */
4406 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4407 if (desc_valid)
4408 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4409
4410 if (fn || name[0] || desc[0]) {
4411 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4412 if (desc[0])
4413 pr_cont(" (%s)", desc);
4414 pr_cont("\n");
4415 }
4416}
4417
Tejun Heo3494fc32015-03-09 09:22:28 -04004418static void pr_cont_pool_info(struct worker_pool *pool)
4419{
4420 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4421 if (pool->node != NUMA_NO_NODE)
4422 pr_cont(" node=%d", pool->node);
4423 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4424}
4425
4426static void pr_cont_work(bool comma, struct work_struct *work)
4427{
4428 if (work->func == wq_barrier_func) {
4429 struct wq_barrier *barr;
4430
4431 barr = container_of(work, struct wq_barrier, work);
4432
4433 pr_cont("%s BAR(%d)", comma ? "," : "",
4434 task_pid_nr(barr->task));
4435 } else {
4436 pr_cont("%s %pf", comma ? "," : "", work->func);
4437 }
4438}
4439
4440static void show_pwq(struct pool_workqueue *pwq)
4441{
4442 struct worker_pool *pool = pwq->pool;
4443 struct work_struct *work;
4444 struct worker *worker;
4445 bool has_in_flight = false, has_pending = false;
4446 int bkt;
4447
4448 pr_info(" pwq %d:", pool->id);
4449 pr_cont_pool_info(pool);
4450
4451 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4452 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4453
4454 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4455 if (worker->current_pwq == pwq) {
4456 has_in_flight = true;
4457 break;
4458 }
4459 }
4460 if (has_in_flight) {
4461 bool comma = false;
4462
4463 pr_info(" in-flight:");
4464 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4465 if (worker->current_pwq != pwq)
4466 continue;
4467
4468 pr_cont("%s %d%s:%pf", comma ? "," : "",
4469 task_pid_nr(worker->task),
4470 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4471 worker->current_func);
4472 list_for_each_entry(work, &worker->scheduled, entry)
4473 pr_cont_work(false, work);
4474 comma = true;
4475 }
4476 pr_cont("\n");
4477 }
4478
4479 list_for_each_entry(work, &pool->worklist, entry) {
4480 if (get_work_pwq(work) == pwq) {
4481 has_pending = true;
4482 break;
4483 }
4484 }
4485 if (has_pending) {
4486 bool comma = false;
4487
4488 pr_info(" pending:");
4489 list_for_each_entry(work, &pool->worklist, entry) {
4490 if (get_work_pwq(work) != pwq)
4491 continue;
4492
4493 pr_cont_work(comma, work);
4494 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4495 }
4496 pr_cont("\n");
4497 }
4498
4499 if (!list_empty(&pwq->delayed_works)) {
4500 bool comma = false;
4501
4502 pr_info(" delayed:");
4503 list_for_each_entry(work, &pwq->delayed_works, entry) {
4504 pr_cont_work(comma, work);
4505 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4506 }
4507 pr_cont("\n");
4508 }
4509}
4510
4511/**
4512 * show_workqueue_state - dump workqueue state
4513 *
Roger Lu7b776af2016-07-01 11:05:02 +08004514 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4515 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004516 */
4517void show_workqueue_state(void)
4518{
4519 struct workqueue_struct *wq;
4520 struct worker_pool *pool;
4521 unsigned long flags;
4522 int pi;
4523
4524 rcu_read_lock_sched();
4525
4526 pr_info("Showing busy workqueues and worker pools:\n");
4527
4528 list_for_each_entry_rcu(wq, &workqueues, list) {
4529 struct pool_workqueue *pwq;
4530 bool idle = true;
4531
4532 for_each_pwq(pwq, wq) {
4533 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4534 idle = false;
4535 break;
4536 }
4537 }
4538 if (idle)
4539 continue;
4540
4541 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4542
4543 for_each_pwq(pwq, wq) {
4544 spin_lock_irqsave(&pwq->pool->lock, flags);
4545 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4546 show_pwq(pwq);
4547 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004548 /*
4549 * We could be printing a lot from atomic context, e.g.
4550 * sysrq-t -> show_workqueue_state(). Avoid triggering
4551 * hard lockup.
4552 */
4553 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004554 }
4555 }
4556
4557 for_each_pool(pool, pi) {
4558 struct worker *worker;
4559 bool first = true;
4560
4561 spin_lock_irqsave(&pool->lock, flags);
4562 if (pool->nr_workers == pool->nr_idle)
4563 goto next_pool;
4564
4565 pr_info("pool %d:", pool->id);
4566 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004567 pr_cont(" hung=%us workers=%d",
4568 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4569 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004570 if (pool->manager)
4571 pr_cont(" manager: %d",
4572 task_pid_nr(pool->manager->task));
4573 list_for_each_entry(worker, &pool->idle_list, entry) {
4574 pr_cont(" %s%d", first ? "idle: " : "",
4575 task_pid_nr(worker->task));
4576 first = false;
4577 }
4578 pr_cont("\n");
4579 next_pool:
4580 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004581 /*
4582 * We could be printing a lot from atomic context, e.g.
4583 * sysrq-t -> show_workqueue_state(). Avoid triggering
4584 * hard lockup.
4585 */
4586 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004587 }
4588
4589 rcu_read_unlock_sched();
4590}
4591
Tejun Heodb7bccf2010-06-29 10:07:12 +02004592/*
4593 * CPU hotplug.
4594 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004595 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004596 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004597 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004598 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004599 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004600 * blocked draining impractical.
4601 *
Tejun Heo24647572013-01-24 11:01:33 -08004602 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004603 * running as an unbound one and allowing it to be reattached later if the
4604 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004605 */
4606
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004607static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004608{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004609 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004610 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004611
Tejun Heof02ae732013-03-12 11:30:03 -07004612 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004613 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004614 spin_lock_irq(&pool->lock);
4615
4616 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004617 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004618 * unbound and set DISASSOCIATED. Before this, all workers
4619 * except for the ones which are still executing works from
4620 * before the last CPU down must be on the cpu. After
4621 * this, they may become diasporas.
4622 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004623 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004624 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004625
Tejun Heo24647572013-01-24 11:01:33 -08004626 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004627
Tejun Heo94cf58b2013-01-24 11:01:33 -08004628 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004629 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004630
Lai Jiangshaneb283422013-03-08 15:18:28 -08004631 /*
4632 * Call schedule() so that we cross rq->lock and thus can
4633 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4634 * This is necessary as scheduler callbacks may be invoked
4635 * from other cpus.
4636 */
4637 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004638
Lai Jiangshaneb283422013-03-08 15:18:28 -08004639 /*
4640 * Sched callbacks are disabled now. Zap nr_running.
4641 * After this, nr_running stays zero and need_more_worker()
4642 * and keep_working() are always true as long as the
4643 * worklist is not empty. This pool now behaves as an
4644 * unbound (in terms of concurrency management) pool which
4645 * are served by workers tied to the pool.
4646 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004647 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004648
4649 /*
4650 * With concurrency management just turned off, a busy
4651 * worker blocking could lead to lengthy stalls. Kick off
4652 * unbound chain execution of currently pending work items.
4653 */
4654 spin_lock_irq(&pool->lock);
4655 wake_up_worker(pool);
4656 spin_unlock_irq(&pool->lock);
4657 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004658}
4659
Tejun Heobd7c0892013-03-19 13:45:21 -07004660/**
4661 * rebind_workers - rebind all workers of a pool to the associated CPU
4662 * @pool: pool of interest
4663 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004664 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004665 */
4666static void rebind_workers(struct worker_pool *pool)
4667{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004668 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004669
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004670 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004671
Tejun Heoa9ab7752013-03-19 13:45:21 -07004672 /*
4673 * Restore CPU affinity of all workers. As all idle workers should
4674 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304675 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004676 * of all workers first and then clear UNBOUND. As we're called
4677 * from CPU_ONLINE, the following shouldn't fail.
4678 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004679 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004680 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4681 pool->attrs->cpumask) < 0);
4682
4683 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004684
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004685 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004686
Lai Jiangshanda028462014-05-20 17:46:31 +08004687 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004688 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004689
4690 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004691 * A bound idle worker should actually be on the runqueue
4692 * of the associated CPU for local wake-ups targeting it to
4693 * work. Kick all idle workers so that they migrate to the
4694 * associated CPU. Doing this in the same loop as
4695 * replacing UNBOUND with REBOUND is safe as no worker will
4696 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004697 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004698 if (worker_flags & WORKER_IDLE)
4699 wake_up_process(worker->task);
4700
4701 /*
4702 * We want to clear UNBOUND but can't directly call
4703 * worker_clr_flags() or adjust nr_running. Atomically
4704 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4705 * @worker will clear REBOUND using worker_clr_flags() when
4706 * it initiates the next execution cycle thus restoring
4707 * concurrency management. Note that when or whether
4708 * @worker clears REBOUND doesn't affect correctness.
4709 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004710 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004711 * tested without holding any lock in
4712 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4713 * fail incorrectly leading to premature concurrency
4714 * management operations.
4715 */
4716 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4717 worker_flags |= WORKER_REBOUND;
4718 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004719 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004720 }
4721
Tejun Heoa9ab7752013-03-19 13:45:21 -07004722 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004723}
4724
Tejun Heo7dbc7252013-03-19 13:45:21 -07004725/**
4726 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4727 * @pool: unbound pool of interest
4728 * @cpu: the CPU which is coming up
4729 *
4730 * An unbound pool may end up with a cpumask which doesn't have any online
4731 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4732 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4733 * online CPU before, cpus_allowed of all its workers should be restored.
4734 */
4735static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4736{
4737 static cpumask_t cpumask;
4738 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004739
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004740 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004741
4742 /* is @cpu allowed for @pool? */
4743 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4744 return;
4745
Tejun Heo7dbc7252013-03-19 13:45:21 -07004746 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004747
4748 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004749 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004750 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004751}
4752
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004753int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004754{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004755 struct worker_pool *pool;
4756
4757 for_each_cpu_worker_pool(pool, cpu) {
4758 if (pool->nr_workers)
4759 continue;
4760 if (!create_worker(pool))
4761 return -ENOMEM;
4762 }
4763 return 0;
4764}
4765
4766int workqueue_online_cpu(unsigned int cpu)
4767{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004768 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004769 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004770 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004771
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004772 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004773
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004774 for_each_pool(pool, pi) {
4775 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004776
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004777 if (pool->cpu == cpu)
4778 rebind_workers(pool);
4779 else if (pool->cpu < 0)
4780 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004781
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004782 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004783 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004784
4785 /* update NUMA affinity of unbound workqueues */
4786 list_for_each_entry(wq, &workqueues, list)
4787 wq_update_unbound_numa(wq, cpu, true);
4788
4789 mutex_unlock(&wq_pool_mutex);
4790 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004791}
4792
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004793int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004794{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004795 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004796
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004797 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004798 if (WARN_ON(cpu != smp_processor_id()))
4799 return -1;
4800
4801 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004802
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004803 /* update NUMA affinity of unbound workqueues */
4804 mutex_lock(&wq_pool_mutex);
4805 list_for_each_entry(wq, &workqueues, list)
4806 wq_update_unbound_numa(wq, cpu, false);
4807 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004808
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004809 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004810}
4811
Rusty Russell2d3854a2008-11-05 13:39:10 +11004812#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004813
Rusty Russell2d3854a2008-11-05 13:39:10 +11004814struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004815 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004816 long (*fn)(void *);
4817 void *arg;
4818 long ret;
4819};
4820
Tejun Heoed48ece2012-09-18 12:48:43 -07004821static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004822{
Tejun Heoed48ece2012-09-18 12:48:43 -07004823 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4824
Rusty Russell2d3854a2008-11-05 13:39:10 +11004825 wfc->ret = wfc->fn(wfc->arg);
4826}
4827
4828/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004829 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004830 * @cpu: the cpu to run on
4831 * @fn: the function to run
4832 * @arg: the function arg
4833 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004834 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004835 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004836 *
4837 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004838 */
Tejun Heod84ff052013-03-12 11:29:59 -07004839long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004840{
Tejun Heoed48ece2012-09-18 12:48:43 -07004841 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004842
Tejun Heoed48ece2012-09-18 12:48:43 -07004843 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4844 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004845 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004846 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004847 return wfc.ret;
4848}
4849EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004850
4851/**
4852 * work_on_cpu_safe - run a function in thread context on a particular cpu
4853 * @cpu: the cpu to run on
4854 * @fn: the function to run
4855 * @arg: the function argument
4856 *
4857 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4858 * any locks which would prevent @fn from completing.
4859 *
4860 * Return: The value @fn returns.
4861 */
4862long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4863{
4864 long ret = -ENODEV;
4865
4866 get_online_cpus();
4867 if (cpu_online(cpu))
4868 ret = work_on_cpu(cpu, fn, arg);
4869 put_online_cpus();
4870 return ret;
4871}
4872EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004873#endif /* CONFIG_SMP */
4874
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004875#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304876
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004877/**
4878 * freeze_workqueues_begin - begin freezing workqueues
4879 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004880 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004881 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004882 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004883 *
4884 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004885 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886 */
4887void freeze_workqueues_begin(void)
4888{
Tejun Heo24b8a842013-03-12 11:29:58 -07004889 struct workqueue_struct *wq;
4890 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004891
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004892 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004893
Tejun Heo6183c002013-03-12 11:29:57 -07004894 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004895 workqueue_freezing = true;
4896
Tejun Heo24b8a842013-03-12 11:29:58 -07004897 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004898 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004899 for_each_pwq(pwq, wq)
4900 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004901 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004902 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004903
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004904 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004905}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004906
4907/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004908 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004909 *
4910 * Check whether freezing is complete. This function must be called
4911 * between freeze_workqueues_begin() and thaw_workqueues().
4912 *
4913 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004914 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004915 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004916 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004917 * %true if some freezable workqueues are still busy. %false if freezing
4918 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004919 */
4920bool freeze_workqueues_busy(void)
4921{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004922 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004923 struct workqueue_struct *wq;
4924 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004925
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004926 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004927
Tejun Heo6183c002013-03-12 11:29:57 -07004928 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004929
Tejun Heo24b8a842013-03-12 11:29:58 -07004930 list_for_each_entry(wq, &workqueues, list) {
4931 if (!(wq->flags & WQ_FREEZABLE))
4932 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004933 /*
4934 * nr_active is monotonically decreasing. It's safe
4935 * to peek without lock.
4936 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004937 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004938 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004939 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004940 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004941 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004942 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004943 goto out_unlock;
4944 }
4945 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004946 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004947 }
4948out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004949 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004950 return busy;
4951}
4952
4953/**
4954 * thaw_workqueues - thaw workqueues
4955 *
4956 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004957 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004958 *
4959 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004960 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004961 */
4962void thaw_workqueues(void)
4963{
Tejun Heo24b8a842013-03-12 11:29:58 -07004964 struct workqueue_struct *wq;
4965 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004966
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004967 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004968
4969 if (!workqueue_freezing)
4970 goto out_unlock;
4971
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004972 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004973
Tejun Heo24b8a842013-03-12 11:29:58 -07004974 /* restore max_active and repopulate worklist */
4975 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004976 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004977 for_each_pwq(pwq, wq)
4978 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004979 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004980 }
4981
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004982out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004983 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004984}
4985#endif /* CONFIG_FREEZER */
4986
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004987static int workqueue_apply_unbound_cpumask(void)
4988{
4989 LIST_HEAD(ctxs);
4990 int ret = 0;
4991 struct workqueue_struct *wq;
4992 struct apply_wqattrs_ctx *ctx, *n;
4993
4994 lockdep_assert_held(&wq_pool_mutex);
4995
4996 list_for_each_entry(wq, &workqueues, list) {
4997 if (!(wq->flags & WQ_UNBOUND))
4998 continue;
4999 /* creating multiple pwqs breaks ordering guarantee */
5000 if (wq->flags & __WQ_ORDERED)
5001 continue;
5002
5003 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5004 if (!ctx) {
5005 ret = -ENOMEM;
5006 break;
5007 }
5008
5009 list_add_tail(&ctx->list, &ctxs);
5010 }
5011
5012 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5013 if (!ret)
5014 apply_wqattrs_commit(ctx);
5015 apply_wqattrs_cleanup(ctx);
5016 }
5017
5018 return ret;
5019}
5020
5021/**
5022 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5023 * @cpumask: the cpumask to set
5024 *
5025 * The low-level workqueues cpumask is a global cpumask that limits
5026 * the affinity of all unbound workqueues. This function check the @cpumask
5027 * and apply it to all unbound workqueues and updates all pwqs of them.
5028 *
5029 * Retun: 0 - Success
5030 * -EINVAL - Invalid @cpumask
5031 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5032 */
5033int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5034{
5035 int ret = -EINVAL;
5036 cpumask_var_t saved_cpumask;
5037
5038 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5039 return -ENOMEM;
5040
Tal Shorerc98a9802017-11-03 17:27:50 +02005041 /*
5042 * Not excluding isolated cpus on purpose.
5043 * If the user wishes to include them, we allow that.
5044 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005045 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5046 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005047 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005048
5049 /* save the old wq_unbound_cpumask. */
5050 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5051
5052 /* update wq_unbound_cpumask at first and apply it to wqs. */
5053 cpumask_copy(wq_unbound_cpumask, cpumask);
5054 ret = workqueue_apply_unbound_cpumask();
5055
5056 /* restore the wq_unbound_cpumask when failed. */
5057 if (ret < 0)
5058 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5059
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005060 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005061 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005062
5063 free_cpumask_var(saved_cpumask);
5064 return ret;
5065}
5066
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005067#ifdef CONFIG_SYSFS
5068/*
5069 * Workqueues with WQ_SYSFS flag set is visible to userland via
5070 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5071 * following attributes.
5072 *
5073 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5074 * max_active RW int : maximum number of in-flight work items
5075 *
5076 * Unbound workqueues have the following extra attributes.
5077 *
Wang Long9a19b462017-11-02 23:05:12 -04005078 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005079 * nice RW int : nice value of the workers
5080 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005081 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005082 */
5083struct wq_device {
5084 struct workqueue_struct *wq;
5085 struct device dev;
5086};
5087
5088static struct workqueue_struct *dev_to_wq(struct device *dev)
5089{
5090 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5091
5092 return wq_dev->wq;
5093}
5094
5095static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5096 char *buf)
5097{
5098 struct workqueue_struct *wq = dev_to_wq(dev);
5099
5100 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5101}
5102static DEVICE_ATTR_RO(per_cpu);
5103
5104static ssize_t max_active_show(struct device *dev,
5105 struct device_attribute *attr, char *buf)
5106{
5107 struct workqueue_struct *wq = dev_to_wq(dev);
5108
5109 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5110}
5111
5112static ssize_t max_active_store(struct device *dev,
5113 struct device_attribute *attr, const char *buf,
5114 size_t count)
5115{
5116 struct workqueue_struct *wq = dev_to_wq(dev);
5117 int val;
5118
5119 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5120 return -EINVAL;
5121
5122 workqueue_set_max_active(wq, val);
5123 return count;
5124}
5125static DEVICE_ATTR_RW(max_active);
5126
5127static struct attribute *wq_sysfs_attrs[] = {
5128 &dev_attr_per_cpu.attr,
5129 &dev_attr_max_active.attr,
5130 NULL,
5131};
5132ATTRIBUTE_GROUPS(wq_sysfs);
5133
5134static ssize_t wq_pool_ids_show(struct device *dev,
5135 struct device_attribute *attr, char *buf)
5136{
5137 struct workqueue_struct *wq = dev_to_wq(dev);
5138 const char *delim = "";
5139 int node, written = 0;
5140
5141 rcu_read_lock_sched();
5142 for_each_node(node) {
5143 written += scnprintf(buf + written, PAGE_SIZE - written,
5144 "%s%d:%d", delim, node,
5145 unbound_pwq_by_node(wq, node)->pool->id);
5146 delim = " ";
5147 }
5148 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5149 rcu_read_unlock_sched();
5150
5151 return written;
5152}
5153
5154static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5155 char *buf)
5156{
5157 struct workqueue_struct *wq = dev_to_wq(dev);
5158 int written;
5159
5160 mutex_lock(&wq->mutex);
5161 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5162 mutex_unlock(&wq->mutex);
5163
5164 return written;
5165}
5166
5167/* prepare workqueue_attrs for sysfs store operations */
5168static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5169{
5170 struct workqueue_attrs *attrs;
5171
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005172 lockdep_assert_held(&wq_pool_mutex);
5173
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005174 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5175 if (!attrs)
5176 return NULL;
5177
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005178 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005179 return attrs;
5180}
5181
5182static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5183 const char *buf, size_t count)
5184{
5185 struct workqueue_struct *wq = dev_to_wq(dev);
5186 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005187 int ret = -ENOMEM;
5188
5189 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005190
5191 attrs = wq_sysfs_prep_attrs(wq);
5192 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005193 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005194
5195 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5196 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005197 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005198 else
5199 ret = -EINVAL;
5200
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005201out_unlock:
5202 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005203 free_workqueue_attrs(attrs);
5204 return ret ?: count;
5205}
5206
5207static ssize_t wq_cpumask_show(struct device *dev,
5208 struct device_attribute *attr, char *buf)
5209{
5210 struct workqueue_struct *wq = dev_to_wq(dev);
5211 int written;
5212
5213 mutex_lock(&wq->mutex);
5214 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5215 cpumask_pr_args(wq->unbound_attrs->cpumask));
5216 mutex_unlock(&wq->mutex);
5217 return written;
5218}
5219
5220static ssize_t wq_cpumask_store(struct device *dev,
5221 struct device_attribute *attr,
5222 const char *buf, size_t count)
5223{
5224 struct workqueue_struct *wq = dev_to_wq(dev);
5225 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005226 int ret = -ENOMEM;
5227
5228 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005229
5230 attrs = wq_sysfs_prep_attrs(wq);
5231 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005232 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005233
5234 ret = cpumask_parse(buf, attrs->cpumask);
5235 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005236 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005237
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005238out_unlock:
5239 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005240 free_workqueue_attrs(attrs);
5241 return ret ?: count;
5242}
5243
5244static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5245 char *buf)
5246{
5247 struct workqueue_struct *wq = dev_to_wq(dev);
5248 int written;
5249
5250 mutex_lock(&wq->mutex);
5251 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5252 !wq->unbound_attrs->no_numa);
5253 mutex_unlock(&wq->mutex);
5254
5255 return written;
5256}
5257
5258static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5259 const char *buf, size_t count)
5260{
5261 struct workqueue_struct *wq = dev_to_wq(dev);
5262 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005263 int v, ret = -ENOMEM;
5264
5265 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005266
5267 attrs = wq_sysfs_prep_attrs(wq);
5268 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005269 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005270
5271 ret = -EINVAL;
5272 if (sscanf(buf, "%d", &v) == 1) {
5273 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005274 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005275 }
5276
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005277out_unlock:
5278 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005279 free_workqueue_attrs(attrs);
5280 return ret ?: count;
5281}
5282
5283static struct device_attribute wq_sysfs_unbound_attrs[] = {
5284 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5285 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5286 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5287 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5288 __ATTR_NULL,
5289};
5290
5291static struct bus_type wq_subsys = {
5292 .name = "workqueue",
5293 .dev_groups = wq_sysfs_groups,
5294};
5295
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005296static ssize_t wq_unbound_cpumask_show(struct device *dev,
5297 struct device_attribute *attr, char *buf)
5298{
5299 int written;
5300
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005301 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005302 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5303 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005304 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005305
5306 return written;
5307}
5308
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005309static ssize_t wq_unbound_cpumask_store(struct device *dev,
5310 struct device_attribute *attr, const char *buf, size_t count)
5311{
5312 cpumask_var_t cpumask;
5313 int ret;
5314
5315 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5316 return -ENOMEM;
5317
5318 ret = cpumask_parse(buf, cpumask);
5319 if (!ret)
5320 ret = workqueue_set_unbound_cpumask(cpumask);
5321
5322 free_cpumask_var(cpumask);
5323 return ret ? ret : count;
5324}
5325
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005326static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005327 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5328 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005329
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005330static int __init wq_sysfs_init(void)
5331{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005332 int err;
5333
5334 err = subsys_virtual_register(&wq_subsys, NULL);
5335 if (err)
5336 return err;
5337
5338 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005339}
5340core_initcall(wq_sysfs_init);
5341
5342static void wq_device_release(struct device *dev)
5343{
5344 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5345
5346 kfree(wq_dev);
5347}
5348
5349/**
5350 * workqueue_sysfs_register - make a workqueue visible in sysfs
5351 * @wq: the workqueue to register
5352 *
5353 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5354 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5355 * which is the preferred method.
5356 *
5357 * Workqueue user should use this function directly iff it wants to apply
5358 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5359 * apply_workqueue_attrs() may race against userland updating the
5360 * attributes.
5361 *
5362 * Return: 0 on success, -errno on failure.
5363 */
5364int workqueue_sysfs_register(struct workqueue_struct *wq)
5365{
5366 struct wq_device *wq_dev;
5367 int ret;
5368
5369 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305370 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005371 * attributes breaks ordering guarantee. Disallow exposing ordered
5372 * workqueues.
5373 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005374 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005375 return -EINVAL;
5376
5377 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5378 if (!wq_dev)
5379 return -ENOMEM;
5380
5381 wq_dev->wq = wq;
5382 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005383 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005384 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005385
5386 /*
5387 * unbound_attrs are created separately. Suppress uevent until
5388 * everything is ready.
5389 */
5390 dev_set_uevent_suppress(&wq_dev->dev, true);
5391
5392 ret = device_register(&wq_dev->dev);
5393 if (ret) {
5394 kfree(wq_dev);
5395 wq->wq_dev = NULL;
5396 return ret;
5397 }
5398
5399 if (wq->flags & WQ_UNBOUND) {
5400 struct device_attribute *attr;
5401
5402 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5403 ret = device_create_file(&wq_dev->dev, attr);
5404 if (ret) {
5405 device_unregister(&wq_dev->dev);
5406 wq->wq_dev = NULL;
5407 return ret;
5408 }
5409 }
5410 }
5411
5412 dev_set_uevent_suppress(&wq_dev->dev, false);
5413 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5414 return 0;
5415}
5416
5417/**
5418 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5419 * @wq: the workqueue to unregister
5420 *
5421 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5422 */
5423static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5424{
5425 struct wq_device *wq_dev = wq->wq_dev;
5426
5427 if (!wq->wq_dev)
5428 return;
5429
5430 wq->wq_dev = NULL;
5431 device_unregister(&wq_dev->dev);
5432}
5433#else /* CONFIG_SYSFS */
5434static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5435#endif /* CONFIG_SYSFS */
5436
Tejun Heo82607adc2015-12-08 11:28:04 -05005437/*
5438 * Workqueue watchdog.
5439 *
5440 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5441 * flush dependency, a concurrency managed work item which stays RUNNING
5442 * indefinitely. Workqueue stalls can be very difficult to debug as the
5443 * usual warning mechanisms don't trigger and internal workqueue state is
5444 * largely opaque.
5445 *
5446 * Workqueue watchdog monitors all worker pools periodically and dumps
5447 * state if some pools failed to make forward progress for a while where
5448 * forward progress is defined as the first item on ->worklist changing.
5449 *
5450 * This mechanism is controlled through the kernel parameter
5451 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5452 * corresponding sysfs parameter file.
5453 */
5454#ifdef CONFIG_WQ_WATCHDOG
5455
Tejun Heo82607adc2015-12-08 11:28:04 -05005456static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005457static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005458
5459static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5460static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5461
5462static void wq_watchdog_reset_touched(void)
5463{
5464 int cpu;
5465
5466 wq_watchdog_touched = jiffies;
5467 for_each_possible_cpu(cpu)
5468 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5469}
5470
Kees Cook5cd79d62017-10-04 16:27:00 -07005471static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005472{
5473 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5474 bool lockup_detected = false;
5475 struct worker_pool *pool;
5476 int pi;
5477
5478 if (!thresh)
5479 return;
5480
5481 rcu_read_lock();
5482
5483 for_each_pool(pool, pi) {
5484 unsigned long pool_ts, touched, ts;
5485
5486 if (list_empty(&pool->worklist))
5487 continue;
5488
5489 /* get the latest of pool and touched timestamps */
5490 pool_ts = READ_ONCE(pool->watchdog_ts);
5491 touched = READ_ONCE(wq_watchdog_touched);
5492
5493 if (time_after(pool_ts, touched))
5494 ts = pool_ts;
5495 else
5496 ts = touched;
5497
5498 if (pool->cpu >= 0) {
5499 unsigned long cpu_touched =
5500 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5501 pool->cpu));
5502 if (time_after(cpu_touched, ts))
5503 ts = cpu_touched;
5504 }
5505
5506 /* did we stall? */
5507 if (time_after(jiffies, ts + thresh)) {
5508 lockup_detected = true;
5509 pr_emerg("BUG: workqueue lockup - pool");
5510 pr_cont_pool_info(pool);
5511 pr_cont(" stuck for %us!\n",
5512 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5513 }
5514 }
5515
5516 rcu_read_unlock();
5517
5518 if (lockup_detected)
5519 show_workqueue_state();
5520
5521 wq_watchdog_reset_touched();
5522 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5523}
5524
5525void wq_watchdog_touch(int cpu)
5526{
5527 if (cpu >= 0)
5528 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5529 else
5530 wq_watchdog_touched = jiffies;
5531}
5532
5533static void wq_watchdog_set_thresh(unsigned long thresh)
5534{
5535 wq_watchdog_thresh = 0;
5536 del_timer_sync(&wq_watchdog_timer);
5537
5538 if (thresh) {
5539 wq_watchdog_thresh = thresh;
5540 wq_watchdog_reset_touched();
5541 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5542 }
5543}
5544
5545static int wq_watchdog_param_set_thresh(const char *val,
5546 const struct kernel_param *kp)
5547{
5548 unsigned long thresh;
5549 int ret;
5550
5551 ret = kstrtoul(val, 0, &thresh);
5552 if (ret)
5553 return ret;
5554
5555 if (system_wq)
5556 wq_watchdog_set_thresh(thresh);
5557 else
5558 wq_watchdog_thresh = thresh;
5559
5560 return 0;
5561}
5562
5563static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5564 .set = wq_watchdog_param_set_thresh,
5565 .get = param_get_ulong,
5566};
5567
5568module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5569 0644);
5570
5571static void wq_watchdog_init(void)
5572{
Kees Cook5cd79d62017-10-04 16:27:00 -07005573 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005574 wq_watchdog_set_thresh(wq_watchdog_thresh);
5575}
5576
5577#else /* CONFIG_WQ_WATCHDOG */
5578
5579static inline void wq_watchdog_init(void) { }
5580
5581#endif /* CONFIG_WQ_WATCHDOG */
5582
Tejun Heobce90382013-04-01 11:23:32 -07005583static void __init wq_numa_init(void)
5584{
5585 cpumask_var_t *tbl;
5586 int node, cpu;
5587
Tejun Heobce90382013-04-01 11:23:32 -07005588 if (num_possible_nodes() <= 1)
5589 return;
5590
Tejun Heod55262c2013-04-01 11:23:38 -07005591 if (wq_disable_numa) {
5592 pr_info("workqueue: NUMA affinity support disabled\n");
5593 return;
5594 }
5595
Tejun Heo4c16bd32013-04-01 11:23:36 -07005596 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5597 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5598
Tejun Heobce90382013-04-01 11:23:32 -07005599 /*
5600 * We want masks of possible CPUs of each node which isn't readily
5601 * available. Build one from cpu_to_node() which should have been
5602 * fully initialized by now.
5603 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005604 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005605 BUG_ON(!tbl);
5606
5607 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005608 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005609 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005610
5611 for_each_possible_cpu(cpu) {
5612 node = cpu_to_node(cpu);
5613 if (WARN_ON(node == NUMA_NO_NODE)) {
5614 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5615 /* happens iff arch is bonkers, let's just proceed */
5616 return;
5617 }
5618 cpumask_set_cpu(cpu, tbl[node]);
5619 }
5620
5621 wq_numa_possible_cpumask = tbl;
5622 wq_numa_enabled = true;
5623}
5624
Tejun Heo3347fa02016-09-16 15:49:32 -04005625/**
5626 * workqueue_init_early - early init for workqueue subsystem
5627 *
5628 * This is the first half of two-staged workqueue subsystem initialization
5629 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5630 * idr are up. It sets up all the data structures and system workqueues
5631 * and allows early boot code to create workqueues and queue/cancel work
5632 * items. Actual work item execution starts only after kthreads can be
5633 * created and scheduled right before early initcalls.
5634 */
5635int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005636{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005637 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5638 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005639
Tejun Heoe904e6c2013-03-12 11:29:57 -07005640 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5641
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005642 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Tal Shorerc98a9802017-11-03 17:27:50 +02005643 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(HK_FLAG_DOMAIN));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005644
Tejun Heoe904e6c2013-03-12 11:29:57 -07005645 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5646
Tejun Heo706026c2013-01-24 11:01:34 -08005647 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005648 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005649 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005650
Tejun Heo7a4e3442013-03-12 11:30:00 -07005651 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005652 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005653 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005654 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005655 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005656 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005657 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005658
Tejun Heo9daf9e62013-01-24 11:01:33 -08005659 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005660 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005661 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005662 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005663 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005664 }
5665
Tejun Heo8a2b7532013-09-05 12:30:04 -04005666 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005667 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5668 struct workqueue_attrs *attrs;
5669
5670 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005671 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005672 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005673
5674 /*
5675 * An ordered wq should have only one pwq as ordering is
5676 * guaranteed by max_active which is enforced by pwqs.
5677 * Turn off NUMA so that dfl_pwq is used for all nodes.
5678 */
5679 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5680 attrs->nice = std_nice[i];
5681 attrs->no_numa = true;
5682 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005683 }
5684
Tejun Heod320c032010-06-29 10:07:14 +02005685 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005686 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005687 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005688 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5689 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005690 system_freezable_wq = alloc_workqueue("events_freezable",
5691 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305692 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5693 WQ_POWER_EFFICIENT, 0);
5694 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5695 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5696 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005697 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305698 !system_unbound_wq || !system_freezable_wq ||
5699 !system_power_efficient_wq ||
5700 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005701
Tejun Heo3347fa02016-09-16 15:49:32 -04005702 return 0;
5703}
5704
5705/**
5706 * workqueue_init - bring workqueue subsystem fully online
5707 *
5708 * This is the latter half of two-staged workqueue subsystem initialization
5709 * and invoked as soon as kthreads can be created and scheduled.
5710 * Workqueues have been created and work items queued on them, but there
5711 * are no kworkers executing the work items yet. Populate the worker pools
5712 * with the initial workers and enable future kworker creations.
5713 */
5714int __init workqueue_init(void)
5715{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005716 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005717 struct worker_pool *pool;
5718 int cpu, bkt;
5719
Tejun Heo2186d9f2016-10-19 12:01:27 -04005720 /*
5721 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5722 * CPU to node mapping may not be available that early on some
5723 * archs such as power and arm64. As per-cpu pools created
5724 * previously could be missing node hint and unbound pools NUMA
5725 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005726 *
5727 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005728 */
5729 wq_numa_init();
5730
5731 mutex_lock(&wq_pool_mutex);
5732
5733 for_each_possible_cpu(cpu) {
5734 for_each_cpu_worker_pool(pool, cpu) {
5735 pool->node = cpu_to_node(cpu);
5736 }
5737 }
5738
Tejun Heo40c17f72018-01-08 05:38:37 -08005739 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005740 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005741 WARN(init_rescuer(wq),
5742 "workqueue: failed to create early rescuer for %s",
5743 wq->name);
5744 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005745
5746 mutex_unlock(&wq_pool_mutex);
5747
Tejun Heo3347fa02016-09-16 15:49:32 -04005748 /* create the initial workers */
5749 for_each_online_cpu(cpu) {
5750 for_each_cpu_worker_pool(pool, cpu) {
5751 pool->flags &= ~POOL_DISASSOCIATED;
5752 BUG_ON(!create_worker(pool));
5753 }
5754 }
5755
5756 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5757 BUG_ON(!create_worker(pool));
5758
5759 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005760 wq_watchdog_init();
5761
Suresh Siddha6ee05782010-07-30 14:57:37 -07005762 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005763}