blob: fb29ca991361a838fae346d2a4c32a35301570ef [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 *
24 * Please read Documentation/workqueue.txt 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 Lameter46934022006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Sergey Senozhatskyca2d7362018-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 Heo43a980a2017-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 Heo4b5facd2016-09-16 15:49:32 -0400294bool wq_online; /* can kworkers be created yet? */
295
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 Heo43a980a2017-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 Heof303fcc2016-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 Heo794b18b2013-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, Changbinb9fdac72016-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, Changbinb9fdac72016-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 Heo974271c2012-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 Heo974271c2012-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 Heo43a980a2017-10-09 08:04:13 -0700806 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700807 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
808 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200809
810 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
811}
812
813/*
814 * Wake up functions.
815 */
816
Lai Jiangshan1037de32014-05-22 16:44:07 +0800817/* Return the first idle worker. Safe with preemption disabled */
818static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200819{
Tejun Heo63d95a92012-07-12 14:46:37 -0700820 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200821 return NULL;
822
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200824}
825
826/**
827 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200831 *
832 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800833 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200834 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700835static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200836{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800837 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200838
839 if (likely(worker))
840 wake_up_process(worker->task);
841}
842
Tejun Heo4690c4a2010-06-29 10:07:10 +0200843/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 * wq_worker_waking_up - a worker is waking up
845 * @task: task waking up
846 * @cpu: CPU @task is waking up to
847 *
848 * This function is called during try_to_wake_up() when a worker is
849 * being awoken.
850 *
851 * CONTEXT:
852 * spin_lock_irq(rq->lock)
853 */
Tejun Heod84ff052013-03-12 11:29:59 -0700854void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200855{
856 struct worker *worker = kthread_data(task);
857
Joonsoo Kim36576002012-10-26 23:03:49 +0900858 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800859 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800860 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900861 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200862}
863
864/**
865 * wq_worker_sleeping - a worker is going to sleep
866 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200867 *
868 * This function is called during schedule() when a busy worker is
869 * going to sleep. Worker on the same cpu can be woken up by
870 * returning pointer to its task.
871 *
872 * CONTEXT:
873 * spin_lock_irq(rq->lock)
874 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700875 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200876 * Worker task on @cpu to wake up, %NULL if none.
877 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100878struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200879{
880 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800881 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200882
Tejun Heo111c2252013-01-17 17:16:24 -0800883 /*
884 * Rescuers, which may not have all the fields set up like normal
885 * workers, also reach here, let's not access anything before
886 * checking NOT_RUNNING.
887 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500888 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200889 return NULL;
890
Tejun Heo111c2252013-01-17 17:16:24 -0800891 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800892
Tejun Heoe22bee72010-06-29 10:07:14 +0200893 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100894 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700895 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200896
897 /*
898 * The counterpart of the following dec_and_test, implied mb,
899 * worklist not empty test sequence is in insert_work().
900 * Please read comment there.
901 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700902 * NOT_RUNNING is clear. This means that we're bound to and
903 * running on the local cpu w/ rq lock held and preemption
904 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800905 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700906 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200907 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800908 if (atomic_dec_and_test(&pool->nr_running) &&
909 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800910 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 return to_wakeup ? to_wakeup->task : NULL;
912}
913
914/**
Johannes Weinerb7f0f222019-02-01 14:20:42 -0800915 * wq_worker_last_func - retrieve worker's last work function
916 *
917 * Determine the last function a worker executed. This is called from
918 * the scheduler to get a worker's last known identity.
919 *
920 * CONTEXT:
921 * spin_lock_irq(rq->lock)
922 *
923 * Return:
924 * The last work function %current executed as a worker, NULL if it
925 * hasn't executed any work yet.
926 */
927work_func_t wq_worker_last_func(struct task_struct *task)
928{
929 struct worker *worker = kthread_data(task);
930
931 return worker->last_func;
932}
933
934/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200935 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200936 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200937 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200938 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800939 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200940 *
Tejun Heocb444762010-07-02 10:03:50 +0200941 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800942 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200943 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800944static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200945{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700946 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200947
Tejun Heocb444762010-07-02 10:03:50 +0200948 WARN_ON_ONCE(worker->task != current);
949
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800950 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200951 if ((flags & WORKER_NOT_RUNNING) &&
952 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800953 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200954 }
955
Tejun Heod302f012010-06-29 10:07:13 +0200956 worker->flags |= flags;
957}
958
959/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200960 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200961 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200962 * @flags: flags to clear
963 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200964 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200965 *
Tejun Heocb444762010-07-02 10:03:50 +0200966 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800967 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200968 */
969static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
970{
Tejun Heo63d95a92012-07-12 14:46:37 -0700971 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200972 unsigned int oflags = worker->flags;
973
Tejun Heocb444762010-07-02 10:03:50 +0200974 WARN_ON_ONCE(worker->task != current);
975
Tejun Heod302f012010-06-29 10:07:13 +0200976 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200977
Tejun Heo42c025f2011-01-11 15:58:49 +0100978 /*
979 * If transitioning out of NOT_RUNNING, increment nr_running. Note
980 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
981 * of multiple flags, not a single flag.
982 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200983 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
984 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800985 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200986}
987
988/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200989 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800990 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200991 * @work: work to find worker for
992 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800993 * Find a worker which is executing @work on @pool by searching
994 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800995 * to match, its current execution should match the address of @work and
996 * its work function. This is to avoid unwanted dependency between
997 * unrelated work executions through a work item being recycled while still
998 * being executed.
999 *
1000 * This is a bit tricky. A work item may be freed once its execution
1001 * starts and nothing prevents the freed area from being recycled for
1002 * another work item. If the same work item address ends up being reused
1003 * before the original execution finishes, workqueue will identify the
1004 * recycled work item as currently executing and make it wait until the
1005 * current execution finishes, introducing an unwanted dependency.
1006 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001007 * This function checks the work item address and work function to avoid
1008 * false positives. Note that this isn't complete as one may construct a
1009 * work function which can introduce dependency onto itself through a
1010 * recycled work item. Well, if somebody wants to shoot oneself in the
1011 * foot that badly, there's only so much we can do, and if such deadlock
1012 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001013 *
1014 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001015 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001016 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001017 * Return:
1018 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001019 * otherwise.
1020 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001021static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001022 struct work_struct *work)
1023{
Sasha Levin42f85702012-12-17 10:01:23 -05001024 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001025
Sasha Levinb67bfe02013-02-27 17:06:00 -08001026 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001027 (unsigned long)work)
1028 if (worker->current_work == work &&
1029 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001030 return worker;
1031
1032 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001033}
1034
1035/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001036 * move_linked_works - move linked works to a list
1037 * @work: start of series of works to be scheduled
1038 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301039 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001040 *
1041 * Schedule linked works starting from @work to @head. Work series to
1042 * be scheduled starts at @work and includes any consecutive work with
1043 * WORK_STRUCT_LINKED set in its predecessor.
1044 *
1045 * If @nextp is not NULL, it's updated to point to the next work of
1046 * the last scheduled work. This allows move_linked_works() to be
1047 * nested inside outer list_for_each_entry_safe().
1048 *
1049 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001050 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001051 */
1052static void move_linked_works(struct work_struct *work, struct list_head *head,
1053 struct work_struct **nextp)
1054{
1055 struct work_struct *n;
1056
1057 /*
1058 * Linked worklist will always end before the end of the list,
1059 * use NULL for list head.
1060 */
1061 list_for_each_entry_safe_from(work, n, NULL, entry) {
1062 list_move_tail(&work->entry, head);
1063 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1064 break;
1065 }
1066
1067 /*
1068 * If we're already inside safe list traversal and have moved
1069 * multiple works to the scheduled queue, the next position
1070 * needs to be updated.
1071 */
1072 if (nextp)
1073 *nextp = n;
1074}
1075
Tejun Heo8864b4e2013-03-12 11:30:04 -07001076/**
1077 * get_pwq - get an extra reference on the specified pool_workqueue
1078 * @pwq: pool_workqueue to get
1079 *
1080 * Obtain an extra reference on @pwq. The caller should guarantee that
1081 * @pwq has positive refcnt and be holding the matching pool->lock.
1082 */
1083static void get_pwq(struct pool_workqueue *pwq)
1084{
1085 lockdep_assert_held(&pwq->pool->lock);
1086 WARN_ON_ONCE(pwq->refcnt <= 0);
1087 pwq->refcnt++;
1088}
1089
1090/**
1091 * put_pwq - put a pool_workqueue reference
1092 * @pwq: pool_workqueue to put
1093 *
1094 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1095 * destruction. The caller should be holding the matching pool->lock.
1096 */
1097static void put_pwq(struct pool_workqueue *pwq)
1098{
1099 lockdep_assert_held(&pwq->pool->lock);
1100 if (likely(--pwq->refcnt))
1101 return;
1102 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1103 return;
1104 /*
1105 * @pwq can't be released under pool->lock, bounce to
1106 * pwq_unbound_release_workfn(). This never recurses on the same
1107 * pool->lock as this path is taken only for unbound workqueues and
1108 * the release work item is scheduled on a per-cpu workqueue. To
1109 * avoid lockdep warning, unbound pool->locks are given lockdep
1110 * subclass of 1 in get_unbound_pool().
1111 */
1112 schedule_work(&pwq->unbound_release_work);
1113}
1114
Tejun Heodce90d42013-04-01 11:23:35 -07001115/**
1116 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1117 * @pwq: pool_workqueue to put (can be %NULL)
1118 *
1119 * put_pwq() with locking. This function also allows %NULL @pwq.
1120 */
1121static void put_pwq_unlocked(struct pool_workqueue *pwq)
1122{
1123 if (pwq) {
1124 /*
1125 * As both pwqs and pools are sched-RCU protected, the
1126 * following lock operations are safe.
1127 */
1128 spin_lock_irq(&pwq->pool->lock);
1129 put_pwq(pwq);
1130 spin_unlock_irq(&pwq->pool->lock);
1131 }
1132}
1133
Tejun Heo112202d2013-02-13 19:29:12 -08001134static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001135{
Tejun Heo112202d2013-02-13 19:29:12 -08001136 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001137
1138 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001139 if (list_empty(&pwq->pool->worklist))
1140 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001141 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001142 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001143 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001144}
1145
Tejun Heo112202d2013-02-13 19:29:12 -08001146static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001147{
Tejun Heo112202d2013-02-13 19:29:12 -08001148 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001149 struct work_struct, entry);
1150
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001152}
1153
Tejun Heobf4ede02012-08-03 10:30:46 -07001154/**
Tejun Heo112202d2013-02-13 19:29:12 -08001155 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1156 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001157 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001158 *
1159 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001160 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001161 *
1162 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001163 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001164 */
Tejun Heo112202d2013-02-13 19:29:12 -08001165static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001166{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001167 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001168 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001169 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001170
Tejun Heo112202d2013-02-13 19:29:12 -08001171 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001172
Tejun Heo112202d2013-02-13 19:29:12 -08001173 pwq->nr_active--;
1174 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001175 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001176 if (pwq->nr_active < pwq->max_active)
1177 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001178 }
1179
1180 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001181 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001182 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001183
1184 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001185 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001186 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001187
Tejun Heo112202d2013-02-13 19:29:12 -08001188 /* this pwq is done, clear flush_color */
1189 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001190
1191 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001192 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001193 * will handle the rest.
1194 */
Tejun Heo112202d2013-02-13 19:29:12 -08001195 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1196 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001197out_put:
1198 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001199}
1200
Tejun Heo36e227d2012-08-03 10:30:46 -07001201/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001202 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001203 * @work: work item to steal
1204 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001205 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001206 *
1207 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001208 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001209 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001210 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001211 * 1 if @work was pending and we successfully stole PENDING
1212 * 0 if @work was idle and we claimed PENDING
1213 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001214 * -ENOENT if someone else is canceling @work, this state may persist
1215 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001216 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001217 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001218 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001219 * interrupted while holding PENDING and @work off queue, irq must be
1220 * disabled on entry. This, combined with delayed_work->timer being
1221 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001222 *
1223 * On successful return, >= 0, irq is disabled and the caller is
1224 * responsible for releasing it using local_irq_restore(*@flags).
1225 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001226 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001227 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001228static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1229 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001230{
Tejun Heod565ed62013-01-24 11:01:33 -08001231 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001232 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001233
Tejun Heobbb68df2012-08-03 10:30:46 -07001234 local_irq_save(*flags);
1235
Tejun Heo36e227d2012-08-03 10:30:46 -07001236 /* try to steal the timer if it exists */
1237 if (is_dwork) {
1238 struct delayed_work *dwork = to_delayed_work(work);
1239
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001240 /*
1241 * dwork->timer is irqsafe. If del_timer() fails, it's
1242 * guaranteed that the timer is not queued anywhere and not
1243 * running on the local CPU.
1244 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001245 if (likely(del_timer(&dwork->timer)))
1246 return 1;
1247 }
1248
1249 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001250 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1251 return 0;
1252
1253 /*
1254 * The queueing is in progress, or it is already queued. Try to
1255 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1256 */
Tejun Heod565ed62013-01-24 11:01:33 -08001257 pool = get_work_pool(work);
1258 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001259 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001260
Tejun Heod565ed62013-01-24 11:01:33 -08001261 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001262 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001263 * work->data is guaranteed to point to pwq only while the work
1264 * item is queued on pwq->wq, and both updating work->data to point
1265 * to pwq on queueing and to pool on dequeueing are done under
1266 * pwq->pool->lock. This in turn guarantees that, if work->data
1267 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001268 * item is currently queued on that pool.
1269 */
Tejun Heo112202d2013-02-13 19:29:12 -08001270 pwq = get_work_pwq(work);
1271 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001272 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001273
Tejun Heo16062832013-02-06 18:04:53 -08001274 /*
1275 * A delayed work item cannot be grabbed directly because
1276 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001277 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001278 * management later on and cause stall. Make sure the work
1279 * item is activated before grabbing.
1280 */
1281 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001282 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001283
Tejun Heo16062832013-02-06 18:04:53 -08001284 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001285 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001286
Tejun Heo112202d2013-02-13 19:29:12 -08001287 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001288 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001289
Tejun Heo16062832013-02-06 18:04:53 -08001290 spin_unlock(&pool->lock);
1291 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001292 }
Tejun Heod565ed62013-01-24 11:01:33 -08001293 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001294fail:
1295 local_irq_restore(*flags);
1296 if (work_is_canceling(work))
1297 return -ENOENT;
1298 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001299 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001300}
1301
1302/**
Tejun Heo706026c2013-01-24 11:01:34 -08001303 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001304 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001305 * @work: work to insert
1306 * @head: insertion point
1307 * @extra_flags: extra WORK_STRUCT_* flags to set
1308 *
Tejun Heo112202d2013-02-13 19:29:12 -08001309 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001310 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001311 *
1312 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001313 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001314 */
Tejun Heo112202d2013-02-13 19:29:12 -08001315static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1316 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001317{
Tejun Heo112202d2013-02-13 19:29:12 -08001318 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001319
Tejun Heo4690c4a2010-06-29 10:07:10 +02001320 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001321 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001322 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001323 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001324
1325 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001326 * Ensure either wq_worker_sleeping() sees the above
1327 * list_add_tail() or we see zero nr_running to avoid workers lying
1328 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001329 */
1330 smp_mb();
1331
Tejun Heo63d95a92012-07-12 14:46:37 -07001332 if (__need_more_worker(pool))
1333 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001334}
1335
Tejun Heoc8efcc22010-12-20 19:32:04 +01001336/*
1337 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001338 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001339 */
1340static bool is_chained_work(struct workqueue_struct *wq)
1341{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001342 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001343
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001344 worker = current_wq_worker();
1345 /*
1346 * Return %true iff I'm a worker execuing a work item on @wq. If
1347 * I'm @worker, it's safe to dereference it without locking.
1348 */
Tejun Heo112202d2013-02-13 19:29:12 -08001349 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001350}
1351
Mike Galbraithef5571802016-02-09 17:59:38 -05001352/*
1353 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1354 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1355 * avoid perturbing sensitive tasks.
1356 */
1357static int wq_select_unbound_cpu(int cpu)
1358{
Tejun Heof303fcc2016-02-09 17:59:38 -05001359 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001360 int new_cpu;
1361
Tejun Heof303fcc2016-02-09 17:59:38 -05001362 if (likely(!wq_debug_force_rr_cpu)) {
1363 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1364 return cpu;
1365 } else if (!printed_dbg_warning) {
1366 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1367 printed_dbg_warning = true;
1368 }
1369
Mike Galbraithef5571802016-02-09 17:59:38 -05001370 if (cpumask_empty(wq_unbound_cpumask))
1371 return cpu;
1372
1373 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1374 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1375 if (unlikely(new_cpu >= nr_cpu_ids)) {
1376 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1377 if (unlikely(new_cpu >= nr_cpu_ids))
1378 return cpu;
1379 }
1380 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1381
1382 return new_cpu;
1383}
1384
Tejun Heod84ff052013-03-12 11:29:59 -07001385static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 struct work_struct *work)
1387{
Tejun Heo112202d2013-02-13 19:29:12 -08001388 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001389 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001390 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001391 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001392 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001393
1394 /*
1395 * While a work item is PENDING && off queue, a task trying to
1396 * steal the PENDING will busy-loop waiting for it to either get
1397 * queued or lose PENDING. Grabbing PENDING and queueing should
1398 * happen with IRQ disabled.
1399 */
1400 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001402 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001403
Li Bin9ef28a72013-09-09 13:13:58 +08001404 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001405 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001406 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001407 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001408retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001409 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001410 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001411
Tejun Heoc9178082013-03-12 11:30:04 -07001412 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001413 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001414 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001415 else
1416 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001417
Tejun Heoc9178082013-03-12 11:30:04 -07001418 /*
1419 * If @work was previously on a different pool, it might still be
1420 * running there, in which case the work needs to be queued on that
1421 * pool to guarantee non-reentrancy.
1422 */
1423 last_pool = get_work_pool(work);
1424 if (last_pool && last_pool != pwq->pool) {
1425 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001426
Tejun Heoc9178082013-03-12 11:30:04 -07001427 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001428
Tejun Heoc9178082013-03-12 11:30:04 -07001429 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001430
Tejun Heoc9178082013-03-12 11:30:04 -07001431 if (worker && worker->current_pwq->wq == wq) {
1432 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001433 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001434 /* meh... not running there, queue here */
1435 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001436 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001437 }
Tejun Heof3421792010-07-02 10:03:51 +02001438 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001439 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001440 }
1441
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001442 /*
1443 * pwq is determined and locked. For unbound pools, we could have
1444 * raced with pwq release and it could already be dead. If its
1445 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001446 * without another pwq replacing it in the numa_pwq_tbl or while
1447 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001448 * make forward-progress.
1449 */
1450 if (unlikely(!pwq->refcnt)) {
1451 if (wq->flags & WQ_UNBOUND) {
1452 spin_unlock(&pwq->pool->lock);
1453 cpu_relax();
1454 goto retry;
1455 }
1456 /* oops */
1457 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1458 wq->name, cpu);
1459 }
1460
Tejun Heo112202d2013-02-13 19:29:12 -08001461 /* pwq determined, queue */
1462 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001463
Dan Carpenterf5b25522012-04-13 22:06:58 +03001464 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001465 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001466 return;
1467 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001468
Tejun Heo112202d2013-02-13 19:29:12 -08001469 pwq->nr_in_flight[pwq->work_color]++;
1470 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001471
Tejun Heo112202d2013-02-13 19:29:12 -08001472 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001473 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001474 pwq->nr_active++;
1475 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001476 if (list_empty(worklist))
1477 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001478 } else {
1479 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001480 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001481 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001482
Tejun Heo112202d2013-02-13 19:29:12 -08001483 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001484
Tejun Heo112202d2013-02-13 19:29:12 -08001485 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486}
1487
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001488/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001489 * queue_work_on - queue work on specific cpu
1490 * @cpu: CPU number to execute work on
1491 * @wq: workqueue to use
1492 * @work: work to queue
1493 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494 * We queue the work to a specific CPU, the caller must ensure it
1495 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001496 *
1497 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001498 */
Tejun Heod4283e92012-08-03 10:30:44 -07001499bool queue_work_on(int cpu, struct workqueue_struct *wq,
1500 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001501{
Tejun Heod4283e92012-08-03 10:30:44 -07001502 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001503 unsigned long flags;
1504
1505 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001506
Tejun Heo22df02b2010-06-29 10:07:10 +02001507 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001508 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001509 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001510 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001511
1512 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001513 return ret;
1514}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001515EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001516
Tejun Heod8e794d2012-08-03 10:30:45 -07001517void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518{
David Howells52bad642006-11-22 14:54:01 +00001519 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001521 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001522 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001524EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001526static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1527 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001529 struct timer_list *timer = &dwork->timer;
1530 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Tejun Heo757e1842017-03-06 15:33:42 -05001532 WARN_ON_ONCE(!wq);
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001533 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1534 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001535 WARN_ON_ONCE(timer_pending(timer));
1536 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001537
Tejun Heo8852aac2012-12-01 16:23:42 -08001538 /*
1539 * If @delay is 0, queue @dwork->work immediately. This is for
1540 * both optimization and correctness. The earliest @timer can
1541 * expire is on the closest next tick and delayed_work users depend
1542 * on that there's no such delay when @delay is 0.
1543 */
1544 if (!delay) {
1545 __queue_work(cpu, wq, &dwork->work);
1546 return;
1547 }
1548
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001549 timer_stats_timer_set_start_info(&dwork->timer);
1550
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001551 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001552 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001553 timer->expires = jiffies + delay;
1554
Tejun Heo041bd122016-02-09 16:11:26 -05001555 if (unlikely(cpu != WORK_CPU_UNBOUND))
1556 add_timer_on(timer, cpu);
1557 else
1558 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559}
1560
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001561/**
1562 * queue_delayed_work_on - queue work on specific CPU after delay
1563 * @cpu: CPU number to execute work on
1564 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001565 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001566 * @delay: number of jiffies to wait before queueing
1567 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001568 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001569 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1570 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001571 */
Tejun Heod4283e92012-08-03 10:30:44 -07001572bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1573 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001574{
David Howells52bad642006-11-22 14:54:01 +00001575 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001576 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001577 unsigned long flags;
1578
1579 /* read the comment in __queue_work() */
1580 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001581
Tejun Heo22df02b2010-06-29 10:07:10 +02001582 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001583 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001584 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001585 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001586
1587 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001588 return ret;
1589}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001590EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Tejun Heoc8e55f32010-06-29 10:07:12 +02001592/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001593 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1594 * @cpu: CPU number to execute work on
1595 * @wq: workqueue to use
1596 * @dwork: work to queue
1597 * @delay: number of jiffies to wait before queueing
1598 *
1599 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1600 * modify @dwork's timer so that it expires after @delay. If @delay is
1601 * zero, @work is guaranteed to be scheduled immediately regardless of its
1602 * current state.
1603 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001604 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001605 * pending and its timer was modified.
1606 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001607 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001608 * See try_to_grab_pending() for details.
1609 */
1610bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1611 struct delayed_work *dwork, unsigned long delay)
1612{
1613 unsigned long flags;
1614 int ret;
1615
1616 do {
1617 ret = try_to_grab_pending(&dwork->work, true, &flags);
1618 } while (unlikely(ret == -EAGAIN));
1619
1620 if (likely(ret >= 0)) {
1621 __queue_delayed_work(cpu, wq, dwork, delay);
1622 local_irq_restore(flags);
1623 }
1624
1625 /* -ENOENT from try_to_grab_pending() becomes %true */
1626 return ret;
1627}
1628EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1629
1630/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001631 * worker_enter_idle - enter idle state
1632 * @worker: worker which is entering idle state
1633 *
1634 * @worker is entering idle state. Update stats and idle timer if
1635 * necessary.
1636 *
1637 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001638 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001639 */
1640static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001642 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Tejun Heo6183c002013-03-12 11:29:57 -07001644 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1645 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1646 (worker->hentry.next || worker->hentry.pprev)))
1647 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Lai Jiangshan051e1852014-07-22 13:03:02 +08001649 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001650 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001651 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001652 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001653
Tejun Heoc8e55f32010-06-29 10:07:12 +02001654 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001655 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001656
Tejun Heo628c78e2012-07-17 12:39:27 -07001657 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1658 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001659
Tejun Heo544ecf32012-05-14 15:04:50 -07001660 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001661 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001662 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001663 * nr_running, the warning may trigger spuriously. Check iff
1664 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001665 */
Tejun Heo24647572013-01-24 11:01:33 -08001666 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001667 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001668 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669}
1670
Tejun Heoc8e55f32010-06-29 10:07:12 +02001671/**
1672 * worker_leave_idle - leave idle state
1673 * @worker: worker which is leaving idle state
1674 *
1675 * @worker is leaving idle state. Update stats.
1676 *
1677 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001678 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001679 */
1680static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001682 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683
Tejun Heo6183c002013-03-12 11:29:57 -07001684 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1685 return;
Tejun Heod302f012010-06-29 10:07:13 +02001686 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001687 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001688 list_del_init(&worker->entry);
1689}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001691static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001692{
1693 struct worker *worker;
1694
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001695 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001696 if (worker) {
1697 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001698 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001699 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001700 /* on creation a worker is in !idle && prep state */
1701 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001702 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001703 return worker;
1704}
1705
1706/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001707 * worker_attach_to_pool() - attach a worker to a pool
1708 * @worker: worker to be attached
1709 * @pool: the target pool
1710 *
1711 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1712 * cpu-binding of @worker are kept coordinated with the pool across
1713 * cpu-[un]hotplugs.
1714 */
1715static void worker_attach_to_pool(struct worker *worker,
1716 struct worker_pool *pool)
1717{
1718 mutex_lock(&pool->attach_mutex);
1719
1720 /*
1721 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1722 * online CPUs. It'll be re-applied when any of the CPUs come up.
1723 */
1724 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1725
1726 /*
1727 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1728 * stable across this function. See the comments above the
1729 * flag definition for details.
1730 */
1731 if (pool->flags & POOL_DISASSOCIATED)
1732 worker->flags |= WORKER_UNBOUND;
1733
1734 list_add_tail(&worker->node, &pool->workers);
1735
1736 mutex_unlock(&pool->attach_mutex);
1737}
1738
1739/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001740 * worker_detach_from_pool() - detach a worker from its pool
1741 * @worker: worker which is attached to its pool
1742 * @pool: the pool @worker is attached to
1743 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001744 * Undo the attaching which had been done in worker_attach_to_pool(). The
1745 * caller worker shouldn't access to the pool after detached except it has
1746 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001747 */
1748static void worker_detach_from_pool(struct worker *worker,
1749 struct worker_pool *pool)
1750{
1751 struct completion *detach_completion = NULL;
1752
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001753 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001754 list_del(&worker->node);
1755 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001756 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001757 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001758
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001759 /* clear leftover flags without pool->lock after it is detached */
1760 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1761
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001762 if (detach_completion)
1763 complete(detach_completion);
1764}
1765
1766/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001767 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001768 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001770 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001771 *
1772 * CONTEXT:
1773 * Might sleep. Does GFP_KERNEL allocations.
1774 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001775 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001776 * Pointer to the newly created worker.
1777 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001778static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001779{
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001781 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001782 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001783
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001784 /* ID is needed to determine kthread name */
1785 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001786 if (id < 0)
1787 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001788
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001789 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001790 if (!worker)
1791 goto fail;
1792
Tejun Heobd7bdd42012-07-12 14:46:37 -07001793 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001794 worker->id = id;
1795
Tejun Heo29c91e92013-03-12 11:30:03 -07001796 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001797 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1798 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001799 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001800 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1801
Tejun Heof3f90ad2013-04-01 11:23:34 -07001802 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001803 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001804 if (IS_ERR(worker->task))
1805 goto fail;
1806
Oleg Nesterov91151222013-11-14 12:56:18 +01001807 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001808 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001809
Lai Jiangshanda028462014-05-20 17:46:31 +08001810 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001811 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001812
Lai Jiangshan051e1852014-07-22 13:03:02 +08001813 /* start the newly created worker */
1814 spin_lock_irq(&pool->lock);
1815 worker->pool->nr_workers++;
1816 worker_enter_idle(worker);
1817 wake_up_process(worker->task);
1818 spin_unlock_irq(&pool->lock);
1819
Tejun Heoc34056a2010-06-29 10:07:11 +02001820 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001821
Tejun Heoc34056a2010-06-29 10:07:11 +02001822fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001823 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001824 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001825 kfree(worker);
1826 return NULL;
1827}
1828
1829/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001830 * destroy_worker - destroy a workqueue worker
1831 * @worker: worker to be destroyed
1832 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001833 * Destroy @worker and adjust @pool stats accordingly. The worker should
1834 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001835 *
1836 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001837 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001838 */
1839static void destroy_worker(struct worker *worker)
1840{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001841 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001842
Tejun Heocd549682013-03-13 19:47:39 -07001843 lockdep_assert_held(&pool->lock);
1844
Tejun Heoc34056a2010-06-29 10:07:11 +02001845 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001846 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001847 WARN_ON(!list_empty(&worker->scheduled)) ||
1848 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001849 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001850
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001851 pool->nr_workers--;
1852 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001853
Tejun Heoc8e55f32010-06-29 10:07:12 +02001854 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001855 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001856 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001857}
1858
Tejun Heo63d95a92012-07-12 14:46:37 -07001859static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001860{
Tejun Heo63d95a92012-07-12 14:46:37 -07001861 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001862
Tejun Heod565ed62013-01-24 11:01:33 -08001863 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001864
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001865 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001866 struct worker *worker;
1867 unsigned long expires;
1868
1869 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001870 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001871 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1872
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001873 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001874 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001875 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001876 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001877
1878 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001879 }
1880
Tejun Heod565ed62013-01-24 11:01:33 -08001881 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001882}
1883
Tejun Heo493a1722013-03-12 11:29:59 -07001884static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001885{
Tejun Heo112202d2013-02-13 19:29:12 -08001886 struct pool_workqueue *pwq = get_work_pwq(work);
1887 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001888
Tejun Heo2e109a22013-03-13 19:47:40 -07001889 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001890
Tejun Heo493008a2013-03-12 11:30:03 -07001891 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001892 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001893
1894 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001895 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001896 /*
1897 * If @pwq is for an unbound wq, its base ref may be put at
1898 * any time due to an attribute change. Pin @pwq until the
1899 * rescuer is done with it.
1900 */
1901 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001902 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001903 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001904 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001905}
1906
Tejun Heo706026c2013-01-24 11:01:34 -08001907static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001908{
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 struct work_struct *work;
1911
Tejun Heob2d82902014-12-08 12:39:16 -05001912 spin_lock_irq(&pool->lock);
1913 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001914
Tejun Heo63d95a92012-07-12 14:46:37 -07001915 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001916 /*
1917 * We've been trying to create a new worker but
1918 * haven't been successful. We might be hitting an
1919 * allocation deadlock. Send distress signals to
1920 * rescuers.
1921 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001922 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 send_mayday(work);
1924 }
1925
Tejun Heob2d82902014-12-08 12:39:16 -05001926 spin_unlock(&wq_mayday_lock);
1927 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001928
Tejun Heo63d95a92012-07-12 14:46:37 -07001929 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001930}
1931
1932/**
1933 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001935 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001936 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001937 * have at least one idle worker on return from this function. If
1938 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001939 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001940 * possible allocation deadlock.
1941 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001942 * On return, need_to_create_worker() is guaranteed to be %false and
1943 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 *
1945 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001946 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 * multiple times. Does GFP_KERNEL allocations. Called only from
1948 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 */
Tejun Heo29187a92015-01-16 14:21:16 -05001950static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001951__releases(&pool->lock)
1952__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001953{
Tejun Heoe22bee72010-06-29 10:07:14 +02001954restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001955 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001956
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001959
1960 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001961 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001962 break;
1963
Lai Jiangshane212f362014-06-03 15:32:17 +08001964 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001965
Tejun Heo63d95a92012-07-12 14:46:37 -07001966 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 break;
1968 }
1969
Tejun Heo63d95a92012-07-12 14:46:37 -07001970 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001971 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001972 /*
1973 * This is necessary even after a new worker was just successfully
1974 * created as @pool->lock was dropped and the new worker might have
1975 * already become busy.
1976 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001977 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001979}
1980
1981/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001982 * manage_workers - manage worker pool
1983 * @worker: self
1984 *
Tejun Heo706026c2013-01-24 11:01:34 -08001985 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001986 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001987 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001988 *
1989 * The caller can safely start processing works on false return. On
1990 * true return, it's guaranteed that need_to_create_worker() is false
1991 * and may_start_working() is true.
1992 *
1993 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001994 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001995 * multiple times. Does GFP_KERNEL allocations.
1996 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001997 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001998 * %false if the pool doesn't need management and the caller can safely
1999 * start processing works, %true if management function was performed and
2000 * the conditions that the caller verified before calling the function may
2001 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002002 */
2003static bool manage_workers(struct worker *worker)
2004{
Tejun Heo63d95a92012-07-12 14:46:37 -07002005 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002006
Tejun Heo43a980a2017-10-09 08:04:13 -07002007 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002008 return false;
Tejun Heo43a980a2017-10-09 08:04:13 -07002009
2010 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002011 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002012
Tejun Heo29187a92015-01-16 14:21:16 -05002013 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002014
Tejun Heo2607d7a2015-03-09 09:22:28 -04002015 pool->manager = NULL;
Tejun Heo43a980a2017-10-09 08:04:13 -07002016 pool->flags &= ~POOL_MANAGER_ACTIVE;
2017 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002018 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002019}
2020
Tejun Heoa62428c2010-06-29 10:07:10 +02002021/**
2022 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002023 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002024 * @work: work to process
2025 *
2026 * Process @work. This function contains all the logics necessary to
2027 * process a single work including synchronization against and
2028 * interaction with other workers on the same cpu, queueing and
2029 * flushing. As long as context requirement is met, any worker can
2030 * call this function to process a work.
2031 *
2032 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002033 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002034 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002035static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002036__releases(&pool->lock)
2037__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002038{
Tejun Heo112202d2013-02-13 19:29:12 -08002039 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002040 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002041 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002042 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002043 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002044#ifdef CONFIG_LOCKDEP
2045 /*
2046 * It is permissible to free the struct work_struct from
2047 * inside the function that is called from it, this we need to
2048 * take into account for lockdep too. To avoid bogus "held
2049 * lock freed" warnings as well as problems when looking into
2050 * work->lockdep_map, make a copy and use that here.
2051 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002052 struct lockdep_map lockdep_map;
2053
2054 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002055#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002056 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002057 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002058 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002059
Tejun Heo7e116292010-06-29 10:07:13 +02002060 /*
2061 * A single work shouldn't be executed concurrently by
2062 * multiple workers on a single cpu. Check whether anyone is
2063 * already processing the work. If so, defer the work to the
2064 * currently executing one.
2065 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002066 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002067 if (unlikely(collision)) {
2068 move_linked_works(work, &collision->scheduled, NULL);
2069 return;
2070 }
2071
Tejun Heo8930cab2012-08-03 10:30:45 -07002072 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002073 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002074 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002075 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002076 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002077 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002078 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002079
Tejun Heoa62428c2010-06-29 10:07:10 +02002080 list_del_init(&work->entry);
2081
Tejun Heo649027d2010-06-29 10:07:14 +02002082 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002083 * CPU intensive works don't participate in concurrency management.
2084 * They're the scheduler's responsibility. This takes @worker out
2085 * of concurrency management and the next code block will chain
2086 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002087 */
2088 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002089 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002090
Tejun Heo974271c2012-07-12 14:46:37 -07002091 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002092 * Wake up another worker if necessary. The condition is always
2093 * false for normal per-cpu workers since nr_running would always
2094 * be >= 1 at this point. This is used to chain execution of the
2095 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002096 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002097 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002098 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002099 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002100
Tejun Heo8930cab2012-08-03 10:30:45 -07002101 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002102 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002103 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002104 * PENDING and queued state changes happen together while IRQ is
2105 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002106 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002107 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002108
Tejun Heod565ed62013-01-24 11:01:33 -08002109 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002110
Tejun Heo112202d2013-02-13 19:29:12 -08002111 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002112 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002113 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002114 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002115 /*
2116 * While we must be careful to not use "work" after this, the trace
2117 * point will only record its address.
2118 */
2119 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002120 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002121 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002122
2123 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002124 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2125 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002126 current->comm, preempt_count(), task_pid_nr(current),
2127 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002128 debug_show_held_locks(current);
2129 dump_stack();
2130 }
2131
Tejun Heob22ce272013-08-28 17:33:37 -04002132 /*
2133 * The following prevents a kworker from hogging CPU on !PREEMPT
2134 * kernels, where a requeueing work item waiting for something to
2135 * happen could deadlock with stop_machine as such work item could
2136 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002137 * stop_machine. At the same time, report a quiescent RCU state so
2138 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002139 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002140 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002141
Tejun Heod565ed62013-01-24 11:01:33 -08002142 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002143
Tejun Heofb0e7be2010-06-29 10:07:15 +02002144 /* clear cpu intensive status */
2145 if (unlikely(cpu_intensive))
2146 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2147
Johannes Weinerb7f0f222019-02-01 14:20:42 -08002148 /* tag the worker for identification in schedule() */
2149 worker->last_func = worker->current_func;
2150
Tejun Heoa62428c2010-06-29 10:07:10 +02002151 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002152 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002153 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002154 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002155 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002156 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002157 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002158}
2159
Tejun Heoaffee4b2010-06-29 10:07:12 +02002160/**
2161 * process_scheduled_works - process scheduled works
2162 * @worker: self
2163 *
2164 * Process all scheduled works. Please note that the scheduled list
2165 * may change while processing a work, so this function repeatedly
2166 * fetches a work from the top and executes it.
2167 *
2168 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002169 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002170 * multiple times.
2171 */
2172static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002174 while (!list_empty(&worker->scheduled)) {
2175 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002177 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179}
2180
Tejun Heo4690c4a2010-06-29 10:07:10 +02002181/**
2182 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002183 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002184 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002185 * The worker thread function. All workers belong to a worker_pool -
2186 * either a per-cpu one or dynamic unbound one. These workers process all
2187 * work items regardless of their specific target workqueue. The only
2188 * exception is work items which belong to workqueues with a rescuer which
2189 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002190 *
2191 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002192 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002193static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194{
Tejun Heoc34056a2010-06-29 10:07:11 +02002195 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002196 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197
Tejun Heoe22bee72010-06-29 10:07:14 +02002198 /* tell the scheduler that this is a workqueue worker */
2199 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002200woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002201 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002202
Tejun Heoa9ab7752013-03-19 13:45:21 -07002203 /* am I supposed to die? */
2204 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002205 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002206 WARN_ON_ONCE(!list_empty(&worker->entry));
2207 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002208
2209 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002210 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002211 worker_detach_from_pool(worker, pool);
2212 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002213 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002215
Tejun Heoc8e55f32010-06-29 10:07:12 +02002216 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002217recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002218 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002219 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002220 goto sleep;
2221
2222 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002223 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002224 goto recheck;
2225
Tejun Heoc8e55f32010-06-29 10:07:12 +02002226 /*
2227 * ->scheduled list can only be filled while a worker is
2228 * preparing to process a work or actually processing it.
2229 * Make sure nobody diddled with it while I was sleeping.
2230 */
Tejun Heo6183c002013-03-12 11:29:57 -07002231 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002232
Tejun Heoe22bee72010-06-29 10:07:14 +02002233 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002234 * Finish PREP stage. We're guaranteed to have at least one idle
2235 * worker or that someone else has already assumed the manager
2236 * role. This is where @worker starts participating in concurrency
2237 * management if applicable and concurrency management is restored
2238 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002239 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002240 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002241
2242 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002243 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002244 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245 struct work_struct, entry);
2246
Tejun Heo82607adc2015-12-08 11:28:04 -05002247 pool->watchdog_ts = jiffies;
2248
Tejun Heoc8e55f32010-06-29 10:07:12 +02002249 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2250 /* optimization path, not strictly necessary */
2251 process_one_work(worker, work);
2252 if (unlikely(!list_empty(&worker->scheduled)))
2253 process_scheduled_works(worker);
2254 } else {
2255 move_linked_works(work, &worker->scheduled, NULL);
2256 process_scheduled_works(worker);
2257 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002258 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002259
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002260 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002261sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002262 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002263 * pool->lock is held and there's no work to process and no need to
2264 * manage, sleep. Workers are woken up only while holding
2265 * pool->lock or from local cpu, so setting the current state
2266 * before releasing pool->lock is enough to prevent losing any
2267 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002268 */
2269 worker_enter_idle(worker);
2270 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002271 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002272 schedule();
2273 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274}
2275
Tejun Heoe22bee72010-06-29 10:07:14 +02002276/**
2277 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002278 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002279 *
2280 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002281 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002282 *
Tejun Heo706026c2013-01-24 11:01:34 -08002283 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002284 * worker which uses GFP_KERNEL allocation which has slight chance of
2285 * developing into deadlock if some works currently on the same queue
2286 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2287 * the problem rescuer solves.
2288 *
Tejun Heo706026c2013-01-24 11:01:34 -08002289 * When such condition is possible, the pool summons rescuers of all
2290 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002291 * those works so that forward progress can be guaranteed.
2292 *
2293 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002294 *
2295 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002296 */
Tejun Heo111c2252013-01-17 17:16:24 -08002297static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002298{
Tejun Heo111c2252013-01-17 17:16:24 -08002299 struct worker *rescuer = __rescuer;
2300 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002301 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002302 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002303
2304 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002305
2306 /*
2307 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2308 * doesn't participate in concurrency management.
2309 */
2310 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002311repeat:
2312 set_current_state(TASK_INTERRUPTIBLE);
2313
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002314 /*
2315 * By the time the rescuer is requested to stop, the workqueue
2316 * shouldn't have any work pending, but @wq->maydays may still have
2317 * pwq(s) queued. This can happen by non-rescuer workers consuming
2318 * all the work items before the rescuer got to them. Go through
2319 * @wq->maydays processing before acting on should_stop so that the
2320 * list is always empty on exit.
2321 */
2322 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002323
Tejun Heo493a1722013-03-12 11:29:59 -07002324 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002325 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002326
2327 while (!list_empty(&wq->maydays)) {
2328 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2329 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002330 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002331 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002332 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002333
2334 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002335 list_del_init(&pwq->mayday_node);
2336
Tejun Heo2e109a22013-03-13 19:47:40 -07002337 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002338
Lai Jiangshan51697d392014-05-20 17:46:36 +08002339 worker_attach_to_pool(rescuer, pool);
2340
2341 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002342 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002343
2344 /*
2345 * Slurp in all works issued via this workqueue and
2346 * process'em.
2347 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002348 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002349 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2350 if (get_work_pwq(work) == pwq) {
2351 if (first)
2352 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002353 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002354 }
2355 first = false;
2356 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002357
NeilBrown008847f2014-12-08 12:39:16 -05002358 if (!list_empty(scheduled)) {
2359 process_scheduled_works(rescuer);
2360
2361 /*
2362 * The above execution of rescued work items could
2363 * have created more to rescue through
2364 * pwq_activate_first_delayed() or chained
2365 * queueing. Let's put @pwq back on mayday list so
2366 * that such back-to-back work items, which may be
2367 * being used to relieve memory pressure, don't
2368 * incur MAYDAY_INTERVAL delay inbetween.
2369 */
2370 if (need_to_create_worker(pool)) {
2371 spin_lock(&wq_mayday_lock);
2372 get_pwq(pwq);
2373 list_move_tail(&pwq->mayday_node, &wq->maydays);
2374 spin_unlock(&wq_mayday_lock);
2375 }
2376 }
Tejun Heo75769582011-02-14 14:04:46 +01002377
2378 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002379 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002380 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002381 */
2382 put_pwq(pwq);
2383
2384 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002385 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002386 * regular worker; otherwise, we end up with 0 concurrency
2387 * and stalling the execution.
2388 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002389 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002390 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002391
Lai Jiangshanb3104102013-02-19 12:17:02 -08002392 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002393 spin_unlock_irq(&pool->lock);
2394
2395 worker_detach_from_pool(rescuer, pool);
2396
2397 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002398 }
2399
Tejun Heo2e109a22013-03-13 19:47:40 -07002400 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002401
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002402 if (should_stop) {
2403 __set_current_state(TASK_RUNNING);
2404 rescuer->task->flags &= ~PF_WQ_WORKER;
2405 return 0;
2406 }
2407
Tejun Heo111c2252013-01-17 17:16:24 -08002408 /* rescuers should never participate in concurrency management */
2409 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002410 schedule();
2411 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412}
2413
Tejun Heofca839c2015-12-07 10:58:57 -05002414/**
2415 * check_flush_dependency - check for flush dependency sanity
2416 * @target_wq: workqueue being flushed
2417 * @target_work: work item being flushed (NULL for workqueue flushes)
2418 *
2419 * %current is trying to flush the whole @target_wq or @target_work on it.
2420 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2421 * reclaiming memory or running on a workqueue which doesn't have
2422 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2423 * a deadlock.
2424 */
2425static void check_flush_dependency(struct workqueue_struct *target_wq,
2426 struct work_struct *target_work)
2427{
2428 work_func_t target_func = target_work ? target_work->func : NULL;
2429 struct worker *worker;
2430
2431 if (target_wq->flags & WQ_MEM_RECLAIM)
2432 return;
2433
2434 worker = current_wq_worker();
2435
2436 WARN_ONCE(current->flags & PF_MEMALLOC,
2437 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2438 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002439 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2440 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002441 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2442 worker->current_pwq->wq->name, worker->current_func,
2443 target_wq->name, target_func);
2444}
2445
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002446struct wq_barrier {
2447 struct work_struct work;
2448 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002449 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002450};
2451
2452static void wq_barrier_func(struct work_struct *work)
2453{
2454 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2455 complete(&barr->done);
2456}
2457
Tejun Heo4690c4a2010-06-29 10:07:10 +02002458/**
2459 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002460 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002461 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002462 * @target: target work to attach @barr to
2463 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002464 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002465 * @barr is linked to @target such that @barr is completed only after
2466 * @target finishes execution. Please note that the ordering
2467 * guarantee is observed only with respect to @target and on the local
2468 * cpu.
2469 *
2470 * Currently, a queued barrier can't be canceled. This is because
2471 * try_to_grab_pending() can't determine whether the work to be
2472 * grabbed is at the head of the queue and thus can't clear LINKED
2473 * flag of the previous work while there must be a valid next work
2474 * after a work with LINKED flag set.
2475 *
2476 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002477 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002478 *
2479 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002480 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002481 */
Tejun Heo112202d2013-02-13 19:29:12 -08002482static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002483 struct wq_barrier *barr,
2484 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002485{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002486 struct list_head *head;
2487 unsigned int linked = 0;
2488
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002489 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002490 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002491 * as we know for sure that this will not trigger any of the
2492 * checks and call back into the fixup functions where we
2493 * might deadlock.
2494 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002495 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002496 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002497 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002498 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002499
Tejun Heoaffee4b2010-06-29 10:07:12 +02002500 /*
2501 * If @target is currently being executed, schedule the
2502 * barrier to the worker; otherwise, put it after @target.
2503 */
2504 if (worker)
2505 head = worker->scheduled.next;
2506 else {
2507 unsigned long *bits = work_data_bits(target);
2508
2509 head = target->entry.next;
2510 /* there can already be other linked works, inherit and set */
2511 linked = *bits & WORK_STRUCT_LINKED;
2512 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2513 }
2514
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002515 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002516 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002517 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002518}
2519
Tejun Heo73f53c42010-06-29 10:07:11 +02002520/**
Tejun Heo112202d2013-02-13 19:29:12 -08002521 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002522 * @wq: workqueue being flushed
2523 * @flush_color: new flush color, < 0 for no-op
2524 * @work_color: new work color, < 0 for no-op
2525 *
Tejun Heo112202d2013-02-13 19:29:12 -08002526 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002527 *
Tejun Heo112202d2013-02-13 19:29:12 -08002528 * If @flush_color is non-negative, flush_color on all pwqs should be
2529 * -1. If no pwq has in-flight commands at the specified color, all
2530 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2531 * has in flight commands, its pwq->flush_color is set to
2532 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002533 * wakeup logic is armed and %true is returned.
2534 *
2535 * The caller should have initialized @wq->first_flusher prior to
2536 * calling this function with non-negative @flush_color. If
2537 * @flush_color is negative, no flush color update is done and %false
2538 * is returned.
2539 *
Tejun Heo112202d2013-02-13 19:29:12 -08002540 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002541 * work_color which is previous to @work_color and all will be
2542 * advanced to @work_color.
2543 *
2544 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002545 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002546 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002547 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002548 * %true if @flush_color >= 0 and there's something to flush. %false
2549 * otherwise.
2550 */
Tejun Heo112202d2013-02-13 19:29:12 -08002551static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002552 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553{
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002555 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002556
Tejun Heo73f53c42010-06-29 10:07:11 +02002557 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002558 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002559 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002560 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002561
Tejun Heo49e3cf42013-03-12 11:29:58 -07002562 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002563 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002564
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002565 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002566
2567 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002568 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002569
Tejun Heo112202d2013-02-13 19:29:12 -08002570 if (pwq->nr_in_flight[flush_color]) {
2571 pwq->flush_color = flush_color;
2572 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 wait = true;
2574 }
2575 }
2576
2577 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002578 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002579 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002580 }
2581
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002582 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 }
2584
Tejun Heo112202d2013-02-13 19:29:12 -08002585 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 complete(&wq->first_flusher->done);
2587
2588 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589}
2590
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002591/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002593 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002595 * This function sleeps until all work items which were queued on entry
2596 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002598void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599{
Tejun Heo73f53c42010-06-29 10:07:11 +02002600 struct wq_flusher this_flusher = {
2601 .list = LIST_HEAD_INIT(this_flusher.list),
2602 .flush_color = -1,
2603 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2604 };
2605 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002606
Tejun Heo4b5facd2016-09-16 15:49:32 -04002607 if (WARN_ON(!wq_online))
2608 return;
2609
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002610 lock_map_acquire(&wq->lockdep_map);
2611 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002612
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002613 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002614
2615 /*
2616 * Start-to-wait phase
2617 */
2618 next_color = work_next_color(wq->work_color);
2619
2620 if (next_color != wq->flush_color) {
2621 /*
2622 * Color space is not full. The current work_color
2623 * becomes our flush_color and work_color is advanced
2624 * by one.
2625 */
Tejun Heo6183c002013-03-12 11:29:57 -07002626 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002627 this_flusher.flush_color = wq->work_color;
2628 wq->work_color = next_color;
2629
2630 if (!wq->first_flusher) {
2631 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002632 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002633
2634 wq->first_flusher = &this_flusher;
2635
Tejun Heo112202d2013-02-13 19:29:12 -08002636 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002637 wq->work_color)) {
2638 /* nothing to flush, done */
2639 wq->flush_color = next_color;
2640 wq->first_flusher = NULL;
2641 goto out_unlock;
2642 }
2643 } else {
2644 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002645 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002646 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002647 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002648 }
2649 } else {
2650 /*
2651 * Oops, color space is full, wait on overflow queue.
2652 * The next flush completion will assign us
2653 * flush_color and transfer to flusher_queue.
2654 */
2655 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2656 }
2657
Tejun Heofca839c2015-12-07 10:58:57 -05002658 check_flush_dependency(wq, NULL);
2659
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002660 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002661
2662 wait_for_completion(&this_flusher.done);
2663
2664 /*
2665 * Wake-up-and-cascade phase
2666 *
2667 * First flushers are responsible for cascading flushes and
2668 * handling overflow. Non-first flushers can simply return.
2669 */
2670 if (wq->first_flusher != &this_flusher)
2671 return;
2672
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002673 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002674
Tejun Heo4ce48b32010-07-02 10:03:51 +02002675 /* we might have raced, check again with mutex held */
2676 if (wq->first_flusher != &this_flusher)
2677 goto out_unlock;
2678
Tejun Heo73f53c42010-06-29 10:07:11 +02002679 wq->first_flusher = NULL;
2680
Tejun Heo6183c002013-03-12 11:29:57 -07002681 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2682 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002683
2684 while (true) {
2685 struct wq_flusher *next, *tmp;
2686
2687 /* complete all the flushers sharing the current flush color */
2688 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2689 if (next->flush_color != wq->flush_color)
2690 break;
2691 list_del_init(&next->list);
2692 complete(&next->done);
2693 }
2694
Tejun Heo6183c002013-03-12 11:29:57 -07002695 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2696 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002697
2698 /* this flush_color is finished, advance by one */
2699 wq->flush_color = work_next_color(wq->flush_color);
2700
2701 /* one color has been freed, handle overflow queue */
2702 if (!list_empty(&wq->flusher_overflow)) {
2703 /*
2704 * Assign the same color to all overflowed
2705 * flushers, advance work_color and append to
2706 * flusher_queue. This is the start-to-wait
2707 * phase for these overflowed flushers.
2708 */
2709 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2710 tmp->flush_color = wq->work_color;
2711
2712 wq->work_color = work_next_color(wq->work_color);
2713
2714 list_splice_tail_init(&wq->flusher_overflow,
2715 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002716 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002717 }
2718
2719 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002720 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002721 break;
2722 }
2723
2724 /*
2725 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002726 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002727 */
Tejun Heo6183c002013-03-12 11:29:57 -07002728 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2729 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002730
2731 list_del_init(&next->list);
2732 wq->first_flusher = next;
2733
Tejun Heo112202d2013-02-13 19:29:12 -08002734 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002735 break;
2736
2737 /*
2738 * Meh... this color is already done, clear first
2739 * flusher and repeat cascading.
2740 */
2741 wq->first_flusher = NULL;
2742 }
2743
2744out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002745 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002747EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002749/**
2750 * drain_workqueue - drain a workqueue
2751 * @wq: workqueue to drain
2752 *
2753 * Wait until the workqueue becomes empty. While draining is in progress,
2754 * only chain queueing is allowed. IOW, only currently pending or running
2755 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002756 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002757 * by the depth of chaining and should be relatively short. Whine if it
2758 * takes too long.
2759 */
2760void drain_workqueue(struct workqueue_struct *wq)
2761{
2762 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002763 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764
2765 /*
2766 * __queue_work() needs to test whether there are drainers, is much
2767 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002768 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002769 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002770 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002771 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002772 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002773 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002774reflush:
2775 flush_workqueue(wq);
2776
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002777 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002778
Tejun Heo49e3cf42013-03-12 11:29:58 -07002779 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002780 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002781
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002782 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002783 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002784 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002785
2786 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002787 continue;
2788
2789 if (++flush_cnt == 10 ||
2790 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002791 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002792 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002793
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002794 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002795 goto reflush;
2796 }
2797
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002798 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002799 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002800 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002801}
2802EXPORT_SYMBOL_GPL(drain_workqueue);
2803
Tejun Heo606a5022012-08-20 14:51:23 -07002804static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002805{
2806 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002807 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002808 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002809
2810 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002811
Tejun Heofa1b54e2013-03-12 11:30:00 -07002812 local_irq_disable();
2813 pool = get_work_pool(work);
2814 if (!pool) {
2815 local_irq_enable();
2816 return false;
2817 }
2818
2819 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002820 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002821 pwq = get_work_pwq(work);
2822 if (pwq) {
2823 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002824 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002825 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002826 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002827 if (!worker)
2828 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002829 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002830 }
Tejun Heobaf59022010-09-16 10:42:16 +02002831
Tejun Heofca839c2015-12-07 10:58:57 -05002832 check_flush_dependency(pwq->wq, work);
2833
Tejun Heo112202d2013-02-13 19:29:12 -08002834 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002835 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002836
Tejun Heoe1594892011-01-09 23:32:15 +01002837 /*
2838 * If @max_active is 1 or rescuer is in use, flushing another work
2839 * item on the same workqueue may lead to deadlock. Make sure the
2840 * flusher is not running on the same workqueue by verifying write
2841 * access.
2842 */
Tejun Heo493008a2013-03-12 11:30:03 -07002843 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002844 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002845 else
Tejun Heo112202d2013-02-13 19:29:12 -08002846 lock_map_acquire_read(&pwq->wq->lockdep_map);
2847 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002848
Tejun Heobaf59022010-09-16 10:42:16 +02002849 return true;
2850already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002851 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002852 return false;
2853}
2854
Oleg Nesterovdb700892008-07-25 01:47:49 -07002855/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002856 * flush_work - wait for a work to finish executing the last queueing instance
2857 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002858 *
Tejun Heo606a5022012-08-20 14:51:23 -07002859 * Wait until @work has finished execution. @work is guaranteed to be idle
2860 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002861 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002862 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002863 * %true if flush_work() waited for the work to finish execution,
2864 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002865 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002866bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002867{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002868 struct wq_barrier barr;
2869
Tejun Heo4b5facd2016-09-16 15:49:32 -04002870 if (WARN_ON(!wq_online))
2871 return false;
2872
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002873 lock_map_acquire(&work->lockdep_map);
2874 lock_map_release(&work->lockdep_map);
2875
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002876 if (start_flush_work(work, &barr)) {
2877 wait_for_completion(&barr.done);
2878 destroy_work_on_stack(&barr.work);
2879 return true;
2880 } else {
2881 return false;
2882 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002883}
2884EXPORT_SYMBOL_GPL(flush_work);
2885
Tejun Heo8603e1b32015-03-05 08:04:13 -05002886struct cwt_wait {
2887 wait_queue_t wait;
2888 struct work_struct *work;
2889};
2890
2891static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2892{
2893 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2894
2895 if (cwait->work != key)
2896 return 0;
2897 return autoremove_wake_function(wait, mode, sync, key);
2898}
2899
Tejun Heo36e227d2012-08-03 10:30:46 -07002900static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002901{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002902 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002903 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002904 int ret;
2905
2906 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002907 ret = try_to_grab_pending(work, is_dwork, &flags);
2908 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002909 * If someone else is already canceling, wait for it to
2910 * finish. flush_work() doesn't work for PREEMPT_NONE
2911 * because we may get scheduled between @work's completion
2912 * and the other canceling task resuming and clearing
2913 * CANCELING - flush_work() will return false immediately
2914 * as @work is no longer busy, try_to_grab_pending() will
2915 * return -ENOENT as @work is still being canceled and the
2916 * other canceling task won't be able to clear CANCELING as
2917 * we're hogging the CPU.
2918 *
2919 * Let's wait for completion using a waitqueue. As this
2920 * may lead to the thundering herd problem, use a custom
2921 * wake function which matches @work along with exclusive
2922 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002923 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002924 if (unlikely(ret == -ENOENT)) {
2925 struct cwt_wait cwait;
2926
2927 init_wait(&cwait.wait);
2928 cwait.wait.func = cwt_wakefn;
2929 cwait.work = work;
2930
2931 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2932 TASK_UNINTERRUPTIBLE);
2933 if (work_is_canceling(work))
2934 schedule();
2935 finish_wait(&cancel_waitq, &cwait.wait);
2936 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002937 } while (unlikely(ret < 0));
2938
Tejun Heobbb68df2012-08-03 10:30:46 -07002939 /* tell other tasks trying to grab @work to back off */
2940 mark_work_canceling(work);
2941 local_irq_restore(flags);
2942
Tejun Heo4b5facd2016-09-16 15:49:32 -04002943 /*
2944 * This allows canceling during early boot. We know that @work
2945 * isn't executing.
2946 */
2947 if (wq_online)
2948 flush_work(work);
2949
Tejun Heo7a22ad72010-06-29 10:07:13 +02002950 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002951
2952 /*
2953 * Paired with prepare_to_wait() above so that either
2954 * waitqueue_active() is visible here or !work_is_canceling() is
2955 * visible there.
2956 */
2957 smp_mb();
2958 if (waitqueue_active(&cancel_waitq))
2959 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2960
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002961 return ret;
2962}
2963
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002964/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002965 * cancel_work_sync - cancel a work and wait for it to finish
2966 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002967 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002968 * Cancel @work and wait for its execution to finish. This function
2969 * can be used even if the work re-queues itself or migrates to
2970 * another workqueue. On return from this function, @work is
2971 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002972 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002973 * cancel_work_sync(&delayed_work->work) must not be used for
2974 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002975 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002976 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002978 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002979 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002980 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002981 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002982bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002983{
Tejun Heo36e227d2012-08-03 10:30:46 -07002984 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002985}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002986EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002987
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002988/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002989 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2990 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002991 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * Delayed timer is cancelled and the pending work is queued for
2993 * immediate execution. Like flush_work(), this function only
2994 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002995 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002996 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002997 * %true if flush_work() waited for the work to finish execution,
2998 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002999 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003000bool flush_delayed_work(struct delayed_work *dwork)
3001{
Tejun Heo8930cab2012-08-03 10:30:45 -07003002 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003003 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003004 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003005 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003006 return flush_work(&dwork->work);
3007}
3008EXPORT_SYMBOL(flush_delayed_work);
3009
Jens Axboef72b8792016-08-24 15:51:50 -06003010static bool __cancel_work(struct work_struct *work, bool is_dwork)
3011{
3012 unsigned long flags;
3013 int ret;
3014
3015 do {
3016 ret = try_to_grab_pending(work, is_dwork, &flags);
3017 } while (unlikely(ret == -EAGAIN));
3018
3019 if (unlikely(ret < 0))
3020 return false;
3021
3022 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3023 local_irq_restore(flags);
3024 return ret;
3025}
3026
3027/*
3028 * See cancel_delayed_work()
3029 */
3030bool cancel_work(struct work_struct *work)
3031{
3032 return __cancel_work(work, false);
3033}
3034
Tejun Heo401a8d02010-09-16 10:36:00 +02003035/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003036 * cancel_delayed_work - cancel a delayed work
3037 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003038 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003039 * Kill off a pending delayed_work.
3040 *
3041 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3042 * pending.
3043 *
3044 * Note:
3045 * The work callback function may still be running on return, unless
3046 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3047 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003048 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003049 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003050 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003051bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003052{
Jens Axboef72b8792016-08-24 15:51:50 -06003053 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003054}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003055EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003056
3057/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003058 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3059 * @dwork: the delayed work cancel
3060 *
3061 * This is cancel_work_sync() for delayed works.
3062 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003063 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003064 * %true if @dwork was pending, %false otherwise.
3065 */
3066bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003067{
Tejun Heo36e227d2012-08-03 10:30:46 -07003068 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003069}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003070EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003072/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003073 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003074 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003075 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003076 * schedule_on_each_cpu() executes @func on each online CPU using the
3077 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003078 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003079 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003080 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003081 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003082 */
David Howells65f27f32006-11-22 14:55:48 +00003083int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003084{
3085 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003086 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003087
Andrew Mortonb6136772006-06-25 05:47:49 -07003088 works = alloc_percpu(struct work_struct);
3089 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003090 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003091
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003092 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003093
Christoph Lameter15316ba2006-01-08 01:00:43 -08003094 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003095 struct work_struct *work = per_cpu_ptr(works, cpu);
3096
3097 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003098 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003099 }
Tejun Heo93981802009-11-17 14:06:20 -08003100
3101 for_each_online_cpu(cpu)
3102 flush_work(per_cpu_ptr(works, cpu));
3103
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003104 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003105 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003106 return 0;
3107}
3108
Alan Sterneef6a7d2010-02-12 17:39:21 +09003109/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003110 * execute_in_process_context - reliably execute the routine with user context
3111 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003112 * @ew: guaranteed storage for the execute work structure (must
3113 * be available when the work executes)
3114 *
3115 * Executes the function immediately if process context is available,
3116 * otherwise schedules the function for delayed execution.
3117 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003118 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003119 * 1 - function was scheduled for execution
3120 */
David Howells65f27f32006-11-22 14:55:48 +00003121int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003122{
3123 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003124 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003125 return 0;
3126 }
3127
David Howells65f27f32006-11-22 14:55:48 +00003128 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003129 schedule_work(&ew->work);
3130
3131 return 1;
3132}
3133EXPORT_SYMBOL_GPL(execute_in_process_context);
3134
Tejun Heo7a4e3442013-03-12 11:30:00 -07003135/**
3136 * free_workqueue_attrs - free a workqueue_attrs
3137 * @attrs: workqueue_attrs to free
3138 *
3139 * Undo alloc_workqueue_attrs().
3140 */
3141void free_workqueue_attrs(struct workqueue_attrs *attrs)
3142{
3143 if (attrs) {
3144 free_cpumask_var(attrs->cpumask);
3145 kfree(attrs);
3146 }
3147}
3148
3149/**
3150 * alloc_workqueue_attrs - allocate a workqueue_attrs
3151 * @gfp_mask: allocation mask to use
3152 *
3153 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003154 * return it.
3155 *
3156 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003157 */
3158struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3159{
3160 struct workqueue_attrs *attrs;
3161
3162 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3163 if (!attrs)
3164 goto fail;
3165 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3166 goto fail;
3167
Tejun Heo13e2e552013-04-01 11:23:31 -07003168 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003169 return attrs;
3170fail:
3171 free_workqueue_attrs(attrs);
3172 return NULL;
3173}
3174
Tejun Heo29c91e92013-03-12 11:30:03 -07003175static void copy_workqueue_attrs(struct workqueue_attrs *to,
3176 const struct workqueue_attrs *from)
3177{
3178 to->nice = from->nice;
3179 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003180 /*
3181 * Unlike hash and equality test, this function doesn't ignore
3182 * ->no_numa as it is used for both pool and wq attrs. Instead,
3183 * get_unbound_pool() explicitly clears ->no_numa after copying.
3184 */
3185 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003186}
3187
Tejun Heo29c91e92013-03-12 11:30:03 -07003188/* hash value of the content of @attr */
3189static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3190{
3191 u32 hash = 0;
3192
3193 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003194 hash = jhash(cpumask_bits(attrs->cpumask),
3195 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003196 return hash;
3197}
3198
3199/* content equality test */
3200static bool wqattrs_equal(const struct workqueue_attrs *a,
3201 const struct workqueue_attrs *b)
3202{
3203 if (a->nice != b->nice)
3204 return false;
3205 if (!cpumask_equal(a->cpumask, b->cpumask))
3206 return false;
3207 return true;
3208}
3209
Tejun Heo7a4e3442013-03-12 11:30:00 -07003210/**
3211 * init_worker_pool - initialize a newly zalloc'd worker_pool
3212 * @pool: worker_pool to initialize
3213 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303214 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003215 *
3216 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003217 * inside @pool proper are initialized and put_unbound_pool() can be called
3218 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003219 */
3220static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003221{
3222 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003223 pool->id = -1;
3224 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003225 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003226 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003227 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003228 INIT_LIST_HEAD(&pool->worklist);
3229 INIT_LIST_HEAD(&pool->idle_list);
3230 hash_init(pool->busy_hash);
3231
3232 init_timer_deferrable(&pool->idle_timer);
3233 pool->idle_timer.function = idle_worker_timeout;
3234 pool->idle_timer.data = (unsigned long)pool;
3235
3236 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3237 (unsigned long)pool);
3238
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003239 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003240 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003241
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003242 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003243 INIT_HLIST_NODE(&pool->hash_node);
3244 pool->refcnt = 1;
3245
3246 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003247 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3248 if (!pool->attrs)
3249 return -ENOMEM;
3250 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003251}
3252
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003253static void rcu_free_wq(struct rcu_head *rcu)
3254{
3255 struct workqueue_struct *wq =
3256 container_of(rcu, struct workqueue_struct, rcu);
3257
3258 if (!(wq->flags & WQ_UNBOUND))
3259 free_percpu(wq->cpu_pwqs);
3260 else
3261 free_workqueue_attrs(wq->unbound_attrs);
3262
3263 kfree(wq->rescuer);
3264 kfree(wq);
3265}
3266
Tejun Heo29c91e92013-03-12 11:30:03 -07003267static void rcu_free_pool(struct rcu_head *rcu)
3268{
3269 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3270
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003271 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003272 free_workqueue_attrs(pool->attrs);
3273 kfree(pool);
3274}
3275
3276/**
3277 * put_unbound_pool - put a worker_pool
3278 * @pool: worker_pool to put
3279 *
3280 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003281 * safe manner. get_unbound_pool() calls this function on its failure path
3282 * and this function should be able to release pools which went through,
3283 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003284 *
3285 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003286 */
3287static void put_unbound_pool(struct worker_pool *pool)
3288{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003289 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003290 struct worker *worker;
3291
Tejun Heoa892cac2013-04-01 11:23:32 -07003292 lockdep_assert_held(&wq_pool_mutex);
3293
3294 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003295 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003296
3297 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003298 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003299 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003300 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003301
3302 /* release id and unhash */
3303 if (pool->id >= 0)
3304 idr_remove(&worker_pool_idr, pool->id);
3305 hash_del(&pool->hash_node);
3306
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003307 /*
Tejun Heo43a980a2017-10-09 08:04:13 -07003308 * Become the manager and destroy all workers. This prevents
3309 * @pool's workers from blocking on attach_mutex. We're the last
3310 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003311 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003312 spin_lock_irq(&pool->lock);
Tejun Heo43a980a2017-10-09 08:04:13 -07003313 wait_event_lock_irq(wq_manager_wait,
3314 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3315 pool->flags |= POOL_MANAGER_ACTIVE;
3316
Lai Jiangshan1037de32014-05-22 16:44:07 +08003317 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003318 destroy_worker(worker);
3319 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003320 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003321
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003322 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003323 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003324 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003325 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003326
3327 if (pool->detach_completion)
3328 wait_for_completion(pool->detach_completion);
3329
Tejun Heo29c91e92013-03-12 11:30:03 -07003330 /* shut down the timers */
3331 del_timer_sync(&pool->idle_timer);
3332 del_timer_sync(&pool->mayday_timer);
3333
3334 /* sched-RCU protected to allow dereferences from get_work_pool() */
3335 call_rcu_sched(&pool->rcu, rcu_free_pool);
3336}
3337
3338/**
3339 * get_unbound_pool - get a worker_pool with the specified attributes
3340 * @attrs: the attributes of the worker_pool to get
3341 *
3342 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3343 * reference count and return it. If there already is a matching
3344 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003345 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003346 *
3347 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003348 *
3349 * Return: On success, a worker_pool with the same attributes as @attrs.
3350 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003351 */
3352static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3353{
Tejun Heo29c91e92013-03-12 11:30:03 -07003354 u32 hash = wqattrs_hash(attrs);
3355 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003356 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003357 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003358
Tejun Heoa892cac2013-04-01 11:23:32 -07003359 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003360
3361 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003362 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3363 if (wqattrs_equal(pool->attrs, attrs)) {
3364 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003365 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003366 }
3367 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003368
Xunlei Pange2273582015-10-09 11:53:12 +08003369 /* if cpumask is contained inside a NUMA node, we belong to that node */
3370 if (wq_numa_enabled) {
3371 for_each_node(node) {
3372 if (cpumask_subset(attrs->cpumask,
3373 wq_numa_possible_cpumask[node])) {
3374 target_node = node;
3375 break;
3376 }
3377 }
3378 }
3379
Tejun Heo29c91e92013-03-12 11:30:03 -07003380 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003381 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003382 if (!pool || init_worker_pool(pool) < 0)
3383 goto fail;
3384
Tejun Heo8864b4e2013-03-12 11:30:04 -07003385 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003387 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003388
Shaohua Li2865a8f2013-08-01 09:56:36 +08003389 /*
3390 * no_numa isn't a worker_pool attribute, always clear it. See
3391 * 'struct workqueue_attrs' comments for detail.
3392 */
3393 pool->attrs->no_numa = false;
3394
Tejun Heo29c91e92013-03-12 11:30:03 -07003395 if (worker_pool_assign_id(pool) < 0)
3396 goto fail;
3397
3398 /* create and start the initial worker */
Tejun Heo4b5facd2016-09-16 15:49:32 -04003399 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003400 goto fail;
3401
Tejun Heo29c91e92013-03-12 11:30:03 -07003402 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003403 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003404
Tejun Heo29c91e92013-03-12 11:30:03 -07003405 return pool;
3406fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 if (pool)
3408 put_unbound_pool(pool);
3409 return NULL;
3410}
3411
Tejun Heo8864b4e2013-03-12 11:30:04 -07003412static void rcu_free_pwq(struct rcu_head *rcu)
3413{
3414 kmem_cache_free(pwq_cache,
3415 container_of(rcu, struct pool_workqueue, rcu));
3416}
3417
3418/*
3419 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3420 * and needs to be destroyed.
3421 */
3422static void pwq_unbound_release_workfn(struct work_struct *work)
3423{
3424 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3425 unbound_release_work);
3426 struct workqueue_struct *wq = pwq->wq;
3427 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003428 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003429
3430 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3431 return;
3432
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003433 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003434 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003435 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003436 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003437
Tejun Heoa892cac2013-04-01 11:23:32 -07003438 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003439 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003440 mutex_unlock(&wq_pool_mutex);
3441
Tejun Heo8864b4e2013-03-12 11:30:04 -07003442 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3443
3444 /*
3445 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003446 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003447 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003448 if (is_last)
3449 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003450}
3451
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003452/**
Tejun Heo699ce092013-03-13 16:51:35 -07003453 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003454 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003455 *
Tejun Heo699ce092013-03-13 16:51:35 -07003456 * If @pwq isn't freezing, set @pwq->max_active to the associated
3457 * workqueue's saved_max_active and activate delayed work items
3458 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003459 */
Tejun Heo699ce092013-03-13 16:51:35 -07003460static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003461{
Tejun Heo699ce092013-03-13 16:51:35 -07003462 struct workqueue_struct *wq = pwq->wq;
3463 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo4b5facd2016-09-16 15:49:32 -04003464 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003465
Tejun Heo699ce092013-03-13 16:51:35 -07003466 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003467 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003468
3469 /* fast exit for non-freezable wqs */
3470 if (!freezable && pwq->max_active == wq->saved_max_active)
3471 return;
3472
Tejun Heo4b5facd2016-09-16 15:49:32 -04003473 /* this function can be called during early boot w/ irq disabled */
3474 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003475
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003476 /*
3477 * During [un]freezing, the caller is responsible for ensuring that
3478 * this function is called at least once after @workqueue_freezing
3479 * is updated and visible.
3480 */
3481 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003482 pwq->max_active = wq->saved_max_active;
3483
3484 while (!list_empty(&pwq->delayed_works) &&
3485 pwq->nr_active < pwq->max_active)
3486 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003487
3488 /*
3489 * Need to kick a worker after thawed or an unbound wq's
3490 * max_active is bumped. It's a slow path. Do it always.
3491 */
3492 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003493 } else {
3494 pwq->max_active = 0;
3495 }
3496
Tejun Heo4b5facd2016-09-16 15:49:32 -04003497 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003498}
3499
Tejun Heoe50aba92013-04-01 11:23:35 -07003500/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003501static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3502 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003503{
3504 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3505
Tejun Heoe50aba92013-04-01 11:23:35 -07003506 memset(pwq, 0, sizeof(*pwq));
3507
Tejun Heod2c1d402013-03-12 11:30:04 -07003508 pwq->pool = pool;
3509 pwq->wq = wq;
3510 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003511 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003512 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003513 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003514 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003515 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003516}
Tejun Heod2c1d402013-03-12 11:30:04 -07003517
Tejun Heof147f292013-04-01 11:23:35 -07003518/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003519static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003520{
3521 struct workqueue_struct *wq = pwq->wq;
3522
3523 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003524
Tejun Heo1befcf32013-04-01 11:23:35 -07003525 /* may be called multiple times, ignore if already linked */
3526 if (!list_empty(&pwq->pwqs_node))
3527 return;
3528
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003529 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003530 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003531
3532 /* sync max_active to the current setting */
3533 pwq_adjust_max_active(pwq);
3534
3535 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003536 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003537}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003538
Tejun Heof147f292013-04-01 11:23:35 -07003539/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3540static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3541 const struct workqueue_attrs *attrs)
3542{
3543 struct worker_pool *pool;
3544 struct pool_workqueue *pwq;
3545
3546 lockdep_assert_held(&wq_pool_mutex);
3547
3548 pool = get_unbound_pool(attrs);
3549 if (!pool)
3550 return NULL;
3551
Tejun Heoe50aba92013-04-01 11:23:35 -07003552 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003553 if (!pwq) {
3554 put_unbound_pool(pool);
3555 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003556 }
Tejun Heo6029a912013-04-01 11:23:34 -07003557
Tejun Heof147f292013-04-01 11:23:35 -07003558 init_pwq(pwq, wq, pool);
3559 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003560}
3561
Tejun Heo4c16bd32013-04-01 11:23:36 -07003562/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003563 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003564 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003565 * @node: the target NUMA node
3566 * @cpu_going_down: if >= 0, the CPU to consider as offline
3567 * @cpumask: outarg, the resulting cpumask
3568 *
3569 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3570 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003571 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003572 *
3573 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3574 * enabled and @node has online CPUs requested by @attrs, the returned
3575 * cpumask is the intersection of the possible CPUs of @node and
3576 * @attrs->cpumask.
3577 *
3578 * The caller is responsible for ensuring that the cpumask of @node stays
3579 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003580 *
3581 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3582 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003583 */
3584static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3585 int cpu_going_down, cpumask_t *cpumask)
3586{
Tejun Heod55262c2013-04-01 11:23:38 -07003587 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003588 goto use_dfl;
3589
3590 /* does @node have any online CPUs @attrs wants? */
3591 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3592 if (cpu_going_down >= 0)
3593 cpumask_clear_cpu(cpu_going_down, cpumask);
3594
3595 if (cpumask_empty(cpumask))
3596 goto use_dfl;
3597
3598 /* yeap, return possible CPUs in @node that @attrs wants */
3599 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3600 return !cpumask_equal(cpumask, attrs->cpumask);
3601
3602use_dfl:
3603 cpumask_copy(cpumask, attrs->cpumask);
3604 return false;
3605}
3606
Tejun Heo1befcf32013-04-01 11:23:35 -07003607/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3608static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3609 int node,
3610 struct pool_workqueue *pwq)
3611{
3612 struct pool_workqueue *old_pwq;
3613
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003614 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003615 lockdep_assert_held(&wq->mutex);
3616
3617 /* link_pwq() can handle duplicate calls */
3618 link_pwq(pwq);
3619
3620 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3621 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3622 return old_pwq;
3623}
3624
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003625/* context to store the prepared attrs & pwqs before applying */
3626struct apply_wqattrs_ctx {
3627 struct workqueue_struct *wq; /* target workqueue */
3628 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003629 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003630 struct pool_workqueue *dfl_pwq;
3631 struct pool_workqueue *pwq_tbl[];
3632};
3633
3634/* free the resources after success or abort */
3635static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3636{
3637 if (ctx) {
3638 int node;
3639
3640 for_each_node(node)
3641 put_pwq_unlocked(ctx->pwq_tbl[node]);
3642 put_pwq_unlocked(ctx->dfl_pwq);
3643
3644 free_workqueue_attrs(ctx->attrs);
3645
3646 kfree(ctx);
3647 }
3648}
3649
3650/* allocate the attrs and pwqs for later installation */
3651static struct apply_wqattrs_ctx *
3652apply_wqattrs_prepare(struct workqueue_struct *wq,
3653 const struct workqueue_attrs *attrs)
3654{
3655 struct apply_wqattrs_ctx *ctx;
3656 struct workqueue_attrs *new_attrs, *tmp_attrs;
3657 int node;
3658
3659 lockdep_assert_held(&wq_pool_mutex);
3660
3661 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3662 GFP_KERNEL);
3663
3664 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3665 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3666 if (!ctx || !new_attrs || !tmp_attrs)
3667 goto out_free;
3668
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003669 /*
3670 * Calculate the attrs of the default pwq.
3671 * If the user configured cpumask doesn't overlap with the
3672 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3673 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003674 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003675 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003676 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3677 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003678
3679 /*
3680 * We may create multiple pwqs with differing cpumasks. Make a
3681 * copy of @new_attrs which will be modified and used to obtain
3682 * pools.
3683 */
3684 copy_workqueue_attrs(tmp_attrs, new_attrs);
3685
3686 /*
3687 * If something goes wrong during CPU up/down, we'll fall back to
3688 * the default pwq covering whole @attrs->cpumask. Always create
3689 * it even if we don't use it immediately.
3690 */
3691 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3692 if (!ctx->dfl_pwq)
3693 goto out_free;
3694
3695 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003696 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003697 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3698 if (!ctx->pwq_tbl[node])
3699 goto out_free;
3700 } else {
3701 ctx->dfl_pwq->refcnt++;
3702 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3703 }
3704 }
3705
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003706 /* save the user configured attrs and sanitize it. */
3707 copy_workqueue_attrs(new_attrs, attrs);
3708 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003709 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003710
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003711 ctx->wq = wq;
3712 free_workqueue_attrs(tmp_attrs);
3713 return ctx;
3714
3715out_free:
3716 free_workqueue_attrs(tmp_attrs);
3717 free_workqueue_attrs(new_attrs);
3718 apply_wqattrs_cleanup(ctx);
3719 return NULL;
3720}
3721
3722/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3723static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3724{
3725 int node;
3726
3727 /* all pwqs have been created successfully, let's install'em */
3728 mutex_lock(&ctx->wq->mutex);
3729
3730 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3731
3732 /* save the previous pwq and install the new one */
3733 for_each_node(node)
3734 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3735 ctx->pwq_tbl[node]);
3736
3737 /* @dfl_pwq might not have been used, ensure it's linked */
3738 link_pwq(ctx->dfl_pwq);
3739 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3740
3741 mutex_unlock(&ctx->wq->mutex);
3742}
3743
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003744static void apply_wqattrs_lock(void)
3745{
3746 /* CPUs should stay stable across pwq creations and installations */
3747 get_online_cpus();
3748 mutex_lock(&wq_pool_mutex);
3749}
3750
3751static void apply_wqattrs_unlock(void)
3752{
3753 mutex_unlock(&wq_pool_mutex);
3754 put_online_cpus();
3755}
3756
3757static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3758 const struct workqueue_attrs *attrs)
3759{
3760 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003761
3762 /* only unbound workqueues can change attributes */
3763 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3764 return -EINVAL;
3765
3766 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heof9636c92017-07-23 08:36:15 -04003767 if (!list_empty(&wq->pwqs)) {
3768 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3769 return -EINVAL;
3770
3771 wq->flags &= ~__WQ_ORDERED;
3772 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003773
3774 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003775 if (!ctx)
3776 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003777
3778 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003779 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003780 apply_wqattrs_cleanup(ctx);
3781
wanghaibin62011712016-01-07 20:38:59 +08003782 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003783}
3784
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003785/**
3786 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3787 * @wq: the target workqueue
3788 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3789 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003790 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3791 * machines, this function maps a separate pwq to each NUMA node with
3792 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3793 * NUMA node it was issued on. Older pwqs are released as in-flight work
3794 * items finish. Note that a work item which repeatedly requeues itself
3795 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003796 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003797 * Performs GFP_KERNEL allocations.
3798 *
3799 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003800 */
3801int apply_workqueue_attrs(struct workqueue_struct *wq,
3802 const struct workqueue_attrs *attrs)
3803{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003804 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003805
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003806 apply_wqattrs_lock();
3807 ret = apply_workqueue_attrs_locked(wq, attrs);
3808 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003809
Tejun Heo48621252013-04-01 11:23:31 -07003810 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003811}
3812
Tejun Heo4c16bd32013-04-01 11:23:36 -07003813/**
3814 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3815 * @wq: the target workqueue
3816 * @cpu: the CPU coming up or going down
3817 * @online: whether @cpu is coming up or going down
3818 *
3819 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3820 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3821 * @wq accordingly.
3822 *
3823 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3824 * falls back to @wq->dfl_pwq which may not be optimal but is always
3825 * correct.
3826 *
3827 * Note that when the last allowed CPU of a NUMA node goes offline for a
3828 * workqueue with a cpumask spanning multiple nodes, the workers which were
3829 * already executing the work items for the workqueue will lose their CPU
3830 * affinity and may execute on any CPU. This is similar to how per-cpu
3831 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3832 * affinity, it's the user's responsibility to flush the work item from
3833 * CPU_DOWN_PREPARE.
3834 */
3835static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3836 bool online)
3837{
3838 int node = cpu_to_node(cpu);
3839 int cpu_off = online ? -1 : cpu;
3840 struct pool_workqueue *old_pwq = NULL, *pwq;
3841 struct workqueue_attrs *target_attrs;
3842 cpumask_t *cpumask;
3843
3844 lockdep_assert_held(&wq_pool_mutex);
3845
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003846 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3847 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003848 return;
3849
3850 /*
3851 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3852 * Let's use a preallocated one. The following buf is protected by
3853 * CPU hotplug exclusion.
3854 */
3855 target_attrs = wq_update_unbound_numa_attrs_buf;
3856 cpumask = target_attrs->cpumask;
3857
Tejun Heo4c16bd32013-04-01 11:23:36 -07003858 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3859 pwq = unbound_pwq_by_node(wq, node);
3860
3861 /*
3862 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003863 * different from the default pwq's, we need to compare it to @pwq's
3864 * and create a new one if they don't match. If the target cpumask
3865 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003866 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003867 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003868 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003869 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003870 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003871 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003872 }
3873
Tejun Heo4c16bd32013-04-01 11:23:36 -07003874 /* create a new pwq */
3875 pwq = alloc_unbound_pwq(wq, target_attrs);
3876 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003877 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3878 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003879 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003880 }
3881
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003882 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003883 mutex_lock(&wq->mutex);
3884 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3885 goto out_unlock;
3886
3887use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003888 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003889 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3890 get_pwq(wq->dfl_pwq);
3891 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3892 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3893out_unlock:
3894 mutex_unlock(&wq->mutex);
3895 put_pwq_unlocked(old_pwq);
3896}
3897
Tejun Heo30cdf242013-03-12 11:29:57 -07003898static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003899{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003900 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003901 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003902
Tejun Heo30cdf242013-03-12 11:29:57 -07003903 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003904 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3905 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003906 return -ENOMEM;
3907
3908 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003909 struct pool_workqueue *pwq =
3910 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003911 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003912 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003913
Tejun Heof147f292013-04-01 11:23:35 -07003914 init_pwq(pwq, wq, &cpu_pools[highpri]);
3915
3916 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003917 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003918 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003919 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003920 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003921 } else if (wq->flags & __WQ_ORDERED) {
3922 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3923 /* there should only be single pwq for ordering guarantee */
3924 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3925 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3926 "ordering guarantee broken for workqueue %s\n", wq->name);
3927 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003928 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003929 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003930 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003931}
3932
Tejun Heof3421792010-07-02 10:03:51 +02003933static int wq_clamp_max_active(int max_active, unsigned int flags,
3934 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003935{
Tejun Heof3421792010-07-02 10:03:51 +02003936 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3937
3938 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003939 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3940 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003941
Tejun Heof3421792010-07-02 10:03:51 +02003942 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003943}
3944
Tejun Heob196be82012-01-10 15:11:35 -08003945struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003946 unsigned int flags,
3947 int max_active,
3948 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003949 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003950{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003951 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003952 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003953 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003954 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003955
Tejun Heo61a0adb2017-07-18 18:41:52 -04003956 /*
3957 * Unbound && max_active == 1 used to imply ordered, which is no
3958 * longer the case on NUMA machines due to per-node pools. While
3959 * alloc_ordered_workqueue() is the right way to create an ordered
3960 * workqueue, keep the previous behavior to avoid subtle breakages
3961 * on NUMA.
3962 */
3963 if ((flags & WQ_UNBOUND) && max_active == 1)
3964 flags |= __WQ_ORDERED;
3965
Viresh Kumarcee22a12013-04-08 16:45:40 +05303966 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3967 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3968 flags |= WQ_UNBOUND;
3969
Tejun Heoecf68812013-04-01 11:23:34 -07003970 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003971 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003972 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003973
3974 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003975 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003976 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003977
Tejun Heo6029a912013-04-01 11:23:34 -07003978 if (flags & WQ_UNBOUND) {
3979 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3980 if (!wq->unbound_attrs)
3981 goto err_free_wq;
3982 }
3983
Tejun Heoecf68812013-04-01 11:23:34 -07003984 va_start(args, lock_name);
3985 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003986 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003987
Tejun Heod320c032010-06-29 10:07:14 +02003988 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003989 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003990
Tejun Heob196be82012-01-10 15:11:35 -08003991 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003992 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003993 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003994 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003995 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003996 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003997 INIT_LIST_HEAD(&wq->flusher_queue);
3998 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003999 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004000
Johannes Bergeb13ba82008-01-16 09:51:58 +01004001 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004002 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004003
Tejun Heo30cdf242013-03-12 11:29:57 -07004004 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004005 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004006
Tejun Heo493008a2013-03-12 11:30:03 -07004007 /*
4008 * Workqueues which may be used during memory reclaim should
4009 * have a rescuer to guarantee forward progress.
4010 */
4011 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004012 struct worker *rescuer;
4013
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004014 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004015 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004016 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004017
Tejun Heo111c2252013-01-17 17:16:24 -08004018 rescuer->rescue_wq = wq;
4019 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004020 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004021 if (IS_ERR(rescuer->task)) {
4022 kfree(rescuer);
4023 goto err_destroy;
4024 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004025
Tejun Heod2c1d402013-03-12 11:30:04 -07004026 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004027 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004028 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004029 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004030
Tejun Heo226223a2013-03-12 11:30:05 -07004031 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4032 goto err_destroy;
4033
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004034 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004035 * wq_pool_mutex protects global freeze state and workqueues list.
4036 * Grab it, adjust max_active and add the new @wq to workqueues
4037 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004038 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004039 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004040
Lai Jiangshana357fc02013-03-25 16:57:19 -07004041 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004042 for_each_pwq(pwq, wq)
4043 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004044 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004045
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004046 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004047
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004048 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004049
Oleg Nesterov3af244332007-05-09 02:34:09 -07004050 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004051
4052err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004053 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004054 kfree(wq);
4055 return NULL;
4056err_destroy:
4057 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004058 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004059}
Tejun Heod320c032010-06-29 10:07:14 +02004060EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004061
4062/**
4063 * destroy_workqueue - safely terminate a workqueue
4064 * @wq: target workqueue
4065 *
4066 * Safely destroy a workqueue. All work currently pending will be done first.
4067 */
4068void destroy_workqueue(struct workqueue_struct *wq)
4069{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004070 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004071 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004072
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004073 /* drain it before proceeding with destruction */
4074 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004075
Tejun Heo6183c002013-03-12 11:29:57 -07004076 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004077 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004078 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004079 int i;
4080
Tejun Heo76af4d92013-03-12 11:30:00 -07004081 for (i = 0; i < WORK_NR_COLORS; i++) {
4082 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004083 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004084 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004085 }
4086 }
4087
Lai Jiangshan5c529592013-04-04 10:05:38 +08004088 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004089 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004090 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004091 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004092 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004093 }
Tejun Heo6183c002013-03-12 11:29:57 -07004094 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004095 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004096
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004097 /*
4098 * wq list is used to freeze wq, remove from list after
4099 * flushing is complete in case freeze races us.
4100 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004101 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004102 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004103 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004104
Tejun Heo226223a2013-03-12 11:30:05 -07004105 workqueue_sysfs_unregister(wq);
4106
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004107 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004108 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004109
Tejun Heo8864b4e2013-03-12 11:30:04 -07004110 if (!(wq->flags & WQ_UNBOUND)) {
4111 /*
4112 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004113 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004114 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004115 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004116 } else {
4117 /*
4118 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004119 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4120 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004121 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004122 for_each_node(node) {
4123 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4124 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4125 put_pwq_unlocked(pwq);
4126 }
4127
4128 /*
4129 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4130 * put. Don't access it afterwards.
4131 */
4132 pwq = wq->dfl_pwq;
4133 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004134 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004135 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004136}
4137EXPORT_SYMBOL_GPL(destroy_workqueue);
4138
Tejun Heodcd989c2010-06-29 10:07:14 +02004139/**
4140 * workqueue_set_max_active - adjust max_active of a workqueue
4141 * @wq: target workqueue
4142 * @max_active: new max_active value.
4143 *
4144 * Set max_active of @wq to @max_active.
4145 *
4146 * CONTEXT:
4147 * Don't call from IRQ context.
4148 */
4149void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4150{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004151 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004152
Tejun Heo8719dce2013-03-12 11:30:04 -07004153 /* disallow meddling with max_active for ordered workqueues */
Tejun Heof9636c92017-07-23 08:36:15 -04004154 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004155 return;
4156
Tejun Heof3421792010-07-02 10:03:51 +02004157 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004158
Lai Jiangshana357fc02013-03-25 16:57:19 -07004159 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004160
Tejun Heof9636c92017-07-23 08:36:15 -04004161 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004162 wq->saved_max_active = max_active;
4163
Tejun Heo699ce092013-03-13 16:51:35 -07004164 for_each_pwq(pwq, wq)
4165 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004166
Lai Jiangshana357fc02013-03-25 16:57:19 -07004167 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004168}
4169EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4170
4171/**
Lukas Wunner225ce6d2018-02-11 10:38:28 +01004172 * current_work - retrieve %current task's work struct
4173 *
4174 * Determine if %current task is a workqueue worker and what it's working on.
4175 * Useful to find out the context that the %current task is running in.
4176 *
4177 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4178 */
4179struct work_struct *current_work(void)
4180{
4181 struct worker *worker = current_wq_worker();
4182
4183 return worker ? worker->current_work : NULL;
4184}
4185EXPORT_SYMBOL(current_work);
4186
4187/**
Tejun Heoe62676162013-03-12 17:41:37 -07004188 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4189 *
4190 * Determine whether %current is a workqueue rescuer. Can be used from
4191 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004192 *
4193 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004194 */
4195bool current_is_workqueue_rescuer(void)
4196{
4197 struct worker *worker = current_wq_worker();
4198
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004199 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004200}
4201
4202/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004203 * workqueue_congested - test whether a workqueue is congested
4204 * @cpu: CPU in question
4205 * @wq: target workqueue
4206 *
4207 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4208 * no synchronization around this function and the test result is
4209 * unreliable and only useful as advisory hints or for debugging.
4210 *
Tejun Heod3251852013-05-10 11:10:17 -07004211 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4212 * Note that both per-cpu and unbound workqueues may be associated with
4213 * multiple pool_workqueues which have separate congested states. A
4214 * workqueue being congested on one CPU doesn't mean the workqueue is also
4215 * contested on other CPUs / NUMA nodes.
4216 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004217 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004218 * %true if congested, %false otherwise.
4219 */
Tejun Heod84ff052013-03-12 11:29:59 -07004220bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004221{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004222 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004223 bool ret;
4224
Lai Jiangshan88109452013-03-20 03:28:10 +08004225 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004226
Tejun Heod3251852013-05-10 11:10:17 -07004227 if (cpu == WORK_CPU_UNBOUND)
4228 cpu = smp_processor_id();
4229
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004230 if (!(wq->flags & WQ_UNBOUND))
4231 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4232 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004233 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004234
Tejun Heo76af4d92013-03-12 11:30:00 -07004235 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004236 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004237
4238 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004239}
4240EXPORT_SYMBOL_GPL(workqueue_congested);
4241
4242/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004243 * work_busy - test whether a work is currently pending or running
4244 * @work: the work to be tested
4245 *
4246 * Test whether @work is currently pending or running. There is no
4247 * synchronization around this function and the test result is
4248 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004249 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004250 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004251 * OR'd bitmask of WORK_BUSY_* bits.
4252 */
4253unsigned int work_busy(struct work_struct *work)
4254{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004255 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004256 unsigned long flags;
4257 unsigned int ret = 0;
4258
Tejun Heodcd989c2010-06-29 10:07:14 +02004259 if (work_pending(work))
4260 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004261
Tejun Heofa1b54e2013-03-12 11:30:00 -07004262 local_irq_save(flags);
4263 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004264 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004265 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004266 if (find_worker_executing_work(pool, work))
4267 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004268 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004269 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004270 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004271
4272 return ret;
4273}
4274EXPORT_SYMBOL_GPL(work_busy);
4275
Tejun Heo3d1cb202013-04-30 15:27:22 -07004276/**
4277 * set_worker_desc - set description for the current work item
4278 * @fmt: printf-style format string
4279 * @...: arguments for the format string
4280 *
4281 * This function can be called by a running work function to describe what
4282 * the work item is about. If the worker task gets dumped, this
4283 * information will be printed out together to help debugging. The
4284 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4285 */
4286void set_worker_desc(const char *fmt, ...)
4287{
4288 struct worker *worker = current_wq_worker();
4289 va_list args;
4290
4291 if (worker) {
4292 va_start(args, fmt);
4293 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4294 va_end(args);
4295 worker->desc_valid = true;
4296 }
4297}
4298
4299/**
4300 * print_worker_info - print out worker information and description
4301 * @log_lvl: the log level to use when printing
4302 * @task: target task
4303 *
4304 * If @task is a worker and currently executing a work item, print out the
4305 * name of the workqueue being serviced and worker description set with
4306 * set_worker_desc() by the currently executing work item.
4307 *
4308 * This function can be safely called on any task as long as the
4309 * task_struct itself is accessible. While safe, this function isn't
4310 * synchronized and may print out mixups or garbages of limited length.
4311 */
4312void print_worker_info(const char *log_lvl, struct task_struct *task)
4313{
4314 work_func_t *fn = NULL;
4315 char name[WQ_NAME_LEN] = { };
4316 char desc[WORKER_DESC_LEN] = { };
4317 struct pool_workqueue *pwq = NULL;
4318 struct workqueue_struct *wq = NULL;
4319 bool desc_valid = false;
4320 struct worker *worker;
4321
4322 if (!(task->flags & PF_WQ_WORKER))
4323 return;
4324
4325 /*
4326 * This function is called without any synchronization and @task
4327 * could be in any state. Be careful with dereferences.
4328 */
Petr Mladeke7005912016-10-11 13:55:17 -07004329 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004330
4331 /*
4332 * Carefully copy the associated workqueue's workfn and name. Keep
4333 * the original last '\0' in case the original contains garbage.
4334 */
4335 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4336 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4337 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4338 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4339
4340 /* copy worker description */
4341 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4342 if (desc_valid)
4343 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4344
4345 if (fn || name[0] || desc[0]) {
4346 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4347 if (desc[0])
4348 pr_cont(" (%s)", desc);
4349 pr_cont("\n");
4350 }
4351}
4352
Tejun Heo3494fc32015-03-09 09:22:28 -04004353static void pr_cont_pool_info(struct worker_pool *pool)
4354{
4355 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4356 if (pool->node != NUMA_NO_NODE)
4357 pr_cont(" node=%d", pool->node);
4358 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4359}
4360
4361static void pr_cont_work(bool comma, struct work_struct *work)
4362{
4363 if (work->func == wq_barrier_func) {
4364 struct wq_barrier *barr;
4365
4366 barr = container_of(work, struct wq_barrier, work);
4367
4368 pr_cont("%s BAR(%d)", comma ? "," : "",
4369 task_pid_nr(barr->task));
4370 } else {
4371 pr_cont("%s %pf", comma ? "," : "", work->func);
4372 }
4373}
4374
4375static void show_pwq(struct pool_workqueue *pwq)
4376{
4377 struct worker_pool *pool = pwq->pool;
4378 struct work_struct *work;
4379 struct worker *worker;
4380 bool has_in_flight = false, has_pending = false;
4381 int bkt;
4382
4383 pr_info(" pwq %d:", pool->id);
4384 pr_cont_pool_info(pool);
4385
4386 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4387 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4388
4389 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4390 if (worker->current_pwq == pwq) {
4391 has_in_flight = true;
4392 break;
4393 }
4394 }
4395 if (has_in_flight) {
4396 bool comma = false;
4397
4398 pr_info(" in-flight:");
4399 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4400 if (worker->current_pwq != pwq)
4401 continue;
4402
4403 pr_cont("%s %d%s:%pf", comma ? "," : "",
4404 task_pid_nr(worker->task),
4405 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4406 worker->current_func);
4407 list_for_each_entry(work, &worker->scheduled, entry)
4408 pr_cont_work(false, work);
4409 comma = true;
4410 }
4411 pr_cont("\n");
4412 }
4413
4414 list_for_each_entry(work, &pool->worklist, entry) {
4415 if (get_work_pwq(work) == pwq) {
4416 has_pending = true;
4417 break;
4418 }
4419 }
4420 if (has_pending) {
4421 bool comma = false;
4422
4423 pr_info(" pending:");
4424 list_for_each_entry(work, &pool->worklist, entry) {
4425 if (get_work_pwq(work) != pwq)
4426 continue;
4427
4428 pr_cont_work(comma, work);
4429 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4430 }
4431 pr_cont("\n");
4432 }
4433
4434 if (!list_empty(&pwq->delayed_works)) {
4435 bool comma = false;
4436
4437 pr_info(" delayed:");
4438 list_for_each_entry(work, &pwq->delayed_works, entry) {
4439 pr_cont_work(comma, work);
4440 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4441 }
4442 pr_cont("\n");
4443 }
4444}
4445
4446/**
4447 * show_workqueue_state - dump workqueue state
4448 *
Roger Lu7b776af2016-07-01 11:05:02 +08004449 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4450 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004451 */
4452void show_workqueue_state(void)
4453{
4454 struct workqueue_struct *wq;
4455 struct worker_pool *pool;
4456 unsigned long flags;
4457 int pi;
4458
4459 rcu_read_lock_sched();
4460
4461 pr_info("Showing busy workqueues and worker pools:\n");
4462
4463 list_for_each_entry_rcu(wq, &workqueues, list) {
4464 struct pool_workqueue *pwq;
4465 bool idle = true;
4466
4467 for_each_pwq(pwq, wq) {
4468 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4469 idle = false;
4470 break;
4471 }
4472 }
4473 if (idle)
4474 continue;
4475
4476 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4477
4478 for_each_pwq(pwq, wq) {
4479 spin_lock_irqsave(&pwq->pool->lock, flags);
4480 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4481 show_pwq(pwq);
4482 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004483 /*
4484 * We could be printing a lot from atomic context, e.g.
4485 * sysrq-t -> show_workqueue_state(). Avoid triggering
4486 * hard lockup.
4487 */
4488 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004489 }
4490 }
4491
4492 for_each_pool(pool, pi) {
4493 struct worker *worker;
4494 bool first = true;
4495
4496 spin_lock_irqsave(&pool->lock, flags);
4497 if (pool->nr_workers == pool->nr_idle)
4498 goto next_pool;
4499
4500 pr_info("pool %d:", pool->id);
4501 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004502 pr_cont(" hung=%us workers=%d",
4503 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4504 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004505 if (pool->manager)
4506 pr_cont(" manager: %d",
4507 task_pid_nr(pool->manager->task));
4508 list_for_each_entry(worker, &pool->idle_list, entry) {
4509 pr_cont(" %s%d", first ? "idle: " : "",
4510 task_pid_nr(worker->task));
4511 first = false;
4512 }
4513 pr_cont("\n");
4514 next_pool:
4515 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004516 /*
4517 * We could be printing a lot from atomic context, e.g.
4518 * sysrq-t -> show_workqueue_state(). Avoid triggering
4519 * hard lockup.
4520 */
4521 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004522 }
4523
4524 rcu_read_unlock_sched();
4525}
4526
Tejun Heodb7bccf2010-06-29 10:07:12 +02004527/*
4528 * CPU hotplug.
4529 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004530 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004531 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004532 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004533 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004534 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004535 * blocked draining impractical.
4536 *
Tejun Heo24647572013-01-24 11:01:33 -08004537 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004538 * running as an unbound one and allowing it to be reattached later if the
4539 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004540 */
4541
Tejun Heo706026c2013-01-24 11:01:34 -08004542static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004543{
Tejun Heo38db41d2013-01-24 11:01:34 -08004544 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004545 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004546 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004547
Tejun Heof02ae732013-03-12 11:30:03 -07004548 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004549 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004550 spin_lock_irq(&pool->lock);
4551
4552 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004553 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004554 * unbound and set DISASSOCIATED. Before this, all workers
4555 * except for the ones which are still executing works from
4556 * before the last CPU down must be on the cpu. After
4557 * this, they may become diasporas.
4558 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004559 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004560 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004561
Tejun Heo24647572013-01-24 11:01:33 -08004562 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004563
Tejun Heo94cf58b2013-01-24 11:01:33 -08004564 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004565 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004566
Lai Jiangshaneb283422013-03-08 15:18:28 -08004567 /*
4568 * Call schedule() so that we cross rq->lock and thus can
4569 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4570 * This is necessary as scheduler callbacks may be invoked
4571 * from other cpus.
4572 */
4573 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004574
Lai Jiangshaneb283422013-03-08 15:18:28 -08004575 /*
4576 * Sched callbacks are disabled now. Zap nr_running.
4577 * After this, nr_running stays zero and need_more_worker()
4578 * and keep_working() are always true as long as the
4579 * worklist is not empty. This pool now behaves as an
4580 * unbound (in terms of concurrency management) pool which
4581 * are served by workers tied to the pool.
4582 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004583 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004584
4585 /*
4586 * With concurrency management just turned off, a busy
4587 * worker blocking could lead to lengthy stalls. Kick off
4588 * unbound chain execution of currently pending work items.
4589 */
4590 spin_lock_irq(&pool->lock);
4591 wake_up_worker(pool);
4592 spin_unlock_irq(&pool->lock);
4593 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004594}
4595
Tejun Heobd7c0892013-03-19 13:45:21 -07004596/**
4597 * rebind_workers - rebind all workers of a pool to the associated CPU
4598 * @pool: pool of interest
4599 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004600 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004601 */
4602static void rebind_workers(struct worker_pool *pool)
4603{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004604 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004605
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004606 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004607
Tejun Heoa9ab7752013-03-19 13:45:21 -07004608 /*
4609 * Restore CPU affinity of all workers. As all idle workers should
4610 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304611 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004612 * of all workers first and then clear UNBOUND. As we're called
4613 * from CPU_ONLINE, the following shouldn't fail.
4614 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004615 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004616 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4617 pool->attrs->cpumask) < 0);
4618
4619 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004620
4621 /*
4622 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4623 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4624 * being reworked and this can go away in time.
4625 */
4626 if (!(pool->flags & POOL_DISASSOCIATED)) {
4627 spin_unlock_irq(&pool->lock);
4628 return;
4629 }
4630
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004631 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004632
Lai Jiangshanda028462014-05-20 17:46:31 +08004633 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004634 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004635
4636 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004637 * A bound idle worker should actually be on the runqueue
4638 * of the associated CPU for local wake-ups targeting it to
4639 * work. Kick all idle workers so that they migrate to the
4640 * associated CPU. Doing this in the same loop as
4641 * replacing UNBOUND with REBOUND is safe as no worker will
4642 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004643 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004644 if (worker_flags & WORKER_IDLE)
4645 wake_up_process(worker->task);
4646
4647 /*
4648 * We want to clear UNBOUND but can't directly call
4649 * worker_clr_flags() or adjust nr_running. Atomically
4650 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4651 * @worker will clear REBOUND using worker_clr_flags() when
4652 * it initiates the next execution cycle thus restoring
4653 * concurrency management. Note that when or whether
4654 * @worker clears REBOUND doesn't affect correctness.
4655 *
4656 * ACCESS_ONCE() is necessary because @worker->flags may be
4657 * tested without holding any lock in
4658 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4659 * fail incorrectly leading to premature concurrency
4660 * management operations.
4661 */
4662 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4663 worker_flags |= WORKER_REBOUND;
4664 worker_flags &= ~WORKER_UNBOUND;
4665 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004666 }
4667
Tejun Heoa9ab7752013-03-19 13:45:21 -07004668 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004669}
4670
Tejun Heo7dbc7252013-03-19 13:45:21 -07004671/**
4672 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4673 * @pool: unbound pool of interest
4674 * @cpu: the CPU which is coming up
4675 *
4676 * An unbound pool may end up with a cpumask which doesn't have any online
4677 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4678 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4679 * online CPU before, cpus_allowed of all its workers should be restored.
4680 */
4681static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4682{
4683 static cpumask_t cpumask;
4684 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004685
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004686 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004687
4688 /* is @cpu allowed for @pool? */
4689 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4690 return;
4691
Tejun Heo7dbc7252013-03-19 13:45:21 -07004692 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004693
4694 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004695 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004696 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004697}
4698
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004699int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004700{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004701 struct worker_pool *pool;
4702
4703 for_each_cpu_worker_pool(pool, cpu) {
4704 if (pool->nr_workers)
4705 continue;
4706 if (!create_worker(pool))
4707 return -ENOMEM;
4708 }
4709 return 0;
4710}
4711
4712int workqueue_online_cpu(unsigned int cpu)
4713{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004714 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004715 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004716 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004717
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004718 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004719
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004720 for_each_pool(pool, pi) {
4721 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004722
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004723 if (pool->cpu == cpu)
4724 rebind_workers(pool);
4725 else if (pool->cpu < 0)
4726 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004727
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004728 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004729 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004730
4731 /* update NUMA affinity of unbound workqueues */
4732 list_for_each_entry(wq, &workqueues, list)
4733 wq_update_unbound_numa(wq, cpu, true);
4734
4735 mutex_unlock(&wq_pool_mutex);
4736 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004737}
4738
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004739int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004740{
Tejun Heo8db25e72012-07-17 12:39:28 -07004741 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004742 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004743
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004744 /* unbinding per-cpu workers should happen on the local CPU */
4745 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4746 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004747
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004748 /* update NUMA affinity of unbound workqueues */
4749 mutex_lock(&wq_pool_mutex);
4750 list_for_each_entry(wq, &workqueues, list)
4751 wq_update_unbound_numa(wq, cpu, false);
4752 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004753
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004754 /* wait for per-cpu unbinding to finish */
4755 flush_work(&unbind_work);
4756 destroy_work_on_stack(&unbind_work);
4757 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004758}
4759
Rusty Russell2d3854a2008-11-05 13:39:10 +11004760#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004761
Rusty Russell2d3854a2008-11-05 13:39:10 +11004762struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004763 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004764 long (*fn)(void *);
4765 void *arg;
4766 long ret;
4767};
4768
Tejun Heoed48ece2012-09-18 12:48:43 -07004769static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004770{
Tejun Heoed48ece2012-09-18 12:48:43 -07004771 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4772
Rusty Russell2d3854a2008-11-05 13:39:10 +11004773 wfc->ret = wfc->fn(wfc->arg);
4774}
4775
4776/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004777 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004778 * @cpu: the cpu to run on
4779 * @fn: the function to run
4780 * @arg: the function arg
4781 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004782 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004783 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004784 *
4785 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004786 */
Tejun Heod84ff052013-03-12 11:29:59 -07004787long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004788{
Tejun Heoed48ece2012-09-18 12:48:43 -07004789 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004790
Tejun Heoed48ece2012-09-18 12:48:43 -07004791 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4792 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004793 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004794 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004795 return wfc.ret;
4796}
4797EXPORT_SYMBOL_GPL(work_on_cpu);
4798#endif /* CONFIG_SMP */
4799
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004800#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304801
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004802/**
4803 * freeze_workqueues_begin - begin freezing workqueues
4804 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004805 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004806 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004807 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004808 *
4809 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004810 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004811 */
4812void freeze_workqueues_begin(void)
4813{
Tejun Heo24b8a842013-03-12 11:29:58 -07004814 struct workqueue_struct *wq;
4815 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004816
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004817 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004818
Tejun Heo6183c002013-03-12 11:29:57 -07004819 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004820 workqueue_freezing = true;
4821
Tejun Heo24b8a842013-03-12 11:29:58 -07004822 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004823 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004824 for_each_pwq(pwq, wq)
4825 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004826 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004827 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004828
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004829 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004830}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004831
4832/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004833 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004834 *
4835 * Check whether freezing is complete. This function must be called
4836 * between freeze_workqueues_begin() and thaw_workqueues().
4837 *
4838 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004839 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004840 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004841 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004842 * %true if some freezable workqueues are still busy. %false if freezing
4843 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004844 */
4845bool freeze_workqueues_busy(void)
4846{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004847 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004848 struct workqueue_struct *wq;
4849 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004850
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004851 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004852
Tejun Heo6183c002013-03-12 11:29:57 -07004853 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004854
Tejun Heo24b8a842013-03-12 11:29:58 -07004855 list_for_each_entry(wq, &workqueues, list) {
4856 if (!(wq->flags & WQ_FREEZABLE))
4857 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004858 /*
4859 * nr_active is monotonically decreasing. It's safe
4860 * to peek without lock.
4861 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004862 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004863 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004864 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004865 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004866 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004867 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868 goto out_unlock;
4869 }
4870 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004871 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004872 }
4873out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004874 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004875 return busy;
4876}
4877
4878/**
4879 * thaw_workqueues - thaw workqueues
4880 *
4881 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004882 * frozen works are transferred to their respective pool worklists.
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 thaw_workqueues(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
4894 if (!workqueue_freezing)
4895 goto out_unlock;
4896
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004897 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004898
Tejun Heo24b8a842013-03-12 11:29:58 -07004899 /* restore max_active and repopulate worklist */
4900 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004901 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004902 for_each_pwq(pwq, wq)
4903 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004904 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004905 }
4906
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004907out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004908 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004909}
4910#endif /* CONFIG_FREEZER */
4911
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004912static int workqueue_apply_unbound_cpumask(void)
4913{
4914 LIST_HEAD(ctxs);
4915 int ret = 0;
4916 struct workqueue_struct *wq;
4917 struct apply_wqattrs_ctx *ctx, *n;
4918
4919 lockdep_assert_held(&wq_pool_mutex);
4920
4921 list_for_each_entry(wq, &workqueues, list) {
4922 if (!(wq->flags & WQ_UNBOUND))
4923 continue;
4924 /* creating multiple pwqs breaks ordering guarantee */
4925 if (wq->flags & __WQ_ORDERED)
4926 continue;
4927
4928 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4929 if (!ctx) {
4930 ret = -ENOMEM;
4931 break;
4932 }
4933
4934 list_add_tail(&ctx->list, &ctxs);
4935 }
4936
4937 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4938 if (!ret)
4939 apply_wqattrs_commit(ctx);
4940 apply_wqattrs_cleanup(ctx);
4941 }
4942
4943 return ret;
4944}
4945
4946/**
4947 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4948 * @cpumask: the cpumask to set
4949 *
4950 * The low-level workqueues cpumask is a global cpumask that limits
4951 * the affinity of all unbound workqueues. This function check the @cpumask
4952 * and apply it to all unbound workqueues and updates all pwqs of them.
4953 *
4954 * Retun: 0 - Success
4955 * -EINVAL - Invalid @cpumask
4956 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4957 */
4958int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4959{
4960 int ret = -EINVAL;
4961 cpumask_var_t saved_cpumask;
4962
4963 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4964 return -ENOMEM;
4965
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004966 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4967 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004968 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004969
4970 /* save the old wq_unbound_cpumask. */
4971 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4972
4973 /* update wq_unbound_cpumask at first and apply it to wqs. */
4974 cpumask_copy(wq_unbound_cpumask, cpumask);
4975 ret = workqueue_apply_unbound_cpumask();
4976
4977 /* restore the wq_unbound_cpumask when failed. */
4978 if (ret < 0)
4979 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4980
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004981 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004982 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004983
4984 free_cpumask_var(saved_cpumask);
4985 return ret;
4986}
4987
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004988#ifdef CONFIG_SYSFS
4989/*
4990 * Workqueues with WQ_SYSFS flag set is visible to userland via
4991 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4992 * following attributes.
4993 *
4994 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4995 * max_active RW int : maximum number of in-flight work items
4996 *
4997 * Unbound workqueues have the following extra attributes.
4998 *
4999 * id RO int : the associated pool ID
5000 * nice RW int : nice value of the workers
5001 * cpumask RW mask : bitmask of allowed CPUs for the workers
5002 */
5003struct wq_device {
5004 struct workqueue_struct *wq;
5005 struct device dev;
5006};
5007
5008static struct workqueue_struct *dev_to_wq(struct device *dev)
5009{
5010 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5011
5012 return wq_dev->wq;
5013}
5014
5015static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5016 char *buf)
5017{
5018 struct workqueue_struct *wq = dev_to_wq(dev);
5019
5020 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5021}
5022static DEVICE_ATTR_RO(per_cpu);
5023
5024static ssize_t max_active_show(struct device *dev,
5025 struct device_attribute *attr, char *buf)
5026{
5027 struct workqueue_struct *wq = dev_to_wq(dev);
5028
5029 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5030}
5031
5032static ssize_t max_active_store(struct device *dev,
5033 struct device_attribute *attr, const char *buf,
5034 size_t count)
5035{
5036 struct workqueue_struct *wq = dev_to_wq(dev);
5037 int val;
5038
5039 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5040 return -EINVAL;
5041
5042 workqueue_set_max_active(wq, val);
5043 return count;
5044}
5045static DEVICE_ATTR_RW(max_active);
5046
5047static struct attribute *wq_sysfs_attrs[] = {
5048 &dev_attr_per_cpu.attr,
5049 &dev_attr_max_active.attr,
5050 NULL,
5051};
5052ATTRIBUTE_GROUPS(wq_sysfs);
5053
5054static ssize_t wq_pool_ids_show(struct device *dev,
5055 struct device_attribute *attr, char *buf)
5056{
5057 struct workqueue_struct *wq = dev_to_wq(dev);
5058 const char *delim = "";
5059 int node, written = 0;
5060
5061 rcu_read_lock_sched();
5062 for_each_node(node) {
5063 written += scnprintf(buf + written, PAGE_SIZE - written,
5064 "%s%d:%d", delim, node,
5065 unbound_pwq_by_node(wq, node)->pool->id);
5066 delim = " ";
5067 }
5068 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5069 rcu_read_unlock_sched();
5070
5071 return written;
5072}
5073
5074static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5075 char *buf)
5076{
5077 struct workqueue_struct *wq = dev_to_wq(dev);
5078 int written;
5079
5080 mutex_lock(&wq->mutex);
5081 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5082 mutex_unlock(&wq->mutex);
5083
5084 return written;
5085}
5086
5087/* prepare workqueue_attrs for sysfs store operations */
5088static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5089{
5090 struct workqueue_attrs *attrs;
5091
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005092 lockdep_assert_held(&wq_pool_mutex);
5093
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005094 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5095 if (!attrs)
5096 return NULL;
5097
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005098 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005099 return attrs;
5100}
5101
5102static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5103 const char *buf, size_t count)
5104{
5105 struct workqueue_struct *wq = dev_to_wq(dev);
5106 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005107 int ret = -ENOMEM;
5108
5109 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005110
5111 attrs = wq_sysfs_prep_attrs(wq);
5112 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005113 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005114
5115 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5116 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005117 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005118 else
5119 ret = -EINVAL;
5120
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005121out_unlock:
5122 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005123 free_workqueue_attrs(attrs);
5124 return ret ?: count;
5125}
5126
5127static ssize_t wq_cpumask_show(struct device *dev,
5128 struct device_attribute *attr, char *buf)
5129{
5130 struct workqueue_struct *wq = dev_to_wq(dev);
5131 int written;
5132
5133 mutex_lock(&wq->mutex);
5134 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5135 cpumask_pr_args(wq->unbound_attrs->cpumask));
5136 mutex_unlock(&wq->mutex);
5137 return written;
5138}
5139
5140static ssize_t wq_cpumask_store(struct device *dev,
5141 struct device_attribute *attr,
5142 const char *buf, size_t count)
5143{
5144 struct workqueue_struct *wq = dev_to_wq(dev);
5145 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005146 int ret = -ENOMEM;
5147
5148 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005149
5150 attrs = wq_sysfs_prep_attrs(wq);
5151 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005152 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005153
5154 ret = cpumask_parse(buf, attrs->cpumask);
5155 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005156 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005157
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005158out_unlock:
5159 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005160 free_workqueue_attrs(attrs);
5161 return ret ?: count;
5162}
5163
5164static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5165 char *buf)
5166{
5167 struct workqueue_struct *wq = dev_to_wq(dev);
5168 int written;
5169
5170 mutex_lock(&wq->mutex);
5171 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5172 !wq->unbound_attrs->no_numa);
5173 mutex_unlock(&wq->mutex);
5174
5175 return written;
5176}
5177
5178static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5179 const char *buf, size_t count)
5180{
5181 struct workqueue_struct *wq = dev_to_wq(dev);
5182 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005183 int v, ret = -ENOMEM;
5184
5185 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005186
5187 attrs = wq_sysfs_prep_attrs(wq);
5188 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005189 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005190
5191 ret = -EINVAL;
5192 if (sscanf(buf, "%d", &v) == 1) {
5193 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005194 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005195 }
5196
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005197out_unlock:
5198 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005199 free_workqueue_attrs(attrs);
5200 return ret ?: count;
5201}
5202
5203static struct device_attribute wq_sysfs_unbound_attrs[] = {
5204 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5205 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5206 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5207 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5208 __ATTR_NULL,
5209};
5210
5211static struct bus_type wq_subsys = {
5212 .name = "workqueue",
5213 .dev_groups = wq_sysfs_groups,
5214};
5215
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005216static ssize_t wq_unbound_cpumask_show(struct device *dev,
5217 struct device_attribute *attr, char *buf)
5218{
5219 int written;
5220
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005221 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005222 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5223 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005224 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005225
5226 return written;
5227}
5228
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005229static ssize_t wq_unbound_cpumask_store(struct device *dev,
5230 struct device_attribute *attr, const char *buf, size_t count)
5231{
5232 cpumask_var_t cpumask;
5233 int ret;
5234
5235 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5236 return -ENOMEM;
5237
5238 ret = cpumask_parse(buf, cpumask);
5239 if (!ret)
5240 ret = workqueue_set_unbound_cpumask(cpumask);
5241
5242 free_cpumask_var(cpumask);
5243 return ret ? ret : count;
5244}
5245
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005246static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005247 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5248 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005249
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005250static int __init wq_sysfs_init(void)
5251{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005252 int err;
5253
5254 err = subsys_virtual_register(&wq_subsys, NULL);
5255 if (err)
5256 return err;
5257
5258 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005259}
5260core_initcall(wq_sysfs_init);
5261
5262static void wq_device_release(struct device *dev)
5263{
5264 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5265
5266 kfree(wq_dev);
5267}
5268
5269/**
5270 * workqueue_sysfs_register - make a workqueue visible in sysfs
5271 * @wq: the workqueue to register
5272 *
5273 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5274 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5275 * which is the preferred method.
5276 *
5277 * Workqueue user should use this function directly iff it wants to apply
5278 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5279 * apply_workqueue_attrs() may race against userland updating the
5280 * attributes.
5281 *
5282 * Return: 0 on success, -errno on failure.
5283 */
5284int workqueue_sysfs_register(struct workqueue_struct *wq)
5285{
5286 struct wq_device *wq_dev;
5287 int ret;
5288
5289 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305290 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005291 * attributes breaks ordering guarantee. Disallow exposing ordered
5292 * workqueues.
5293 */
Tejun Heof9636c92017-07-23 08:36:15 -04005294 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005295 return -EINVAL;
5296
5297 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5298 if (!wq_dev)
5299 return -ENOMEM;
5300
5301 wq_dev->wq = wq;
5302 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005303 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005304 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005305
5306 /*
5307 * unbound_attrs are created separately. Suppress uevent until
5308 * everything is ready.
5309 */
5310 dev_set_uevent_suppress(&wq_dev->dev, true);
5311
5312 ret = device_register(&wq_dev->dev);
5313 if (ret) {
Arvind Yadav30393942018-03-06 15:35:43 +05305314 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005315 wq->wq_dev = NULL;
5316 return ret;
5317 }
5318
5319 if (wq->flags & WQ_UNBOUND) {
5320 struct device_attribute *attr;
5321
5322 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5323 ret = device_create_file(&wq_dev->dev, attr);
5324 if (ret) {
5325 device_unregister(&wq_dev->dev);
5326 wq->wq_dev = NULL;
5327 return ret;
5328 }
5329 }
5330 }
5331
5332 dev_set_uevent_suppress(&wq_dev->dev, false);
5333 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5334 return 0;
5335}
5336
5337/**
5338 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5339 * @wq: the workqueue to unregister
5340 *
5341 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5342 */
5343static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5344{
5345 struct wq_device *wq_dev = wq->wq_dev;
5346
5347 if (!wq->wq_dev)
5348 return;
5349
5350 wq->wq_dev = NULL;
5351 device_unregister(&wq_dev->dev);
5352}
5353#else /* CONFIG_SYSFS */
5354static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5355#endif /* CONFIG_SYSFS */
5356
Tejun Heo82607adc2015-12-08 11:28:04 -05005357/*
5358 * Workqueue watchdog.
5359 *
5360 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5361 * flush dependency, a concurrency managed work item which stays RUNNING
5362 * indefinitely. Workqueue stalls can be very difficult to debug as the
5363 * usual warning mechanisms don't trigger and internal workqueue state is
5364 * largely opaque.
5365 *
5366 * Workqueue watchdog monitors all worker pools periodically and dumps
5367 * state if some pools failed to make forward progress for a while where
5368 * forward progress is defined as the first item on ->worklist changing.
5369 *
5370 * This mechanism is controlled through the kernel parameter
5371 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5372 * corresponding sysfs parameter file.
5373 */
5374#ifdef CONFIG_WQ_WATCHDOG
5375
5376static void wq_watchdog_timer_fn(unsigned long data);
5377
5378static unsigned long wq_watchdog_thresh = 30;
5379static struct timer_list wq_watchdog_timer =
5380 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5381
5382static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5383static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5384
5385static void wq_watchdog_reset_touched(void)
5386{
5387 int cpu;
5388
5389 wq_watchdog_touched = jiffies;
5390 for_each_possible_cpu(cpu)
5391 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5392}
5393
5394static void wq_watchdog_timer_fn(unsigned long data)
5395{
5396 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5397 bool lockup_detected = false;
5398 struct worker_pool *pool;
5399 int pi;
5400
5401 if (!thresh)
5402 return;
5403
5404 rcu_read_lock();
5405
5406 for_each_pool(pool, pi) {
5407 unsigned long pool_ts, touched, ts;
5408
5409 if (list_empty(&pool->worklist))
5410 continue;
5411
5412 /* get the latest of pool and touched timestamps */
5413 pool_ts = READ_ONCE(pool->watchdog_ts);
5414 touched = READ_ONCE(wq_watchdog_touched);
5415
5416 if (time_after(pool_ts, touched))
5417 ts = pool_ts;
5418 else
5419 ts = touched;
5420
5421 if (pool->cpu >= 0) {
5422 unsigned long cpu_touched =
5423 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5424 pool->cpu));
5425 if (time_after(cpu_touched, ts))
5426 ts = cpu_touched;
5427 }
5428
5429 /* did we stall? */
5430 if (time_after(jiffies, ts + thresh)) {
5431 lockup_detected = true;
5432 pr_emerg("BUG: workqueue lockup - pool");
5433 pr_cont_pool_info(pool);
5434 pr_cont(" stuck for %us!\n",
5435 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5436 }
5437 }
5438
5439 rcu_read_unlock();
5440
5441 if (lockup_detected)
5442 show_workqueue_state();
5443
5444 wq_watchdog_reset_touched();
5445 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5446}
5447
5448void wq_watchdog_touch(int cpu)
5449{
5450 if (cpu >= 0)
5451 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5452 else
5453 wq_watchdog_touched = jiffies;
5454}
5455
5456static void wq_watchdog_set_thresh(unsigned long thresh)
5457{
5458 wq_watchdog_thresh = 0;
5459 del_timer_sync(&wq_watchdog_timer);
5460
5461 if (thresh) {
5462 wq_watchdog_thresh = thresh;
5463 wq_watchdog_reset_touched();
5464 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5465 }
5466}
5467
5468static int wq_watchdog_param_set_thresh(const char *val,
5469 const struct kernel_param *kp)
5470{
5471 unsigned long thresh;
5472 int ret;
5473
5474 ret = kstrtoul(val, 0, &thresh);
5475 if (ret)
5476 return ret;
5477
5478 if (system_wq)
5479 wq_watchdog_set_thresh(thresh);
5480 else
5481 wq_watchdog_thresh = thresh;
5482
5483 return 0;
5484}
5485
5486static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5487 .set = wq_watchdog_param_set_thresh,
5488 .get = param_get_ulong,
5489};
5490
5491module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5492 0644);
5493
5494static void wq_watchdog_init(void)
5495{
5496 wq_watchdog_set_thresh(wq_watchdog_thresh);
5497}
5498
5499#else /* CONFIG_WQ_WATCHDOG */
5500
5501static inline void wq_watchdog_init(void) { }
5502
5503#endif /* CONFIG_WQ_WATCHDOG */
5504
Tejun Heobce90382013-04-01 11:23:32 -07005505static void __init wq_numa_init(void)
5506{
5507 cpumask_var_t *tbl;
5508 int node, cpu;
5509
Tejun Heobce90382013-04-01 11:23:32 -07005510 if (num_possible_nodes() <= 1)
5511 return;
5512
Tejun Heod55262c2013-04-01 11:23:38 -07005513 if (wq_disable_numa) {
5514 pr_info("workqueue: NUMA affinity support disabled\n");
5515 return;
5516 }
5517
Tejun Heo4c16bd32013-04-01 11:23:36 -07005518 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5519 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5520
Tejun Heobce90382013-04-01 11:23:32 -07005521 /*
5522 * We want masks of possible CPUs of each node which isn't readily
5523 * available. Build one from cpu_to_node() which should have been
5524 * fully initialized by now.
5525 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005526 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005527 BUG_ON(!tbl);
5528
5529 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005530 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005531 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005532
5533 for_each_possible_cpu(cpu) {
5534 node = cpu_to_node(cpu);
5535 if (WARN_ON(node == NUMA_NO_NODE)) {
5536 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5537 /* happens iff arch is bonkers, let's just proceed */
5538 return;
5539 }
5540 cpumask_set_cpu(cpu, tbl[node]);
5541 }
5542
5543 wq_numa_possible_cpumask = tbl;
5544 wq_numa_enabled = true;
5545}
5546
Tejun Heo4b5facd2016-09-16 15:49:32 -04005547/**
5548 * workqueue_init_early - early init for workqueue subsystem
5549 *
5550 * This is the first half of two-staged workqueue subsystem initialization
5551 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5552 * idr are up. It sets up all the data structures and system workqueues
5553 * and allows early boot code to create workqueues and queue/cancel work
5554 * items. Actual work item execution starts only after kthreads can be
5555 * created and scheduled right before early initcalls.
5556 */
5557int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005558{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005559 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5560 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005561
Tejun Heoe904e6c2013-03-12 11:29:57 -07005562 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5563
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005564 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5565 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5566
Tejun Heoe904e6c2013-03-12 11:29:57 -07005567 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5568
Tejun Heobce90382013-04-01 11:23:32 -07005569 wq_numa_init();
5570
Tejun Heo706026c2013-01-24 11:01:34 -08005571 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005572 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005573 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005574
Tejun Heo7a4e3442013-03-12 11:30:00 -07005575 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005576 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005577 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005578 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005579 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005580 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005581 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005582
Tejun Heo9daf9e62013-01-24 11:01:33 -08005583 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005584 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005585 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005586 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005587 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005588 }
5589
Tejun Heo8a2b7532013-09-05 12:30:04 -04005590 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005591 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5592 struct workqueue_attrs *attrs;
5593
5594 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005595 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005596 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005597
5598 /*
5599 * An ordered wq should have only one pwq as ordering is
5600 * guaranteed by max_active which is enforced by pwqs.
5601 * Turn off NUMA so that dfl_pwq is used for all nodes.
5602 */
5603 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5604 attrs->nice = std_nice[i];
5605 attrs->no_numa = true;
5606 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005607 }
5608
Tejun Heod320c032010-06-29 10:07:14 +02005609 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005610 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005611 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005612 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5613 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005614 system_freezable_wq = alloc_workqueue("events_freezable",
5615 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305616 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5617 WQ_POWER_EFFICIENT, 0);
5618 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5619 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5620 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005621 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305622 !system_unbound_wq || !system_freezable_wq ||
5623 !system_power_efficient_wq ||
5624 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005625
Tejun Heo4b5facd2016-09-16 15:49:32 -04005626 return 0;
5627}
5628
5629/**
5630 * workqueue_init - bring workqueue subsystem fully online
5631 *
5632 * This is the latter half of two-staged workqueue subsystem initialization
5633 * and invoked as soon as kthreads can be created and scheduled.
5634 * Workqueues have been created and work items queued on them, but there
5635 * are no kworkers executing the work items yet. Populate the worker pools
5636 * with the initial workers and enable future kworker creations.
5637 */
5638int __init workqueue_init(void)
5639{
5640 struct worker_pool *pool;
5641 int cpu, bkt;
5642
5643 /* create the initial workers */
5644 for_each_online_cpu(cpu) {
5645 for_each_cpu_worker_pool(pool, cpu) {
5646 pool->flags &= ~POOL_DISASSOCIATED;
5647 BUG_ON(!create_worker(pool));
5648 }
5649 }
5650
5651 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5652 BUG_ON(!create_worker(pool));
5653
5654 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005655 wq_watchdog_init();
5656
Suresh Siddha6ee05782010-07-30 14:57:37 -07005657 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005658}