blob: 7d970b565c4d73a8750890b4424da84917419024 [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 Heobce90382013-04-01 11:23:32 -0700294static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
295
Tejun Heo4c16bd32013-04-01 11:23:36 -0700296/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
297static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
298
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700299static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700300static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo43a980a2017-10-09 08:04:13 -0700301static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700302
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400303static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700304static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700305
Mike Galbraithef5571802016-02-09 17:59:38 -0500306/* PL: allowable cpus for unbound wqs and work items */
307static cpumask_var_t wq_unbound_cpumask;
308
309/* CPU where unbound work was last round robin scheduled from this CPU */
310static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800311
Tejun Heof303fcc2016-02-09 17:59:38 -0500312/*
313 * Local execution of unbound work items is no longer guaranteed. The
314 * following always forces round-robin CPU selection on unbound work items
315 * to uncover usages which depend on it.
316 */
317#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
318static bool wq_debug_force_rr_cpu = true;
319#else
320static bool wq_debug_force_rr_cpu = false;
321#endif
322module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
323
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700324/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700325static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700326
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700327static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700328
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700329/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700330static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
331
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700332/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700333static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
334
Tejun Heo8a2b7532013-09-05 12:30:04 -0400335/* I: attributes used when instantiating ordered pools on demand */
336static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
337
Tejun Heod320c032010-06-29 10:07:14 +0200338struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400339EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300340struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900341EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300342struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200343EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200345EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300346struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100347EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530348struct workqueue_struct *system_power_efficient_wq __read_mostly;
349EXPORT_SYMBOL_GPL(system_power_efficient_wq);
350struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
351EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200352
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700353static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800354static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700355
Tejun Heo97bd2342010-10-05 10:41:14 +0200356#define CREATE_TRACE_POINTS
357#include <trace/events/workqueue.h>
358
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700359#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700360 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
361 !lockdep_is_held(&wq_pool_mutex), \
362 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700363
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700364#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700365 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
366 !lockdep_is_held(&wq->mutex), \
367 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700368
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800369#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700370 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
371 !lockdep_is_held(&wq->mutex) && \
372 !lockdep_is_held(&wq_pool_mutex), \
373 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800374
Tejun Heof02ae732013-03-12 11:30:03 -0700375#define for_each_cpu_worker_pool(pool, cpu) \
376 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
377 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700378 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700379
Tejun Heo49e3cf42013-03-12 11:29:58 -0700380/**
Tejun Heo17116962013-03-12 11:29:58 -0700381 * for_each_pool - iterate through all worker_pools in the system
382 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700383 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700384 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700385 * This must be called either with wq_pool_mutex held or sched RCU read
386 * locked. If the pool needs to be used beyond the locking in effect, the
387 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700388 *
389 * The if/else clause exists only for the lockdep assertion and can be
390 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700391 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700392#define for_each_pool(pool, pi) \
393 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700394 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700395 else
Tejun Heo17116962013-03-12 11:29:58 -0700396
397/**
Tejun Heo822d8402013-03-19 13:45:21 -0700398 * for_each_pool_worker - iterate through all workers of a worker_pool
399 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700400 * @pool: worker_pool to iterate workers of
401 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800402 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700403 *
404 * The if/else clause exists only for the lockdep assertion and can be
405 * ignored.
406 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800407#define for_each_pool_worker(worker, pool) \
408 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800409 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700410 else
411
412/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700413 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
414 * @pwq: iteration cursor
415 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700416 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700417 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700418 * If the pwq needs to be used beyond the locking in effect, the caller is
419 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700420 *
421 * The if/else clause exists only for the lockdep assertion and can be
422 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700423 */
424#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700425 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700426 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700427 else
Tejun Heof3421792010-07-02 10:03:51 +0200428
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900429#ifdef CONFIG_DEBUG_OBJECTS_WORK
430
431static struct debug_obj_descr work_debug_descr;
432
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100433static void *work_debug_hint(void *addr)
434{
435 return ((struct work_struct *) addr)->func;
436}
437
Du, Changbinb9fdac72016-05-19 17:09:41 -0700438static bool work_is_static_object(void *addr)
439{
440 struct work_struct *work = addr;
441
442 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
443}
444
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900445/*
446 * fixup_init is called when:
447 * - an active object is initialized
448 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700449static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900450{
451 struct work_struct *work = addr;
452
453 switch (state) {
454 case ODEBUG_STATE_ACTIVE:
455 cancel_work_sync(work);
456 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700457 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900458 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700459 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900460 }
461}
462
463/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900464 * fixup_free is called when:
465 * - an active object is freed
466 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700467static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900468{
469 struct work_struct *work = addr;
470
471 switch (state) {
472 case ODEBUG_STATE_ACTIVE:
473 cancel_work_sync(work);
474 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700475 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900476 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 }
479}
480
481static struct debug_obj_descr work_debug_descr = {
482 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100483 .debug_hint = work_debug_hint,
Du, Changbinb9fdac72016-05-19 17:09:41 -0700484 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900485 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900486 .fixup_free = work_fixup_free,
487};
488
489static inline void debug_work_activate(struct work_struct *work)
490{
491 debug_object_activate(work, &work_debug_descr);
492}
493
494static inline void debug_work_deactivate(struct work_struct *work)
495{
496 debug_object_deactivate(work, &work_debug_descr);
497}
498
499void __init_work(struct work_struct *work, int onstack)
500{
501 if (onstack)
502 debug_object_init_on_stack(work, &work_debug_descr);
503 else
504 debug_object_init(work, &work_debug_descr);
505}
506EXPORT_SYMBOL_GPL(__init_work);
507
508void destroy_work_on_stack(struct work_struct *work)
509{
510 debug_object_free(work, &work_debug_descr);
511}
512EXPORT_SYMBOL_GPL(destroy_work_on_stack);
513
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000514void destroy_delayed_work_on_stack(struct delayed_work *work)
515{
516 destroy_timer_on_stack(&work->timer);
517 debug_object_free(&work->work, &work_debug_descr);
518}
519EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
520
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900521#else
522static inline void debug_work_activate(struct work_struct *work) { }
523static inline void debug_work_deactivate(struct work_struct *work) { }
524#endif
525
Li Bin4e8b22b2013-09-10 09:52:35 +0800526/**
527 * worker_pool_assign_id - allocate ID and assing it to @pool
528 * @pool: the pool pointer of interest
529 *
530 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
531 * successfully, -errno on failure.
532 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800533static int worker_pool_assign_id(struct worker_pool *pool)
534{
535 int ret;
536
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700537 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700538
Li Bin4e8b22b2013-09-10 09:52:35 +0800539 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
540 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700541 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700542 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700543 return 0;
544 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800545 return ret;
546}
547
Tejun Heo76af4d92013-03-12 11:30:00 -0700548/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700549 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
550 * @wq: the target workqueue
551 * @node: the node ID
552 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800553 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
554 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700555 * If the pwq needs to be used beyond the locking in effect, the caller is
556 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700557 *
558 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700559 */
560static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
561 int node)
562{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800563 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500564
565 /*
566 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
567 * delayed item is pending. The plan is to keep CPU -> NODE
568 * mapping valid and stable across CPU on/offlines. Once that
569 * happens, this workaround can be removed.
570 */
571 if (unlikely(node == NUMA_NO_NODE))
572 return wq->dfl_pwq;
573
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700574 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
575}
576
Tejun Heo73f53c42010-06-29 10:07:11 +0200577static unsigned int work_color_to_flags(int color)
578{
579 return color << WORK_STRUCT_COLOR_SHIFT;
580}
581
582static int get_work_color(struct work_struct *work)
583{
584 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
585 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
586}
587
588static int work_next_color(int color)
589{
590 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700591}
592
David Howells4594bf12006-12-07 11:33:26 +0000593/*
Tejun Heo112202d2013-02-13 19:29:12 -0800594 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
595 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800596 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200597 *
Tejun Heo112202d2013-02-13 19:29:12 -0800598 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
599 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700600 * work->data. These functions should only be called while the work is
601 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 *
Tejun Heo112202d2013-02-13 19:29:12 -0800603 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800604 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700607 *
608 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
609 * canceled. While being canceled, a work item may have its PENDING set
610 * but stay off timer and worklist for arbitrarily long and nobody should
611 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000612 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200613static inline void set_work_data(struct work_struct *work, unsigned long data,
614 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000615{
Tejun Heo6183c002013-03-12 11:29:57 -0700616 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000618}
David Howells365970a2006-11-22 14:54:49 +0000619
Tejun Heo112202d2013-02-13 19:29:12 -0800620static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200621 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200622{
Tejun Heo112202d2013-02-13 19:29:12 -0800623 set_work_data(work, (unsigned long)pwq,
624 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200625}
626
Lai Jiangshan4468a002013-02-06 18:04:53 -0800627static void set_work_pool_and_keep_pending(struct work_struct *work,
628 int pool_id)
629{
630 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
631 WORK_STRUCT_PENDING);
632}
633
Tejun Heo7c3eed52013-01-24 11:01:33 -0800634static void set_work_pool_and_clear_pending(struct work_struct *work,
635 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000636{
Tejun Heo23657bb2012-08-13 17:08:19 -0700637 /*
638 * The following wmb is paired with the implied mb in
639 * test_and_set_bit(PENDING) and ensures all updates to @work made
640 * here are visible to and precede any updates by the next PENDING
641 * owner.
642 */
643 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800644 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200645 /*
646 * The following mb guarantees that previous clear of a PENDING bit
647 * will not be reordered with any speculative LOADS or STORES from
648 * work->current_func, which is executed afterwards. This possible
649 * reordering can lead to a missed execution on attempt to qeueue
650 * the same @work. E.g. consider this case:
651 *
652 * CPU#0 CPU#1
653 * ---------------------------- --------------------------------
654 *
655 * 1 STORE event_indicated
656 * 2 queue_work_on() {
657 * 3 test_and_set_bit(PENDING)
658 * 4 } set_..._and_clear_pending() {
659 * 5 set_work_data() # clear bit
660 * 6 smp_mb()
661 * 7 work->current_func() {
662 * 8 LOAD event_indicated
663 * }
664 *
665 * Without an explicit full barrier speculative LOAD on line 8 can
666 * be executed before CPU#0 does STORE on line 1. If that happens,
667 * CPU#0 observes the PENDING bit is still set and new execution of
668 * a @work is not queued in a hope, that CPU#1 will eventually
669 * finish the queued @work. Meanwhile CPU#1 does not see
670 * event_indicated is set, because speculative LOAD was executed
671 * before actual STORE.
672 */
673 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200674}
675
676static void clear_work_data(struct work_struct *work)
677{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800678 smp_wmb(); /* see set_work_pool_and_clear_pending() */
679 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200680}
681
Tejun Heo112202d2013-02-13 19:29:12 -0800682static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200683{
Tejun Heoe1201532010-07-22 14:14:25 +0200684 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685
Tejun Heo112202d2013-02-13 19:29:12 -0800686 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200687 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
688 else
689 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200690}
691
Tejun Heo7c3eed52013-01-24 11:01:33 -0800692/**
693 * get_work_pool - return the worker_pool a given work was associated with
694 * @work: the work item of interest
695 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700696 * Pools are created and destroyed under wq_pool_mutex, and allows read
697 * access under sched-RCU read lock. As such, this function should be
698 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700699 *
700 * All fields of the returned pool are accessible as long as the above
701 * mentioned locking is in effect. If the returned pool needs to be used
702 * beyond the critical section, the caller is responsible for ensuring the
703 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700704 *
705 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800706 */
707static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200708{
Tejun Heoe1201532010-07-22 14:14:25 +0200709 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200711
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700712 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700713
Tejun Heo112202d2013-02-13 19:29:12 -0800714 if (data & WORK_STRUCT_PWQ)
715 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800716 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200717
Tejun Heo7c3eed52013-01-24 11:01:33 -0800718 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
719 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200720 return NULL;
721
Tejun Heofa1b54e2013-03-12 11:30:00 -0700722 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723}
724
725/**
726 * get_work_pool_id - return the worker pool ID a given work is associated with
727 * @work: the work item of interest
728 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700729 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800730 * %WORK_OFFQ_POOL_NONE if none.
731 */
732static int get_work_pool_id(struct work_struct *work)
733{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800734 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800735
Tejun Heo112202d2013-02-13 19:29:12 -0800736 if (data & WORK_STRUCT_PWQ)
737 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800738 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
739
740 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800741}
742
Tejun Heobbb68df2012-08-03 10:30:46 -0700743static void mark_work_canceling(struct work_struct *work)
744{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800745 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700746
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 pool_id <<= WORK_OFFQ_POOL_SHIFT;
748 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700749}
750
751static bool work_is_canceling(struct work_struct *work)
752{
753 unsigned long data = atomic_long_read(&work->data);
754
Tejun Heo112202d2013-02-13 19:29:12 -0800755 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700756}
757
David Howells365970a2006-11-22 14:54:49 +0000758/*
Tejun Heo32704762012-07-13 22:16:45 -0700759 * Policy functions. These define the policies on how the global worker
760 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800761 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000762 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200763
Tejun Heo63d95a92012-07-12 14:46:37 -0700764static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000765{
Tejun Heoe19e3972013-01-24 11:39:44 -0800766 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000767}
768
Tejun Heoe22bee72010-06-29 10:07:14 +0200769/*
770 * Need to wake up a worker? Called from anything but currently
771 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700772 *
773 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800774 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700775 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200776 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700777static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000778{
Tejun Heo63d95a92012-07-12 14:46:37 -0700779 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000780}
781
Tejun Heoe22bee72010-06-29 10:07:14 +0200782/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700783static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200784{
Tejun Heo63d95a92012-07-12 14:46:37 -0700785 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200786}
787
788/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700789static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200790{
Tejun Heoe19e3972013-01-24 11:39:44 -0800791 return !list_empty(&pool->worklist) &&
792 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200793}
794
795/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700796static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200797{
Tejun Heo63d95a92012-07-12 14:46:37 -0700798 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200799}
800
Tejun Heoe22bee72010-06-29 10:07:14 +0200801/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700802static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200803{
Tejun Heo43a980a2017-10-09 08:04:13 -0700804 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700805 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
806 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807
808 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
809}
810
811/*
812 * Wake up functions.
813 */
814
Lai Jiangshan1037de32014-05-22 16:44:07 +0800815/* Return the first idle worker. Safe with preemption disabled */
816static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200817{
Tejun Heo63d95a92012-07-12 14:46:37 -0700818 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200819 return NULL;
820
Tejun Heo63d95a92012-07-12 14:46:37 -0700821 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200822}
823
824/**
825 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700826 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200827 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
830 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800831 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200832 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700833static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200834{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800835 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200836
837 if (likely(worker))
838 wake_up_process(worker->task);
839}
840
Tejun Heo4690c4a2010-06-29 10:07:10 +0200841/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 * wq_worker_waking_up - a worker is waking up
843 * @task: task waking up
844 * @cpu: CPU @task is waking up to
845 *
846 * This function is called during try_to_wake_up() when a worker is
847 * being awoken.
848 *
849 * CONTEXT:
850 * spin_lock_irq(rq->lock)
851 */
Tejun Heod84ff052013-03-12 11:29:59 -0700852void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200853{
854 struct worker *worker = kthread_data(task);
855
Joonsoo Kim36576002012-10-26 23:03:49 +0900856 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800857 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800858 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900859 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200860}
861
862/**
863 * wq_worker_sleeping - a worker is going to sleep
864 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200865 *
866 * This function is called during schedule() when a busy worker is
867 * going to sleep. Worker on the same cpu can be woken up by
868 * returning pointer to its task.
869 *
870 * CONTEXT:
871 * spin_lock_irq(rq->lock)
872 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700873 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200874 * Worker task on @cpu to wake up, %NULL if none.
875 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100876struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200877{
878 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800879 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200880
Tejun Heo111c2252013-01-17 17:16:24 -0800881 /*
882 * Rescuers, which may not have all the fields set up like normal
883 * workers, also reach here, let's not access anything before
884 * checking NOT_RUNNING.
885 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500886 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200887 return NULL;
888
Tejun Heo111c2252013-01-17 17:16:24 -0800889 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800890
Tejun Heoe22bee72010-06-29 10:07:14 +0200891 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100892 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700893 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200894
895 /*
896 * The counterpart of the following dec_and_test, implied mb,
897 * worklist not empty test sequence is in insert_work().
898 * Please read comment there.
899 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700900 * NOT_RUNNING is clear. This means that we're bound to and
901 * running on the local cpu w/ rq lock held and preemption
902 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800903 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700904 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200905 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800906 if (atomic_dec_and_test(&pool->nr_running) &&
907 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800908 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200909 return to_wakeup ? to_wakeup->task : NULL;
910}
911
912/**
913 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200914 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200915 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200916 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800917 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200918 *
Tejun Heocb444762010-07-02 10:03:50 +0200919 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800920 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200921 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800922static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200923{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700924 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200925
Tejun Heocb444762010-07-02 10:03:50 +0200926 WARN_ON_ONCE(worker->task != current);
927
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800928 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200929 if ((flags & WORKER_NOT_RUNNING) &&
930 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800931 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200932 }
933
Tejun Heod302f012010-06-29 10:07:13 +0200934 worker->flags |= flags;
935}
936
937/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200938 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200939 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200940 * @flags: flags to clear
941 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200942 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200943 *
Tejun Heocb444762010-07-02 10:03:50 +0200944 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800945 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200946 */
947static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
948{
Tejun Heo63d95a92012-07-12 14:46:37 -0700949 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200950 unsigned int oflags = worker->flags;
951
Tejun Heocb444762010-07-02 10:03:50 +0200952 WARN_ON_ONCE(worker->task != current);
953
Tejun Heod302f012010-06-29 10:07:13 +0200954 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200955
Tejun Heo42c025f2011-01-11 15:58:49 +0100956 /*
957 * If transitioning out of NOT_RUNNING, increment nr_running. Note
958 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
959 * of multiple flags, not a single flag.
960 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200961 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
962 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800963 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200964}
965
966/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200967 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800968 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200969 * @work: work to find worker for
970 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800971 * Find a worker which is executing @work on @pool by searching
972 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800973 * to match, its current execution should match the address of @work and
974 * its work function. This is to avoid unwanted dependency between
975 * unrelated work executions through a work item being recycled while still
976 * being executed.
977 *
978 * This is a bit tricky. A work item may be freed once its execution
979 * starts and nothing prevents the freed area from being recycled for
980 * another work item. If the same work item address ends up being reused
981 * before the original execution finishes, workqueue will identify the
982 * recycled work item as currently executing and make it wait until the
983 * current execution finishes, introducing an unwanted dependency.
984 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700985 * This function checks the work item address and work function to avoid
986 * false positives. Note that this isn't complete as one may construct a
987 * work function which can introduce dependency onto itself through a
988 * recycled work item. Well, if somebody wants to shoot oneself in the
989 * foot that badly, there's only so much we can do, and if such deadlock
990 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200991 *
992 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800993 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200994 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700995 * Return:
996 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200997 * otherwise.
998 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800999static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001000 struct work_struct *work)
1001{
Sasha Levin42f85702012-12-17 10:01:23 -05001002 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001003
Sasha Levinb67bfe02013-02-27 17:06:00 -08001004 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001005 (unsigned long)work)
1006 if (worker->current_work == work &&
1007 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001008 return worker;
1009
1010 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001011}
1012
1013/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001014 * move_linked_works - move linked works to a list
1015 * @work: start of series of works to be scheduled
1016 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301017 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001018 *
1019 * Schedule linked works starting from @work to @head. Work series to
1020 * be scheduled starts at @work and includes any consecutive work with
1021 * WORK_STRUCT_LINKED set in its predecessor.
1022 *
1023 * If @nextp is not NULL, it's updated to point to the next work of
1024 * the last scheduled work. This allows move_linked_works() to be
1025 * nested inside outer list_for_each_entry_safe().
1026 *
1027 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001028 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001029 */
1030static void move_linked_works(struct work_struct *work, struct list_head *head,
1031 struct work_struct **nextp)
1032{
1033 struct work_struct *n;
1034
1035 /*
1036 * Linked worklist will always end before the end of the list,
1037 * use NULL for list head.
1038 */
1039 list_for_each_entry_safe_from(work, n, NULL, entry) {
1040 list_move_tail(&work->entry, head);
1041 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1042 break;
1043 }
1044
1045 /*
1046 * If we're already inside safe list traversal and have moved
1047 * multiple works to the scheduled queue, the next position
1048 * needs to be updated.
1049 */
1050 if (nextp)
1051 *nextp = n;
1052}
1053
Tejun Heo8864b4e2013-03-12 11:30:04 -07001054/**
1055 * get_pwq - get an extra reference on the specified pool_workqueue
1056 * @pwq: pool_workqueue to get
1057 *
1058 * Obtain an extra reference on @pwq. The caller should guarantee that
1059 * @pwq has positive refcnt and be holding the matching pool->lock.
1060 */
1061static void get_pwq(struct pool_workqueue *pwq)
1062{
1063 lockdep_assert_held(&pwq->pool->lock);
1064 WARN_ON_ONCE(pwq->refcnt <= 0);
1065 pwq->refcnt++;
1066}
1067
1068/**
1069 * put_pwq - put a pool_workqueue reference
1070 * @pwq: pool_workqueue to put
1071 *
1072 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1073 * destruction. The caller should be holding the matching pool->lock.
1074 */
1075static void put_pwq(struct pool_workqueue *pwq)
1076{
1077 lockdep_assert_held(&pwq->pool->lock);
1078 if (likely(--pwq->refcnt))
1079 return;
1080 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1081 return;
1082 /*
1083 * @pwq can't be released under pool->lock, bounce to
1084 * pwq_unbound_release_workfn(). This never recurses on the same
1085 * pool->lock as this path is taken only for unbound workqueues and
1086 * the release work item is scheduled on a per-cpu workqueue. To
1087 * avoid lockdep warning, unbound pool->locks are given lockdep
1088 * subclass of 1 in get_unbound_pool().
1089 */
1090 schedule_work(&pwq->unbound_release_work);
1091}
1092
Tejun Heodce90d42013-04-01 11:23:35 -07001093/**
1094 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1095 * @pwq: pool_workqueue to put (can be %NULL)
1096 *
1097 * put_pwq() with locking. This function also allows %NULL @pwq.
1098 */
1099static void put_pwq_unlocked(struct pool_workqueue *pwq)
1100{
1101 if (pwq) {
1102 /*
1103 * As both pwqs and pools are sched-RCU protected, the
1104 * following lock operations are safe.
1105 */
1106 spin_lock_irq(&pwq->pool->lock);
1107 put_pwq(pwq);
1108 spin_unlock_irq(&pwq->pool->lock);
1109 }
1110}
1111
Tejun Heo112202d2013-02-13 19:29:12 -08001112static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001113{
Tejun Heo112202d2013-02-13 19:29:12 -08001114 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001115
1116 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001117 if (list_empty(&pwq->pool->worklist))
1118 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001119 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001120 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001121 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001122}
1123
Tejun Heo112202d2013-02-13 19:29:12 -08001124static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001125{
Tejun Heo112202d2013-02-13 19:29:12 -08001126 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001127 struct work_struct, entry);
1128
Tejun Heo112202d2013-02-13 19:29:12 -08001129 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001130}
1131
Tejun Heobf4ede02012-08-03 10:30:46 -07001132/**
Tejun Heo112202d2013-02-13 19:29:12 -08001133 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1134 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001135 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001136 *
1137 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001138 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001139 *
1140 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001141 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001142 */
Tejun Heo112202d2013-02-13 19:29:12 -08001143static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001144{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001145 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001146 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001147 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001148
Tejun Heo112202d2013-02-13 19:29:12 -08001149 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001150
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq->nr_active--;
1152 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001153 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001154 if (pwq->nr_active < pwq->max_active)
1155 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001156 }
1157
1158 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001159 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001160 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001161
1162 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001163 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001164 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001165
Tejun Heo112202d2013-02-13 19:29:12 -08001166 /* this pwq is done, clear flush_color */
1167 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001168
1169 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001170 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001171 * will handle the rest.
1172 */
Tejun Heo112202d2013-02-13 19:29:12 -08001173 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1174 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001175out_put:
1176 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001177}
1178
Tejun Heo36e227d2012-08-03 10:30:46 -07001179/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001180 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001181 * @work: work item to steal
1182 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001183 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001184 *
1185 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001186 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001187 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001188 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001189 * 1 if @work was pending and we successfully stole PENDING
1190 * 0 if @work was idle and we claimed PENDING
1191 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001192 * -ENOENT if someone else is canceling @work, this state may persist
1193 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001194 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001195 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001196 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001197 * interrupted while holding PENDING and @work off queue, irq must be
1198 * disabled on entry. This, combined with delayed_work->timer being
1199 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001200 *
1201 * On successful return, >= 0, irq is disabled and the caller is
1202 * responsible for releasing it using local_irq_restore(*@flags).
1203 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001204 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001205 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001206static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1207 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001208{
Tejun Heod565ed62013-01-24 11:01:33 -08001209 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001210 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001211
Tejun Heobbb68df2012-08-03 10:30:46 -07001212 local_irq_save(*flags);
1213
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 /* try to steal the timer if it exists */
1215 if (is_dwork) {
1216 struct delayed_work *dwork = to_delayed_work(work);
1217
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001218 /*
1219 * dwork->timer is irqsafe. If del_timer() fails, it's
1220 * guaranteed that the timer is not queued anywhere and not
1221 * running on the local CPU.
1222 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001223 if (likely(del_timer(&dwork->timer)))
1224 return 1;
1225 }
1226
1227 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001228 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1229 return 0;
1230
1231 /*
1232 * The queueing is in progress, or it is already queued. Try to
1233 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1234 */
Tejun Heod565ed62013-01-24 11:01:33 -08001235 pool = get_work_pool(work);
1236 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001237 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001238
Tejun Heod565ed62013-01-24 11:01:33 -08001239 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001240 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001241 * work->data is guaranteed to point to pwq only while the work
1242 * item is queued on pwq->wq, and both updating work->data to point
1243 * to pwq on queueing and to pool on dequeueing are done under
1244 * pwq->pool->lock. This in turn guarantees that, if work->data
1245 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001246 * item is currently queued on that pool.
1247 */
Tejun Heo112202d2013-02-13 19:29:12 -08001248 pwq = get_work_pwq(work);
1249 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001250 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001251
Tejun Heo16062832013-02-06 18:04:53 -08001252 /*
1253 * A delayed work item cannot be grabbed directly because
1254 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001255 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001256 * management later on and cause stall. Make sure the work
1257 * item is activated before grabbing.
1258 */
1259 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001260 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001261
Tejun Heo16062832013-02-06 18:04:53 -08001262 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001263 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001264
Tejun Heo112202d2013-02-13 19:29:12 -08001265 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001266 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001267
Tejun Heo16062832013-02-06 18:04:53 -08001268 spin_unlock(&pool->lock);
1269 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001270 }
Tejun Heod565ed62013-01-24 11:01:33 -08001271 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001272fail:
1273 local_irq_restore(*flags);
1274 if (work_is_canceling(work))
1275 return -ENOENT;
1276 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001277 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001278}
1279
1280/**
Tejun Heo706026c2013-01-24 11:01:34 -08001281 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001282 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001283 * @work: work to insert
1284 * @head: insertion point
1285 * @extra_flags: extra WORK_STRUCT_* flags to set
1286 *
Tejun Heo112202d2013-02-13 19:29:12 -08001287 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001288 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001289 *
1290 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001291 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001292 */
Tejun Heo112202d2013-02-13 19:29:12 -08001293static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1294 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001295{
Tejun Heo112202d2013-02-13 19:29:12 -08001296 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001297
Tejun Heo4690c4a2010-06-29 10:07:10 +02001298 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001299 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001300 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001301 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001302
1303 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001304 * Ensure either wq_worker_sleeping() sees the above
1305 * list_add_tail() or we see zero nr_running to avoid workers lying
1306 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001307 */
1308 smp_mb();
1309
Tejun Heo63d95a92012-07-12 14:46:37 -07001310 if (__need_more_worker(pool))
1311 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001312}
1313
Tejun Heoc8efcc22010-12-20 19:32:04 +01001314/*
1315 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001316 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001317 */
1318static bool is_chained_work(struct workqueue_struct *wq)
1319{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001320 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001321
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001322 worker = current_wq_worker();
1323 /*
1324 * Return %true iff I'm a worker execuing a work item on @wq. If
1325 * I'm @worker, it's safe to dereference it without locking.
1326 */
Tejun Heo112202d2013-02-13 19:29:12 -08001327 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001328}
1329
Mike Galbraithef5571802016-02-09 17:59:38 -05001330/*
1331 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1332 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1333 * avoid perturbing sensitive tasks.
1334 */
1335static int wq_select_unbound_cpu(int cpu)
1336{
Tejun Heof303fcc2016-02-09 17:59:38 -05001337 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001338 int new_cpu;
1339
Tejun Heof303fcc2016-02-09 17:59:38 -05001340 if (likely(!wq_debug_force_rr_cpu)) {
1341 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1342 return cpu;
1343 } else if (!printed_dbg_warning) {
1344 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1345 printed_dbg_warning = true;
1346 }
1347
Mike Galbraithef5571802016-02-09 17:59:38 -05001348 if (cpumask_empty(wq_unbound_cpumask))
1349 return cpu;
1350
1351 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1352 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1353 if (unlikely(new_cpu >= nr_cpu_ids)) {
1354 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1355 if (unlikely(new_cpu >= nr_cpu_ids))
1356 return cpu;
1357 }
1358 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1359
1360 return new_cpu;
1361}
1362
Tejun Heod84ff052013-03-12 11:29:59 -07001363static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 struct work_struct *work)
1365{
Tejun Heo112202d2013-02-13 19:29:12 -08001366 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001367 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001368 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001369 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001370 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001371
1372 /*
1373 * While a work item is PENDING && off queue, a task trying to
1374 * steal the PENDING will busy-loop waiting for it to either get
1375 * queued or lose PENDING. Grabbing PENDING and queueing should
1376 * happen with IRQ disabled.
1377 */
1378 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001380 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001381
Li Bin9ef28a72013-09-09 13:13:58 +08001382 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001383 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001384 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001385 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001386retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001387 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001388 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001389
Tejun Heoc9178082013-03-12 11:30:04 -07001390 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001391 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001392 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 else
1394 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001395
Tejun Heoc9178082013-03-12 11:30:04 -07001396 /*
1397 * If @work was previously on a different pool, it might still be
1398 * running there, in which case the work needs to be queued on that
1399 * pool to guarantee non-reentrancy.
1400 */
1401 last_pool = get_work_pool(work);
1402 if (last_pool && last_pool != pwq->pool) {
1403 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001404
Tejun Heoc9178082013-03-12 11:30:04 -07001405 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001406
Tejun Heoc9178082013-03-12 11:30:04 -07001407 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001408
Tejun Heoc9178082013-03-12 11:30:04 -07001409 if (worker && worker->current_pwq->wq == wq) {
1410 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001411 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001412 /* meh... not running there, queue here */
1413 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001414 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001415 }
Tejun Heof3421792010-07-02 10:03:51 +02001416 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001417 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001418 }
1419
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001420 /*
1421 * pwq is determined and locked. For unbound pools, we could have
1422 * raced with pwq release and it could already be dead. If its
1423 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001424 * without another pwq replacing it in the numa_pwq_tbl or while
1425 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001426 * make forward-progress.
1427 */
1428 if (unlikely(!pwq->refcnt)) {
1429 if (wq->flags & WQ_UNBOUND) {
1430 spin_unlock(&pwq->pool->lock);
1431 cpu_relax();
1432 goto retry;
1433 }
1434 /* oops */
1435 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1436 wq->name, cpu);
1437 }
1438
Tejun Heo112202d2013-02-13 19:29:12 -08001439 /* pwq determined, queue */
1440 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001441
Dan Carpenterf5b25522012-04-13 22:06:58 +03001442 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001443 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001444 return;
1445 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001446
Tejun Heo112202d2013-02-13 19:29:12 -08001447 pwq->nr_in_flight[pwq->work_color]++;
1448 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001449
Tejun Heo112202d2013-02-13 19:29:12 -08001450 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001451 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001452 pwq->nr_active++;
1453 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001454 if (list_empty(worklist))
1455 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001456 } else {
1457 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001458 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001459 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001460
Tejun Heo112202d2013-02-13 19:29:12 -08001461 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001462
Tejun Heo112202d2013-02-13 19:29:12 -08001463 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001466/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001467 * queue_work_on - queue work on specific cpu
1468 * @cpu: CPU number to execute work on
1469 * @wq: workqueue to use
1470 * @work: work to queue
1471 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001472 * We queue the work to a specific CPU, the caller must ensure it
1473 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001474 *
1475 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001476 */
Tejun Heod4283e92012-08-03 10:30:44 -07001477bool queue_work_on(int cpu, struct workqueue_struct *wq,
1478 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001479{
Tejun Heod4283e92012-08-03 10:30:44 -07001480 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001481 unsigned long flags;
1482
1483 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001484
Tejun Heo22df02b2010-06-29 10:07:10 +02001485 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001486 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001487 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001488 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001489
1490 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001491 return ret;
1492}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001493EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494
Tejun Heod8e794d2012-08-03 10:30:45 -07001495void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
David Howells52bad642006-11-22 14:54:01 +00001497 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001499 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001500 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001502EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001504static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1505 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001507 struct timer_list *timer = &dwork->timer;
1508 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Tejun Heo757e1842017-03-06 15:33:42 -05001510 WARN_ON_ONCE(!wq);
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001511 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1512 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001513 WARN_ON_ONCE(timer_pending(timer));
1514 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001515
Tejun Heo8852aac2012-12-01 16:23:42 -08001516 /*
1517 * If @delay is 0, queue @dwork->work immediately. This is for
1518 * both optimization and correctness. The earliest @timer can
1519 * expire is on the closest next tick and delayed_work users depend
1520 * on that there's no such delay when @delay is 0.
1521 */
1522 if (!delay) {
1523 __queue_work(cpu, wq, &dwork->work);
1524 return;
1525 }
1526
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001527 timer_stats_timer_set_start_info(&dwork->timer);
1528
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001529 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001530 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001531 timer->expires = jiffies + delay;
1532
Tejun Heo041bd122016-02-09 16:11:26 -05001533 if (unlikely(cpu != WORK_CPU_UNBOUND))
1534 add_timer_on(timer, cpu);
1535 else
1536 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537}
1538
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001539/**
1540 * queue_delayed_work_on - queue work on specific CPU after delay
1541 * @cpu: CPU number to execute work on
1542 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001543 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001544 * @delay: number of jiffies to wait before queueing
1545 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001546 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001547 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1548 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001549 */
Tejun Heod4283e92012-08-03 10:30:44 -07001550bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1551 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001552{
David Howells52bad642006-11-22 14:54:01 +00001553 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001554 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001555 unsigned long flags;
1556
1557 /* read the comment in __queue_work() */
1558 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001559
Tejun Heo22df02b2010-06-29 10:07:10 +02001560 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001561 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001562 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001563 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001564
1565 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001566 return ret;
1567}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001568EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
Tejun Heoc8e55f32010-06-29 10:07:12 +02001570/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001571 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1572 * @cpu: CPU number to execute work on
1573 * @wq: workqueue to use
1574 * @dwork: work to queue
1575 * @delay: number of jiffies to wait before queueing
1576 *
1577 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1578 * modify @dwork's timer so that it expires after @delay. If @delay is
1579 * zero, @work is guaranteed to be scheduled immediately regardless of its
1580 * current state.
1581 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001582 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001583 * pending and its timer was modified.
1584 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001585 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001586 * See try_to_grab_pending() for details.
1587 */
1588bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1589 struct delayed_work *dwork, unsigned long delay)
1590{
1591 unsigned long flags;
1592 int ret;
1593
1594 do {
1595 ret = try_to_grab_pending(&dwork->work, true, &flags);
1596 } while (unlikely(ret == -EAGAIN));
1597
1598 if (likely(ret >= 0)) {
1599 __queue_delayed_work(cpu, wq, dwork, delay);
1600 local_irq_restore(flags);
1601 }
1602
1603 /* -ENOENT from try_to_grab_pending() becomes %true */
1604 return ret;
1605}
1606EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1607
1608/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001609 * worker_enter_idle - enter idle state
1610 * @worker: worker which is entering idle state
1611 *
1612 * @worker is entering idle state. Update stats and idle timer if
1613 * necessary.
1614 *
1615 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001616 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001617 */
1618static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001620 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Tejun Heo6183c002013-03-12 11:29:57 -07001622 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1623 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1624 (worker->hentry.next || worker->hentry.pprev)))
1625 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Lai Jiangshan051e1852014-07-22 13:03:02 +08001627 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001628 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001629 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001630 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001631
Tejun Heoc8e55f32010-06-29 10:07:12 +02001632 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001633 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001634
Tejun Heo628c78e2012-07-17 12:39:27 -07001635 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1636 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001637
Tejun Heo544ecf32012-05-14 15:04:50 -07001638 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001639 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001640 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001641 * nr_running, the warning may trigger spuriously. Check iff
1642 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001643 */
Tejun Heo24647572013-01-24 11:01:33 -08001644 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001645 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001646 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647}
1648
Tejun Heoc8e55f32010-06-29 10:07:12 +02001649/**
1650 * worker_leave_idle - leave idle state
1651 * @worker: worker which is leaving idle state
1652 *
1653 * @worker is leaving idle state. Update stats.
1654 *
1655 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001656 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001657 */
1658static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001660 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
Tejun Heo6183c002013-03-12 11:29:57 -07001662 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1663 return;
Tejun Heod302f012010-06-29 10:07:13 +02001664 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001665 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001666 list_del_init(&worker->entry);
1667}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001669static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001670{
1671 struct worker *worker;
1672
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001673 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001674 if (worker) {
1675 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001676 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001677 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001678 /* on creation a worker is in !idle && prep state */
1679 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001680 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001681 return worker;
1682}
1683
1684/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001685 * worker_attach_to_pool() - attach a worker to a pool
1686 * @worker: worker to be attached
1687 * @pool: the target pool
1688 *
1689 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1690 * cpu-binding of @worker are kept coordinated with the pool across
1691 * cpu-[un]hotplugs.
1692 */
1693static void worker_attach_to_pool(struct worker *worker,
1694 struct worker_pool *pool)
1695{
1696 mutex_lock(&pool->attach_mutex);
1697
1698 /*
1699 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1700 * online CPUs. It'll be re-applied when any of the CPUs come up.
1701 */
1702 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1703
1704 /*
1705 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1706 * stable across this function. See the comments above the
1707 * flag definition for details.
1708 */
1709 if (pool->flags & POOL_DISASSOCIATED)
1710 worker->flags |= WORKER_UNBOUND;
1711
1712 list_add_tail(&worker->node, &pool->workers);
1713
1714 mutex_unlock(&pool->attach_mutex);
1715}
1716
1717/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001718 * worker_detach_from_pool() - detach a worker from its pool
1719 * @worker: worker which is attached to its pool
1720 * @pool: the pool @worker is attached to
1721 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001722 * Undo the attaching which had been done in worker_attach_to_pool(). The
1723 * caller worker shouldn't access to the pool after detached except it has
1724 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001725 */
1726static void worker_detach_from_pool(struct worker *worker,
1727 struct worker_pool *pool)
1728{
1729 struct completion *detach_completion = NULL;
1730
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001731 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001732 list_del(&worker->node);
1733 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001734 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001735 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001736
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001737 /* clear leftover flags without pool->lock after it is detached */
1738 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1739
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001740 if (detach_completion)
1741 complete(detach_completion);
1742}
1743
1744/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001745 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001746 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001747 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001748 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001749 *
1750 * CONTEXT:
1751 * Might sleep. Does GFP_KERNEL allocations.
1752 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001753 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001754 * Pointer to the newly created worker.
1755 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001756static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001757{
Tejun Heoc34056a2010-06-29 10:07:11 +02001758 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001759 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001760 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001761
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001762 /* ID is needed to determine kthread name */
1763 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001764 if (id < 0)
1765 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001766
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001767 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001768 if (!worker)
1769 goto fail;
1770
Tejun Heobd7bdd42012-07-12 14:46:37 -07001771 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001772 worker->id = id;
1773
Tejun Heo29c91e92013-03-12 11:30:03 -07001774 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001775 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1776 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001777 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001778 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1779
Tejun Heof3f90ad2013-04-01 11:23:34 -07001780 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001781 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 if (IS_ERR(worker->task))
1783 goto fail;
1784
Oleg Nesterov91151222013-11-14 12:56:18 +01001785 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001786 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001787
Lai Jiangshanda028462014-05-20 17:46:31 +08001788 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001789 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001790
Lai Jiangshan051e1852014-07-22 13:03:02 +08001791 /* start the newly created worker */
1792 spin_lock_irq(&pool->lock);
1793 worker->pool->nr_workers++;
1794 worker_enter_idle(worker);
1795 wake_up_process(worker->task);
1796 spin_unlock_irq(&pool->lock);
1797
Tejun Heoc34056a2010-06-29 10:07:11 +02001798 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001799
Tejun Heoc34056a2010-06-29 10:07:11 +02001800fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001801 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001802 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 kfree(worker);
1804 return NULL;
1805}
1806
1807/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001808 * destroy_worker - destroy a workqueue worker
1809 * @worker: worker to be destroyed
1810 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001811 * Destroy @worker and adjust @pool stats accordingly. The worker should
1812 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001813 *
1814 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001815 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001816 */
1817static void destroy_worker(struct worker *worker)
1818{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001819 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001820
Tejun Heocd549682013-03-13 19:47:39 -07001821 lockdep_assert_held(&pool->lock);
1822
Tejun Heoc34056a2010-06-29 10:07:11 +02001823 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001824 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001825 WARN_ON(!list_empty(&worker->scheduled)) ||
1826 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001827 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001828
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001829 pool->nr_workers--;
1830 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001831
Tejun Heoc8e55f32010-06-29 10:07:12 +02001832 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001833 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001834 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001835}
1836
Tejun Heo63d95a92012-07-12 14:46:37 -07001837static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001838{
Tejun Heo63d95a92012-07-12 14:46:37 -07001839 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001840
Tejun Heod565ed62013-01-24 11:01:33 -08001841 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001842
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001843 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001844 struct worker *worker;
1845 unsigned long expires;
1846
1847 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001848 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001849 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1850
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001851 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001852 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001853 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001854 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001855
1856 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001857 }
1858
Tejun Heod565ed62013-01-24 11:01:33 -08001859 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001860}
1861
Tejun Heo493a1722013-03-12 11:29:59 -07001862static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001863{
Tejun Heo112202d2013-02-13 19:29:12 -08001864 struct pool_workqueue *pwq = get_work_pwq(work);
1865 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001866
Tejun Heo2e109a22013-03-13 19:47:40 -07001867 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001868
Tejun Heo493008a2013-03-12 11:30:03 -07001869 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001870 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001871
1872 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001873 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001874 /*
1875 * If @pwq is for an unbound wq, its base ref may be put at
1876 * any time due to an attribute change. Pin @pwq until the
1877 * rescuer is done with it.
1878 */
1879 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001880 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001881 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001882 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001883}
1884
Tejun Heo706026c2013-01-24 11:01:34 -08001885static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001886{
Tejun Heo63d95a92012-07-12 14:46:37 -07001887 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001888 struct work_struct *work;
1889
Tejun Heob2d82902014-12-08 12:39:16 -05001890 spin_lock_irq(&pool->lock);
1891 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001892
Tejun Heo63d95a92012-07-12 14:46:37 -07001893 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001894 /*
1895 * We've been trying to create a new worker but
1896 * haven't been successful. We might be hitting an
1897 * allocation deadlock. Send distress signals to
1898 * rescuers.
1899 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001900 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001901 send_mayday(work);
1902 }
1903
Tejun Heob2d82902014-12-08 12:39:16 -05001904 spin_unlock(&wq_mayday_lock);
1905 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001906
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001908}
1909
1910/**
1911 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001912 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001914 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 * have at least one idle worker on return from this function. If
1916 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 * possible allocation deadlock.
1919 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001920 * On return, need_to_create_worker() is guaranteed to be %false and
1921 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001922 *
1923 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001924 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 * multiple times. Does GFP_KERNEL allocations. Called only from
1926 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001927 */
Tejun Heo29187a92015-01-16 14:21:16 -05001928static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001929__releases(&pool->lock)
1930__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001931{
Tejun Heoe22bee72010-06-29 10:07:14 +02001932restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001933 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001934
Tejun Heoe22bee72010-06-29 10:07:14 +02001935 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001936 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001937
1938 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001939 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001940 break;
1941
Lai Jiangshane212f362014-06-03 15:32:17 +08001942 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001943
Tejun Heo63d95a92012-07-12 14:46:37 -07001944 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 break;
1946 }
1947
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001949 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001950 /*
1951 * This is necessary even after a new worker was just successfully
1952 * created as @pool->lock was dropped and the new worker might have
1953 * already become busy.
1954 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001955 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001957}
1958
1959/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001960 * manage_workers - manage worker pool
1961 * @worker: self
1962 *
Tejun Heo706026c2013-01-24 11:01:34 -08001963 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001965 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 *
1967 * The caller can safely start processing works on false return. On
1968 * true return, it's guaranteed that need_to_create_worker() is false
1969 * and may_start_working() is true.
1970 *
1971 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001972 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 * multiple times. Does GFP_KERNEL allocations.
1974 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001975 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001976 * %false if the pool doesn't need management and the caller can safely
1977 * start processing works, %true if management function was performed and
1978 * the conditions that the caller verified before calling the function may
1979 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 */
1981static bool manage_workers(struct worker *worker)
1982{
Tejun Heo63d95a92012-07-12 14:46:37 -07001983 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001984
Tejun Heo43a980a2017-10-09 08:04:13 -07001985 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05001986 return false;
Tejun Heo43a980a2017-10-09 08:04:13 -07001987
1988 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001989 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001990
Tejun Heo29187a92015-01-16 14:21:16 -05001991 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001992
Tejun Heo2607d7a2015-03-09 09:22:28 -04001993 pool->manager = NULL;
Tejun Heo43a980a2017-10-09 08:04:13 -07001994 pool->flags &= ~POOL_MANAGER_ACTIVE;
1995 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05001996 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02001997}
1998
Tejun Heoa62428c2010-06-29 10:07:10 +02001999/**
2000 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002001 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002002 * @work: work to process
2003 *
2004 * Process @work. This function contains all the logics necessary to
2005 * process a single work including synchronization against and
2006 * interaction with other workers on the same cpu, queueing and
2007 * flushing. As long as context requirement is met, any worker can
2008 * call this function to process a work.
2009 *
2010 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002011 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002012 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002013static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002014__releases(&pool->lock)
2015__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002016{
Tejun Heo112202d2013-02-13 19:29:12 -08002017 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002018 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002019 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002020 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002021 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002022#ifdef CONFIG_LOCKDEP
2023 /*
2024 * It is permissible to free the struct work_struct from
2025 * inside the function that is called from it, this we need to
2026 * take into account for lockdep too. To avoid bogus "held
2027 * lock freed" warnings as well as problems when looking into
2028 * work->lockdep_map, make a copy and use that here.
2029 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002030 struct lockdep_map lockdep_map;
2031
2032 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002033#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002034 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002035 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002036 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002037
Tejun Heo7e116292010-06-29 10:07:13 +02002038 /*
2039 * A single work shouldn't be executed concurrently by
2040 * multiple workers on a single cpu. Check whether anyone is
2041 * already processing the work. If so, defer the work to the
2042 * currently executing one.
2043 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002044 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002045 if (unlikely(collision)) {
2046 move_linked_works(work, &collision->scheduled, NULL);
2047 return;
2048 }
2049
Tejun Heo8930cab2012-08-03 10:30:45 -07002050 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002051 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002052 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002053 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002054 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002055 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002056 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002057
Tejun Heoa62428c2010-06-29 10:07:10 +02002058 list_del_init(&work->entry);
2059
Tejun Heo649027d2010-06-29 10:07:14 +02002060 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002061 * CPU intensive works don't participate in concurrency management.
2062 * They're the scheduler's responsibility. This takes @worker out
2063 * of concurrency management and the next code block will chain
2064 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002065 */
2066 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002067 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002068
Tejun Heo974271c2012-07-12 14:46:37 -07002069 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002070 * Wake up another worker if necessary. The condition is always
2071 * false for normal per-cpu workers since nr_running would always
2072 * be >= 1 at this point. This is used to chain execution of the
2073 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002074 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002075 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002076 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002077 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002078
Tejun Heo8930cab2012-08-03 10:30:45 -07002079 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002080 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002081 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002082 * PENDING and queued state changes happen together while IRQ is
2083 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002084 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002085 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002086
Tejun Heod565ed62013-01-24 11:01:33 -08002087 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002088
Tejun Heo112202d2013-02-13 19:29:12 -08002089 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002090 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002091 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002092 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002093 /*
2094 * While we must be careful to not use "work" after this, the trace
2095 * point will only record its address.
2096 */
2097 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002098 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002099 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002100
2101 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002102 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2103 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002104 current->comm, preempt_count(), task_pid_nr(current),
2105 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002106 debug_show_held_locks(current);
2107 dump_stack();
2108 }
2109
Tejun Heob22ce272013-08-28 17:33:37 -04002110 /*
2111 * The following prevents a kworker from hogging CPU on !PREEMPT
2112 * kernels, where a requeueing work item waiting for something to
2113 * happen could deadlock with stop_machine as such work item could
2114 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002115 * stop_machine. At the same time, report a quiescent RCU state so
2116 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002117 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002118 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002119
Tejun Heod565ed62013-01-24 11:01:33 -08002120 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002121
Tejun Heofb0e7be2010-06-29 10:07:15 +02002122 /* clear cpu intensive status */
2123 if (unlikely(cpu_intensive))
2124 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2125
Tejun Heoa62428c2010-06-29 10:07:10 +02002126 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002127 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002128 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002129 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002130 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002131 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002132 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002133}
2134
Tejun Heoaffee4b2010-06-29 10:07:12 +02002135/**
2136 * process_scheduled_works - process scheduled works
2137 * @worker: self
2138 *
2139 * Process all scheduled works. Please note that the scheduled list
2140 * may change while processing a work, so this function repeatedly
2141 * fetches a work from the top and executes it.
2142 *
2143 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002144 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002145 * multiple times.
2146 */
2147static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002149 while (!list_empty(&worker->scheduled)) {
2150 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002152 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154}
2155
Tejun Heo4690c4a2010-06-29 10:07:10 +02002156/**
2157 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002158 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002159 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002160 * The worker thread function. All workers belong to a worker_pool -
2161 * either a per-cpu one or dynamic unbound one. These workers process all
2162 * work items regardless of their specific target workqueue. The only
2163 * exception is work items which belong to workqueues with a rescuer which
2164 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002165 *
2166 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002167 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002168static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169{
Tejun Heoc34056a2010-06-29 10:07:11 +02002170 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002171 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172
Tejun Heoe22bee72010-06-29 10:07:14 +02002173 /* tell the scheduler that this is a workqueue worker */
2174 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002175woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002176 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002177
Tejun Heoa9ab7752013-03-19 13:45:21 -07002178 /* am I supposed to die? */
2179 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002180 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002181 WARN_ON_ONCE(!list_empty(&worker->entry));
2182 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002183
2184 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002185 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002186 worker_detach_from_pool(worker, pool);
2187 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002188 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002190
Tejun Heoc8e55f32010-06-29 10:07:12 +02002191 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002192recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002193 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002194 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002195 goto sleep;
2196
2197 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002198 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002199 goto recheck;
2200
Tejun Heoc8e55f32010-06-29 10:07:12 +02002201 /*
2202 * ->scheduled list can only be filled while a worker is
2203 * preparing to process a work or actually processing it.
2204 * Make sure nobody diddled with it while I was sleeping.
2205 */
Tejun Heo6183c002013-03-12 11:29:57 -07002206 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002207
Tejun Heoe22bee72010-06-29 10:07:14 +02002208 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002209 * Finish PREP stage. We're guaranteed to have at least one idle
2210 * worker or that someone else has already assumed the manager
2211 * role. This is where @worker starts participating in concurrency
2212 * management if applicable and concurrency management is restored
2213 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002214 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002215 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002216
2217 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002218 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002219 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002220 struct work_struct, entry);
2221
Tejun Heo82607adc2015-12-08 11:28:04 -05002222 pool->watchdog_ts = jiffies;
2223
Tejun Heoc8e55f32010-06-29 10:07:12 +02002224 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2225 /* optimization path, not strictly necessary */
2226 process_one_work(worker, work);
2227 if (unlikely(!list_empty(&worker->scheduled)))
2228 process_scheduled_works(worker);
2229 } else {
2230 move_linked_works(work, &worker->scheduled, NULL);
2231 process_scheduled_works(worker);
2232 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002233 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002234
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002235 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002236sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002237 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002238 * pool->lock is held and there's no work to process and no need to
2239 * manage, sleep. Workers are woken up only while holding
2240 * pool->lock or from local cpu, so setting the current state
2241 * before releasing pool->lock is enough to prevent losing any
2242 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002243 */
2244 worker_enter_idle(worker);
2245 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002246 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002247 schedule();
2248 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249}
2250
Tejun Heoe22bee72010-06-29 10:07:14 +02002251/**
2252 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002253 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002254 *
2255 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002256 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002257 *
Tejun Heo706026c2013-01-24 11:01:34 -08002258 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002259 * worker which uses GFP_KERNEL allocation which has slight chance of
2260 * developing into deadlock if some works currently on the same queue
2261 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2262 * the problem rescuer solves.
2263 *
Tejun Heo706026c2013-01-24 11:01:34 -08002264 * When such condition is possible, the pool summons rescuers of all
2265 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002266 * those works so that forward progress can be guaranteed.
2267 *
2268 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002269 *
2270 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002271 */
Tejun Heo111c2252013-01-17 17:16:24 -08002272static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002273{
Tejun Heo111c2252013-01-17 17:16:24 -08002274 struct worker *rescuer = __rescuer;
2275 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002276 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002277 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002278
2279 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002280
2281 /*
2282 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2283 * doesn't participate in concurrency management.
2284 */
2285 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002286repeat:
2287 set_current_state(TASK_INTERRUPTIBLE);
2288
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002289 /*
2290 * By the time the rescuer is requested to stop, the workqueue
2291 * shouldn't have any work pending, but @wq->maydays may still have
2292 * pwq(s) queued. This can happen by non-rescuer workers consuming
2293 * all the work items before the rescuer got to them. Go through
2294 * @wq->maydays processing before acting on should_stop so that the
2295 * list is always empty on exit.
2296 */
2297 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002298
Tejun Heo493a1722013-03-12 11:29:59 -07002299 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002300 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002301
2302 while (!list_empty(&wq->maydays)) {
2303 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2304 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002305 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002306 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002307 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002308
2309 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002310 list_del_init(&pwq->mayday_node);
2311
Tejun Heo2e109a22013-03-13 19:47:40 -07002312 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002313
Lai Jiangshan51697d392014-05-20 17:46:36 +08002314 worker_attach_to_pool(rescuer, pool);
2315
2316 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002317 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002318
2319 /*
2320 * Slurp in all works issued via this workqueue and
2321 * process'em.
2322 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002323 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002324 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2325 if (get_work_pwq(work) == pwq) {
2326 if (first)
2327 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002328 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002329 }
2330 first = false;
2331 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002332
NeilBrown008847f2014-12-08 12:39:16 -05002333 if (!list_empty(scheduled)) {
2334 process_scheduled_works(rescuer);
2335
2336 /*
2337 * The above execution of rescued work items could
2338 * have created more to rescue through
2339 * pwq_activate_first_delayed() or chained
2340 * queueing. Let's put @pwq back on mayday list so
2341 * that such back-to-back work items, which may be
2342 * being used to relieve memory pressure, don't
2343 * incur MAYDAY_INTERVAL delay inbetween.
2344 */
2345 if (need_to_create_worker(pool)) {
2346 spin_lock(&wq_mayday_lock);
Tejun Heo4f5b0c72019-09-25 06:59:15 -07002347 /*
2348 * Queue iff we aren't racing destruction
2349 * and somebody else hasn't queued it already.
2350 */
2351 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2352 get_pwq(pwq);
2353 list_add_tail(&pwq->mayday_node, &wq->maydays);
2354 }
NeilBrown008847f2014-12-08 12:39:16 -05002355 spin_unlock(&wq_mayday_lock);
2356 }
2357 }
Tejun Heo75769582011-02-14 14:04:46 +01002358
2359 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002360 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002361 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002362 */
2363 put_pwq(pwq);
2364
2365 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002366 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002367 * regular worker; otherwise, we end up with 0 concurrency
2368 * and stalling the execution.
2369 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002370 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002371 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002372
Lai Jiangshanb3104102013-02-19 12:17:02 -08002373 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002374 spin_unlock_irq(&pool->lock);
2375
2376 worker_detach_from_pool(rescuer, pool);
2377
2378 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002379 }
2380
Tejun Heo2e109a22013-03-13 19:47:40 -07002381 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002382
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002383 if (should_stop) {
2384 __set_current_state(TASK_RUNNING);
2385 rescuer->task->flags &= ~PF_WQ_WORKER;
2386 return 0;
2387 }
2388
Tejun Heo111c2252013-01-17 17:16:24 -08002389 /* rescuers should never participate in concurrency management */
2390 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 schedule();
2392 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393}
2394
Tejun Heofca839c2015-12-07 10:58:57 -05002395/**
2396 * check_flush_dependency - check for flush dependency sanity
2397 * @target_wq: workqueue being flushed
2398 * @target_work: work item being flushed (NULL for workqueue flushes)
2399 *
2400 * %current is trying to flush the whole @target_wq or @target_work on it.
2401 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2402 * reclaiming memory or running on a workqueue which doesn't have
2403 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2404 * a deadlock.
2405 */
2406static void check_flush_dependency(struct workqueue_struct *target_wq,
2407 struct work_struct *target_work)
2408{
2409 work_func_t target_func = target_work ? target_work->func : NULL;
2410 struct worker *worker;
2411
2412 if (target_wq->flags & WQ_MEM_RECLAIM)
2413 return;
2414
2415 worker = current_wq_worker();
2416
2417 WARN_ONCE(current->flags & PF_MEMALLOC,
2418 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2419 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002420 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2421 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002422 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2423 worker->current_pwq->wq->name, worker->current_func,
2424 target_wq->name, target_func);
2425}
2426
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002427struct wq_barrier {
2428 struct work_struct work;
2429 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002430 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002431};
2432
2433static void wq_barrier_func(struct work_struct *work)
2434{
2435 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2436 complete(&barr->done);
2437}
2438
Tejun Heo4690c4a2010-06-29 10:07:10 +02002439/**
2440 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002441 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002442 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002443 * @target: target work to attach @barr to
2444 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002445 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002446 * @barr is linked to @target such that @barr is completed only after
2447 * @target finishes execution. Please note that the ordering
2448 * guarantee is observed only with respect to @target and on the local
2449 * cpu.
2450 *
2451 * Currently, a queued barrier can't be canceled. This is because
2452 * try_to_grab_pending() can't determine whether the work to be
2453 * grabbed is at the head of the queue and thus can't clear LINKED
2454 * flag of the previous work while there must be a valid next work
2455 * after a work with LINKED flag set.
2456 *
2457 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002458 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002459 *
2460 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002461 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002462 */
Tejun Heo112202d2013-02-13 19:29:12 -08002463static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002464 struct wq_barrier *barr,
2465 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002466{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002467 struct list_head *head;
2468 unsigned int linked = 0;
2469
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002470 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002471 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002472 * as we know for sure that this will not trigger any of the
2473 * checks and call back into the fixup functions where we
2474 * might deadlock.
2475 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002476 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002477 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002478 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002479 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002480
Tejun Heoaffee4b2010-06-29 10:07:12 +02002481 /*
2482 * If @target is currently being executed, schedule the
2483 * barrier to the worker; otherwise, put it after @target.
2484 */
2485 if (worker)
2486 head = worker->scheduled.next;
2487 else {
2488 unsigned long *bits = work_data_bits(target);
2489
2490 head = target->entry.next;
2491 /* there can already be other linked works, inherit and set */
2492 linked = *bits & WORK_STRUCT_LINKED;
2493 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2494 }
2495
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002496 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002497 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002498 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002499}
2500
Tejun Heo73f53c42010-06-29 10:07:11 +02002501/**
Tejun Heo112202d2013-02-13 19:29:12 -08002502 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002503 * @wq: workqueue being flushed
2504 * @flush_color: new flush color, < 0 for no-op
2505 * @work_color: new work color, < 0 for no-op
2506 *
Tejun Heo112202d2013-02-13 19:29:12 -08002507 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002508 *
Tejun Heo112202d2013-02-13 19:29:12 -08002509 * If @flush_color is non-negative, flush_color on all pwqs should be
2510 * -1. If no pwq has in-flight commands at the specified color, all
2511 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2512 * has in flight commands, its pwq->flush_color is set to
2513 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002514 * wakeup logic is armed and %true is returned.
2515 *
2516 * The caller should have initialized @wq->first_flusher prior to
2517 * calling this function with non-negative @flush_color. If
2518 * @flush_color is negative, no flush color update is done and %false
2519 * is returned.
2520 *
Tejun Heo112202d2013-02-13 19:29:12 -08002521 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002522 * work_color which is previous to @work_color and all will be
2523 * advanced to @work_color.
2524 *
2525 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002526 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002527 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002528 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002529 * %true if @flush_color >= 0 and there's something to flush. %false
2530 * otherwise.
2531 */
Tejun Heo112202d2013-02-13 19:29:12 -08002532static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002533 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534{
Tejun Heo73f53c42010-06-29 10:07:11 +02002535 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002536 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002537
Tejun Heo73f53c42010-06-29 10:07:11 +02002538 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002539 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002540 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002541 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002542
Tejun Heo49e3cf42013-03-12 11:29:58 -07002543 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002544 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002545
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002546 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002547
2548 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002549 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002550
Tejun Heo112202d2013-02-13 19:29:12 -08002551 if (pwq->nr_in_flight[flush_color]) {
2552 pwq->flush_color = flush_color;
2553 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002554 wait = true;
2555 }
2556 }
2557
2558 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002559 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002560 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002561 }
2562
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002563 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002564 }
2565
Tejun Heo112202d2013-02-13 19:29:12 -08002566 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002567 complete(&wq->first_flusher->done);
2568
2569 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570}
2571
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002572/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002574 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002576 * This function sleeps until all work items which were queued on entry
2577 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002579void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580{
Tejun Heo73f53c42010-06-29 10:07:11 +02002581 struct wq_flusher this_flusher = {
2582 .list = LIST_HEAD_INIT(this_flusher.list),
2583 .flush_color = -1,
2584 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2585 };
2586 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002587
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002588 lock_map_acquire(&wq->lockdep_map);
2589 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002590
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002591 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002592
2593 /*
2594 * Start-to-wait phase
2595 */
2596 next_color = work_next_color(wq->work_color);
2597
2598 if (next_color != wq->flush_color) {
2599 /*
2600 * Color space is not full. The current work_color
2601 * becomes our flush_color and work_color is advanced
2602 * by one.
2603 */
Tejun Heo6183c002013-03-12 11:29:57 -07002604 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002605 this_flusher.flush_color = wq->work_color;
2606 wq->work_color = next_color;
2607
2608 if (!wq->first_flusher) {
2609 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002610 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002611
2612 wq->first_flusher = &this_flusher;
2613
Tejun Heo112202d2013-02-13 19:29:12 -08002614 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002615 wq->work_color)) {
2616 /* nothing to flush, done */
2617 wq->flush_color = next_color;
2618 wq->first_flusher = NULL;
2619 goto out_unlock;
2620 }
2621 } else {
2622 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002623 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002624 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002625 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002626 }
2627 } else {
2628 /*
2629 * Oops, color space is full, wait on overflow queue.
2630 * The next flush completion will assign us
2631 * flush_color and transfer to flusher_queue.
2632 */
2633 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2634 }
2635
Tejun Heofca839c2015-12-07 10:58:57 -05002636 check_flush_dependency(wq, NULL);
2637
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002638 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002639
2640 wait_for_completion(&this_flusher.done);
2641
2642 /*
2643 * Wake-up-and-cascade phase
2644 *
2645 * First flushers are responsible for cascading flushes and
2646 * handling overflow. Non-first flushers can simply return.
2647 */
2648 if (wq->first_flusher != &this_flusher)
2649 return;
2650
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002651 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002652
Tejun Heo4ce48b32010-07-02 10:03:51 +02002653 /* we might have raced, check again with mutex held */
2654 if (wq->first_flusher != &this_flusher)
2655 goto out_unlock;
2656
Tejun Heo73f53c42010-06-29 10:07:11 +02002657 wq->first_flusher = NULL;
2658
Tejun Heo6183c002013-03-12 11:29:57 -07002659 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2660 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002661
2662 while (true) {
2663 struct wq_flusher *next, *tmp;
2664
2665 /* complete all the flushers sharing the current flush color */
2666 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2667 if (next->flush_color != wq->flush_color)
2668 break;
2669 list_del_init(&next->list);
2670 complete(&next->done);
2671 }
2672
Tejun Heo6183c002013-03-12 11:29:57 -07002673 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2674 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002675
2676 /* this flush_color is finished, advance by one */
2677 wq->flush_color = work_next_color(wq->flush_color);
2678
2679 /* one color has been freed, handle overflow queue */
2680 if (!list_empty(&wq->flusher_overflow)) {
2681 /*
2682 * Assign the same color to all overflowed
2683 * flushers, advance work_color and append to
2684 * flusher_queue. This is the start-to-wait
2685 * phase for these overflowed flushers.
2686 */
2687 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2688 tmp->flush_color = wq->work_color;
2689
2690 wq->work_color = work_next_color(wq->work_color);
2691
2692 list_splice_tail_init(&wq->flusher_overflow,
2693 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002694 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002695 }
2696
2697 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002698 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002699 break;
2700 }
2701
2702 /*
2703 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002704 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002705 */
Tejun Heo6183c002013-03-12 11:29:57 -07002706 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2707 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002708
2709 list_del_init(&next->list);
2710 wq->first_flusher = next;
2711
Tejun Heo112202d2013-02-13 19:29:12 -08002712 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002713 break;
2714
2715 /*
2716 * Meh... this color is already done, clear first
2717 * flusher and repeat cascading.
2718 */
2719 wq->first_flusher = NULL;
2720 }
2721
2722out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002723 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002725EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002727/**
2728 * drain_workqueue - drain a workqueue
2729 * @wq: workqueue to drain
2730 *
2731 * Wait until the workqueue becomes empty. While draining is in progress,
2732 * only chain queueing is allowed. IOW, only currently pending or running
2733 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002734 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002735 * by the depth of chaining and should be relatively short. Whine if it
2736 * takes too long.
2737 */
2738void drain_workqueue(struct workqueue_struct *wq)
2739{
2740 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002741 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002742
2743 /*
2744 * __queue_work() needs to test whether there are drainers, is much
2745 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002746 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002747 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002748 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002749 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002750 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002751 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752reflush:
2753 flush_workqueue(wq);
2754
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002755 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002756
Tejun Heo49e3cf42013-03-12 11:29:58 -07002757 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002758 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002759
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002760 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002761 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002762 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002763
2764 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002765 continue;
2766
2767 if (++flush_cnt == 10 ||
2768 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002769 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002770 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002771
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002772 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002773 goto reflush;
2774 }
2775
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002776 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002777 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002778 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002779}
2780EXPORT_SYMBOL_GPL(drain_workqueue);
2781
Tejun Heo606a5022012-08-20 14:51:23 -07002782static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002783{
2784 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002785 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002786 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002787
2788 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002789
Tejun Heofa1b54e2013-03-12 11:30:00 -07002790 local_irq_disable();
2791 pool = get_work_pool(work);
2792 if (!pool) {
2793 local_irq_enable();
2794 return false;
2795 }
2796
2797 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002798 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002799 pwq = get_work_pwq(work);
2800 if (pwq) {
2801 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002802 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002803 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002804 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002805 if (!worker)
2806 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002807 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002808 }
Tejun Heobaf59022010-09-16 10:42:16 +02002809
Tejun Heofca839c2015-12-07 10:58:57 -05002810 check_flush_dependency(pwq->wq, work);
2811
Tejun Heo112202d2013-02-13 19:29:12 -08002812 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002813 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002814
Tejun Heoe1594892011-01-09 23:32:15 +01002815 /*
2816 * If @max_active is 1 or rescuer is in use, flushing another work
2817 * item on the same workqueue may lead to deadlock. Make sure the
2818 * flusher is not running on the same workqueue by verifying write
2819 * access.
2820 */
Tejun Heo493008a2013-03-12 11:30:03 -07002821 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002822 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002823 else
Tejun Heo112202d2013-02-13 19:29:12 -08002824 lock_map_acquire_read(&pwq->wq->lockdep_map);
2825 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002826
Tejun Heobaf59022010-09-16 10:42:16 +02002827 return true;
2828already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002829 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002830 return false;
2831}
2832
Oleg Nesterovdb700892008-07-25 01:47:49 -07002833/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002834 * flush_work - wait for a work to finish executing the last queueing instance
2835 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002836 *
Tejun Heo606a5022012-08-20 14:51:23 -07002837 * Wait until @work has finished execution. @work is guaranteed to be idle
2838 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002839 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002840 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002841 * %true if flush_work() waited for the work to finish execution,
2842 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002843 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002844bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002845{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002846 struct wq_barrier barr;
2847
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002848 lock_map_acquire(&work->lockdep_map);
2849 lock_map_release(&work->lockdep_map);
2850
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002851 if (start_flush_work(work, &barr)) {
2852 wait_for_completion(&barr.done);
2853 destroy_work_on_stack(&barr.work);
2854 return true;
2855 } else {
2856 return false;
2857 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002858}
2859EXPORT_SYMBOL_GPL(flush_work);
2860
Tejun Heo8603e1b32015-03-05 08:04:13 -05002861struct cwt_wait {
2862 wait_queue_t wait;
2863 struct work_struct *work;
2864};
2865
2866static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2867{
2868 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2869
2870 if (cwait->work != key)
2871 return 0;
2872 return autoremove_wake_function(wait, mode, sync, key);
2873}
2874
Tejun Heo36e227d2012-08-03 10:30:46 -07002875static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002876{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002877 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002878 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002879 int ret;
2880
2881 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002882 ret = try_to_grab_pending(work, is_dwork, &flags);
2883 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002884 * If someone else is already canceling, wait for it to
2885 * finish. flush_work() doesn't work for PREEMPT_NONE
2886 * because we may get scheduled between @work's completion
2887 * and the other canceling task resuming and clearing
2888 * CANCELING - flush_work() will return false immediately
2889 * as @work is no longer busy, try_to_grab_pending() will
2890 * return -ENOENT as @work is still being canceled and the
2891 * other canceling task won't be able to clear CANCELING as
2892 * we're hogging the CPU.
2893 *
2894 * Let's wait for completion using a waitqueue. As this
2895 * may lead to the thundering herd problem, use a custom
2896 * wake function which matches @work along with exclusive
2897 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002898 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002899 if (unlikely(ret == -ENOENT)) {
2900 struct cwt_wait cwait;
2901
2902 init_wait(&cwait.wait);
2903 cwait.wait.func = cwt_wakefn;
2904 cwait.work = work;
2905
2906 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2907 TASK_UNINTERRUPTIBLE);
2908 if (work_is_canceling(work))
2909 schedule();
2910 finish_wait(&cancel_waitq, &cwait.wait);
2911 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002912 } while (unlikely(ret < 0));
2913
Tejun Heobbb68df2012-08-03 10:30:46 -07002914 /* tell other tasks trying to grab @work to back off */
2915 mark_work_canceling(work);
2916 local_irq_restore(flags);
2917
Tejun Heo606a5022012-08-20 14:51:23 -07002918 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002919 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002920
2921 /*
2922 * Paired with prepare_to_wait() above so that either
2923 * waitqueue_active() is visible here or !work_is_canceling() is
2924 * visible there.
2925 */
2926 smp_mb();
2927 if (waitqueue_active(&cancel_waitq))
2928 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2929
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002930 return ret;
2931}
2932
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002933/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002934 * cancel_work_sync - cancel a work and wait for it to finish
2935 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002936 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002937 * Cancel @work and wait for its execution to finish. This function
2938 * can be used even if the work re-queues itself or migrates to
2939 * another workqueue. On return from this function, @work is
2940 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002941 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002942 * cancel_work_sync(&delayed_work->work) must not be used for
2943 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002944 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002945 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002946 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002947 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002948 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002949 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002950 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002951bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002952{
Tejun Heo36e227d2012-08-03 10:30:46 -07002953 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002954}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002955EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002956
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002957/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002958 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2959 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002960 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002961 * Delayed timer is cancelled and the pending work is queued for
2962 * immediate execution. Like flush_work(), this function only
2963 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002964 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002965 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002966 * %true if flush_work() waited for the work to finish execution,
2967 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002968 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002969bool flush_delayed_work(struct delayed_work *dwork)
2970{
Tejun Heo8930cab2012-08-03 10:30:45 -07002971 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002972 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002973 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002974 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002975 return flush_work(&dwork->work);
2976}
2977EXPORT_SYMBOL(flush_delayed_work);
2978
Jens Axboef72b8792016-08-24 15:51:50 -06002979static bool __cancel_work(struct work_struct *work, bool is_dwork)
2980{
2981 unsigned long flags;
2982 int ret;
2983
2984 do {
2985 ret = try_to_grab_pending(work, is_dwork, &flags);
2986 } while (unlikely(ret == -EAGAIN));
2987
2988 if (unlikely(ret < 0))
2989 return false;
2990
2991 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
2992 local_irq_restore(flags);
2993 return ret;
2994}
2995
2996/*
2997 * See cancel_delayed_work()
2998 */
2999bool cancel_work(struct work_struct *work)
3000{
3001 return __cancel_work(work, false);
3002}
3003
Tejun Heo401a8d02010-09-16 10:36:00 +02003004/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003005 * cancel_delayed_work - cancel a delayed work
3006 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003007 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003008 * Kill off a pending delayed_work.
3009 *
3010 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3011 * pending.
3012 *
3013 * Note:
3014 * The work callback function may still be running on return, unless
3015 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3016 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003017 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003018 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003019 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003020bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003021{
Jens Axboef72b8792016-08-24 15:51:50 -06003022 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003023}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003024EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003025
3026/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003027 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3028 * @dwork: the delayed work cancel
3029 *
3030 * This is cancel_work_sync() for delayed works.
3031 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003032 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003033 * %true if @dwork was pending, %false otherwise.
3034 */
3035bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003036{
Tejun Heo36e227d2012-08-03 10:30:46 -07003037 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003038}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003039EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003041/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003042 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003043 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003044 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003045 * schedule_on_each_cpu() executes @func on each online CPU using the
3046 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003047 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003048 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003049 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003050 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003051 */
David Howells65f27f32006-11-22 14:55:48 +00003052int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003053{
3054 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003055 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003056
Andrew Mortonb6136772006-06-25 05:47:49 -07003057 works = alloc_percpu(struct work_struct);
3058 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003059 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003060
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003061 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003062
Christoph Lameter15316ba2006-01-08 01:00:43 -08003063 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003064 struct work_struct *work = per_cpu_ptr(works, cpu);
3065
3066 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003067 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003068 }
Tejun Heo93981802009-11-17 14:06:20 -08003069
3070 for_each_online_cpu(cpu)
3071 flush_work(per_cpu_ptr(works, cpu));
3072
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003073 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003074 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003075 return 0;
3076}
3077
Alan Sterneef6a7d2010-02-12 17:39:21 +09003078/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003079 * execute_in_process_context - reliably execute the routine with user context
3080 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003081 * @ew: guaranteed storage for the execute work structure (must
3082 * be available when the work executes)
3083 *
3084 * Executes the function immediately if process context is available,
3085 * otherwise schedules the function for delayed execution.
3086 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003087 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003088 * 1 - function was scheduled for execution
3089 */
David Howells65f27f32006-11-22 14:55:48 +00003090int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003091{
3092 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003093 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003094 return 0;
3095 }
3096
David Howells65f27f32006-11-22 14:55:48 +00003097 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003098 schedule_work(&ew->work);
3099
3100 return 1;
3101}
3102EXPORT_SYMBOL_GPL(execute_in_process_context);
3103
Tejun Heo7a4e3442013-03-12 11:30:00 -07003104/**
3105 * free_workqueue_attrs - free a workqueue_attrs
3106 * @attrs: workqueue_attrs to free
3107 *
3108 * Undo alloc_workqueue_attrs().
3109 */
3110void free_workqueue_attrs(struct workqueue_attrs *attrs)
3111{
3112 if (attrs) {
3113 free_cpumask_var(attrs->cpumask);
3114 kfree(attrs);
3115 }
3116}
3117
3118/**
3119 * alloc_workqueue_attrs - allocate a workqueue_attrs
3120 * @gfp_mask: allocation mask to use
3121 *
3122 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003123 * return it.
3124 *
3125 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003126 */
3127struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3128{
3129 struct workqueue_attrs *attrs;
3130
3131 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3132 if (!attrs)
3133 goto fail;
3134 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3135 goto fail;
3136
Tejun Heo13e2e552013-04-01 11:23:31 -07003137 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003138 return attrs;
3139fail:
3140 free_workqueue_attrs(attrs);
3141 return NULL;
3142}
3143
Tejun Heo29c91e92013-03-12 11:30:03 -07003144static void copy_workqueue_attrs(struct workqueue_attrs *to,
3145 const struct workqueue_attrs *from)
3146{
3147 to->nice = from->nice;
3148 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003149 /*
3150 * Unlike hash and equality test, this function doesn't ignore
3151 * ->no_numa as it is used for both pool and wq attrs. Instead,
3152 * get_unbound_pool() explicitly clears ->no_numa after copying.
3153 */
3154 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003155}
3156
Tejun Heo29c91e92013-03-12 11:30:03 -07003157/* hash value of the content of @attr */
3158static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3159{
3160 u32 hash = 0;
3161
3162 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003163 hash = jhash(cpumask_bits(attrs->cpumask),
3164 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003165 return hash;
3166}
3167
3168/* content equality test */
3169static bool wqattrs_equal(const struct workqueue_attrs *a,
3170 const struct workqueue_attrs *b)
3171{
3172 if (a->nice != b->nice)
3173 return false;
3174 if (!cpumask_equal(a->cpumask, b->cpumask))
3175 return false;
3176 return true;
3177}
3178
Tejun Heo7a4e3442013-03-12 11:30:00 -07003179/**
3180 * init_worker_pool - initialize a newly zalloc'd worker_pool
3181 * @pool: worker_pool to initialize
3182 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303183 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003184 *
3185 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003186 * inside @pool proper are initialized and put_unbound_pool() can be called
3187 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003188 */
3189static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003190{
3191 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003192 pool->id = -1;
3193 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003194 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003195 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003196 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003197 INIT_LIST_HEAD(&pool->worklist);
3198 INIT_LIST_HEAD(&pool->idle_list);
3199 hash_init(pool->busy_hash);
3200
3201 init_timer_deferrable(&pool->idle_timer);
3202 pool->idle_timer.function = idle_worker_timeout;
3203 pool->idle_timer.data = (unsigned long)pool;
3204
3205 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3206 (unsigned long)pool);
3207
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003208 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003209 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003210
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003211 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003212 INIT_HLIST_NODE(&pool->hash_node);
3213 pool->refcnt = 1;
3214
3215 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003216 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3217 if (!pool->attrs)
3218 return -ENOMEM;
3219 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003220}
3221
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003222static void rcu_free_wq(struct rcu_head *rcu)
3223{
3224 struct workqueue_struct *wq =
3225 container_of(rcu, struct workqueue_struct, rcu);
3226
3227 if (!(wq->flags & WQ_UNBOUND))
3228 free_percpu(wq->cpu_pwqs);
3229 else
3230 free_workqueue_attrs(wq->unbound_attrs);
3231
3232 kfree(wq->rescuer);
3233 kfree(wq);
3234}
3235
Tejun Heo29c91e92013-03-12 11:30:03 -07003236static void rcu_free_pool(struct rcu_head *rcu)
3237{
3238 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3239
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003240 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003241 free_workqueue_attrs(pool->attrs);
3242 kfree(pool);
3243}
3244
3245/**
3246 * put_unbound_pool - put a worker_pool
3247 * @pool: worker_pool to put
3248 *
3249 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003250 * safe manner. get_unbound_pool() calls this function on its failure path
3251 * and this function should be able to release pools which went through,
3252 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003253 *
3254 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003255 */
3256static void put_unbound_pool(struct worker_pool *pool)
3257{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003258 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003259 struct worker *worker;
3260
Tejun Heoa892cac2013-04-01 11:23:32 -07003261 lockdep_assert_held(&wq_pool_mutex);
3262
3263 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003264 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003265
3266 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003267 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003268 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003269 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003270
3271 /* release id and unhash */
3272 if (pool->id >= 0)
3273 idr_remove(&worker_pool_idr, pool->id);
3274 hash_del(&pool->hash_node);
3275
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003276 /*
Tejun Heo43a980a2017-10-09 08:04:13 -07003277 * Become the manager and destroy all workers. This prevents
3278 * @pool's workers from blocking on attach_mutex. We're the last
3279 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003280 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003281 spin_lock_irq(&pool->lock);
Tejun Heo43a980a2017-10-09 08:04:13 -07003282 wait_event_lock_irq(wq_manager_wait,
3283 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3284 pool->flags |= POOL_MANAGER_ACTIVE;
3285
Lai Jiangshan1037de32014-05-22 16:44:07 +08003286 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 destroy_worker(worker);
3288 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003289 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003290
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003291 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003292 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003293 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003294 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003295
3296 if (pool->detach_completion)
3297 wait_for_completion(pool->detach_completion);
3298
Tejun Heo29c91e92013-03-12 11:30:03 -07003299 /* shut down the timers */
3300 del_timer_sync(&pool->idle_timer);
3301 del_timer_sync(&pool->mayday_timer);
3302
3303 /* sched-RCU protected to allow dereferences from get_work_pool() */
3304 call_rcu_sched(&pool->rcu, rcu_free_pool);
3305}
3306
3307/**
3308 * get_unbound_pool - get a worker_pool with the specified attributes
3309 * @attrs: the attributes of the worker_pool to get
3310 *
3311 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3312 * reference count and return it. If there already is a matching
3313 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003314 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003315 *
3316 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003317 *
3318 * Return: On success, a worker_pool with the same attributes as @attrs.
3319 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003320 */
3321static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3322{
Tejun Heo29c91e92013-03-12 11:30:03 -07003323 u32 hash = wqattrs_hash(attrs);
3324 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003325 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003326 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003327
Tejun Heoa892cac2013-04-01 11:23:32 -07003328 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003329
3330 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003331 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3332 if (wqattrs_equal(pool->attrs, attrs)) {
3333 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003334 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003335 }
3336 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003337
Xunlei Pange2273582015-10-09 11:53:12 +08003338 /* if cpumask is contained inside a NUMA node, we belong to that node */
3339 if (wq_numa_enabled) {
3340 for_each_node(node) {
3341 if (cpumask_subset(attrs->cpumask,
3342 wq_numa_possible_cpumask[node])) {
3343 target_node = node;
3344 break;
3345 }
3346 }
3347 }
3348
Tejun Heo29c91e92013-03-12 11:30:03 -07003349 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003350 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003351 if (!pool || init_worker_pool(pool) < 0)
3352 goto fail;
3353
Tejun Heo8864b4e2013-03-12 11:30:04 -07003354 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003355 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003356 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003357
Shaohua Li2865a8f2013-08-01 09:56:36 +08003358 /*
3359 * no_numa isn't a worker_pool attribute, always clear it. See
3360 * 'struct workqueue_attrs' comments for detail.
3361 */
3362 pool->attrs->no_numa = false;
3363
Tejun Heo29c91e92013-03-12 11:30:03 -07003364 if (worker_pool_assign_id(pool) < 0)
3365 goto fail;
3366
3367 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003368 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003369 goto fail;
3370
Tejun Heo29c91e92013-03-12 11:30:03 -07003371 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003372 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003373
Tejun Heo29c91e92013-03-12 11:30:03 -07003374 return pool;
3375fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003376 if (pool)
3377 put_unbound_pool(pool);
3378 return NULL;
3379}
3380
Tejun Heo8864b4e2013-03-12 11:30:04 -07003381static void rcu_free_pwq(struct rcu_head *rcu)
3382{
3383 kmem_cache_free(pwq_cache,
3384 container_of(rcu, struct pool_workqueue, rcu));
3385}
3386
3387/*
3388 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3389 * and needs to be destroyed.
3390 */
3391static void pwq_unbound_release_workfn(struct work_struct *work)
3392{
3393 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3394 unbound_release_work);
3395 struct workqueue_struct *wq = pwq->wq;
3396 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003397 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003398
3399 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3400 return;
3401
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003402 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003403 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003404 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003405 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003406
Tejun Heoa892cac2013-04-01 11:23:32 -07003407 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003408 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003409 mutex_unlock(&wq_pool_mutex);
3410
Tejun Heo8864b4e2013-03-12 11:30:04 -07003411 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3412
3413 /*
3414 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003415 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003416 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003417 if (is_last)
3418 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003419}
3420
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003421/**
Tejun Heo699ce092013-03-13 16:51:35 -07003422 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003423 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003424 *
Tejun Heo699ce092013-03-13 16:51:35 -07003425 * If @pwq isn't freezing, set @pwq->max_active to the associated
3426 * workqueue's saved_max_active and activate delayed work items
3427 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003428 */
Tejun Heo699ce092013-03-13 16:51:35 -07003429static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003430{
Tejun Heo699ce092013-03-13 16:51:35 -07003431 struct workqueue_struct *wq = pwq->wq;
3432 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003433
Tejun Heo699ce092013-03-13 16:51:35 -07003434 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003435 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003436
3437 /* fast exit for non-freezable wqs */
3438 if (!freezable && pwq->max_active == wq->saved_max_active)
3439 return;
3440
Lai Jiangshana357fc02013-03-25 16:57:19 -07003441 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003442
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003443 /*
3444 * During [un]freezing, the caller is responsible for ensuring that
3445 * this function is called at least once after @workqueue_freezing
3446 * is updated and visible.
3447 */
3448 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003449 pwq->max_active = wq->saved_max_active;
3450
3451 while (!list_empty(&pwq->delayed_works) &&
3452 pwq->nr_active < pwq->max_active)
3453 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003454
3455 /*
3456 * Need to kick a worker after thawed or an unbound wq's
3457 * max_active is bumped. It's a slow path. Do it always.
3458 */
3459 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003460 } else {
3461 pwq->max_active = 0;
3462 }
3463
Lai Jiangshana357fc02013-03-25 16:57:19 -07003464 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003465}
3466
Tejun Heoe50aba92013-04-01 11:23:35 -07003467/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003468static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3469 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003470{
3471 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3472
Tejun Heoe50aba92013-04-01 11:23:35 -07003473 memset(pwq, 0, sizeof(*pwq));
3474
Tejun Heod2c1d402013-03-12 11:30:04 -07003475 pwq->pool = pool;
3476 pwq->wq = wq;
3477 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003478 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003479 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003480 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003481 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003482 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003483}
Tejun Heod2c1d402013-03-12 11:30:04 -07003484
Tejun Heof147f292013-04-01 11:23:35 -07003485/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003486static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003487{
3488 struct workqueue_struct *wq = pwq->wq;
3489
3490 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003491
Tejun Heo1befcf32013-04-01 11:23:35 -07003492 /* may be called multiple times, ignore if already linked */
3493 if (!list_empty(&pwq->pwqs_node))
3494 return;
3495
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003496 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003497 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003498
3499 /* sync max_active to the current setting */
3500 pwq_adjust_max_active(pwq);
3501
3502 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003503 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003504}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003505
Tejun Heof147f292013-04-01 11:23:35 -07003506/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3507static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3508 const struct workqueue_attrs *attrs)
3509{
3510 struct worker_pool *pool;
3511 struct pool_workqueue *pwq;
3512
3513 lockdep_assert_held(&wq_pool_mutex);
3514
3515 pool = get_unbound_pool(attrs);
3516 if (!pool)
3517 return NULL;
3518
Tejun Heoe50aba92013-04-01 11:23:35 -07003519 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003520 if (!pwq) {
3521 put_unbound_pool(pool);
3522 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003523 }
Tejun Heo6029a912013-04-01 11:23:34 -07003524
Tejun Heof147f292013-04-01 11:23:35 -07003525 init_pwq(pwq, wq, pool);
3526 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003527}
3528
Tejun Heo4c16bd32013-04-01 11:23:36 -07003529/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003530 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003531 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003532 * @node: the target NUMA node
3533 * @cpu_going_down: if >= 0, the CPU to consider as offline
3534 * @cpumask: outarg, the resulting cpumask
3535 *
3536 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3537 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003538 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003539 *
3540 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3541 * enabled and @node has online CPUs requested by @attrs, the returned
3542 * cpumask is the intersection of the possible CPUs of @node and
3543 * @attrs->cpumask.
3544 *
3545 * The caller is responsible for ensuring that the cpumask of @node stays
3546 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003547 *
3548 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3549 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003550 */
3551static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3552 int cpu_going_down, cpumask_t *cpumask)
3553{
Tejun Heod55262c2013-04-01 11:23:38 -07003554 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003555 goto use_dfl;
3556
3557 /* does @node have any online CPUs @attrs wants? */
3558 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3559 if (cpu_going_down >= 0)
3560 cpumask_clear_cpu(cpu_going_down, cpumask);
3561
3562 if (cpumask_empty(cpumask))
3563 goto use_dfl;
3564
3565 /* yeap, return possible CPUs in @node that @attrs wants */
3566 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3567 return !cpumask_equal(cpumask, attrs->cpumask);
3568
3569use_dfl:
3570 cpumask_copy(cpumask, attrs->cpumask);
3571 return false;
3572}
3573
Tejun Heo1befcf32013-04-01 11:23:35 -07003574/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3575static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3576 int node,
3577 struct pool_workqueue *pwq)
3578{
3579 struct pool_workqueue *old_pwq;
3580
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003581 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003582 lockdep_assert_held(&wq->mutex);
3583
3584 /* link_pwq() can handle duplicate calls */
3585 link_pwq(pwq);
3586
3587 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3588 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3589 return old_pwq;
3590}
3591
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003592/* context to store the prepared attrs & pwqs before applying */
3593struct apply_wqattrs_ctx {
3594 struct workqueue_struct *wq; /* target workqueue */
3595 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003596 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003597 struct pool_workqueue *dfl_pwq;
3598 struct pool_workqueue *pwq_tbl[];
3599};
3600
3601/* free the resources after success or abort */
3602static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3603{
3604 if (ctx) {
3605 int node;
3606
3607 for_each_node(node)
3608 put_pwq_unlocked(ctx->pwq_tbl[node]);
3609 put_pwq_unlocked(ctx->dfl_pwq);
3610
3611 free_workqueue_attrs(ctx->attrs);
3612
3613 kfree(ctx);
3614 }
3615}
3616
3617/* allocate the attrs and pwqs for later installation */
3618static struct apply_wqattrs_ctx *
3619apply_wqattrs_prepare(struct workqueue_struct *wq,
3620 const struct workqueue_attrs *attrs)
3621{
3622 struct apply_wqattrs_ctx *ctx;
3623 struct workqueue_attrs *new_attrs, *tmp_attrs;
3624 int node;
3625
3626 lockdep_assert_held(&wq_pool_mutex);
3627
3628 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3629 GFP_KERNEL);
3630
3631 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3632 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3633 if (!ctx || !new_attrs || !tmp_attrs)
3634 goto out_free;
3635
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003636 /*
3637 * Calculate the attrs of the default pwq.
3638 * If the user configured cpumask doesn't overlap with the
3639 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3640 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003641 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003642 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003643 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3644 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003645
3646 /*
3647 * We may create multiple pwqs with differing cpumasks. Make a
3648 * copy of @new_attrs which will be modified and used to obtain
3649 * pools.
3650 */
3651 copy_workqueue_attrs(tmp_attrs, new_attrs);
3652
3653 /*
3654 * If something goes wrong during CPU up/down, we'll fall back to
3655 * the default pwq covering whole @attrs->cpumask. Always create
3656 * it even if we don't use it immediately.
3657 */
3658 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3659 if (!ctx->dfl_pwq)
3660 goto out_free;
3661
3662 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003663 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003664 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3665 if (!ctx->pwq_tbl[node])
3666 goto out_free;
3667 } else {
3668 ctx->dfl_pwq->refcnt++;
3669 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3670 }
3671 }
3672
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003673 /* save the user configured attrs and sanitize it. */
3674 copy_workqueue_attrs(new_attrs, attrs);
3675 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003676 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003677
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003678 ctx->wq = wq;
3679 free_workqueue_attrs(tmp_attrs);
3680 return ctx;
3681
3682out_free:
3683 free_workqueue_attrs(tmp_attrs);
3684 free_workqueue_attrs(new_attrs);
3685 apply_wqattrs_cleanup(ctx);
3686 return NULL;
3687}
3688
3689/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3690static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3691{
3692 int node;
3693
3694 /* all pwqs have been created successfully, let's install'em */
3695 mutex_lock(&ctx->wq->mutex);
3696
3697 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3698
3699 /* save the previous pwq and install the new one */
3700 for_each_node(node)
3701 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3702 ctx->pwq_tbl[node]);
3703
3704 /* @dfl_pwq might not have been used, ensure it's linked */
3705 link_pwq(ctx->dfl_pwq);
3706 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3707
3708 mutex_unlock(&ctx->wq->mutex);
3709}
3710
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003711static void apply_wqattrs_lock(void)
3712{
3713 /* CPUs should stay stable across pwq creations and installations */
3714 get_online_cpus();
3715 mutex_lock(&wq_pool_mutex);
3716}
3717
3718static void apply_wqattrs_unlock(void)
3719{
3720 mutex_unlock(&wq_pool_mutex);
3721 put_online_cpus();
3722}
3723
3724static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3725 const struct workqueue_attrs *attrs)
3726{
3727 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003728
3729 /* only unbound workqueues can change attributes */
3730 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3731 return -EINVAL;
3732
3733 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heof9636c92017-07-23 08:36:15 -04003734 if (!list_empty(&wq->pwqs)) {
3735 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3736 return -EINVAL;
3737
3738 wq->flags &= ~__WQ_ORDERED;
3739 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003740
3741 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003742 if (!ctx)
3743 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003744
3745 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003746 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003747 apply_wqattrs_cleanup(ctx);
3748
wanghaibin62011712016-01-07 20:38:59 +08003749 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003750}
3751
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003752/**
3753 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3754 * @wq: the target workqueue
3755 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3756 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003757 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3758 * machines, this function maps a separate pwq to each NUMA node with
3759 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3760 * NUMA node it was issued on. Older pwqs are released as in-flight work
3761 * items finish. Note that a work item which repeatedly requeues itself
3762 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003763 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003764 * Performs GFP_KERNEL allocations.
3765 *
3766 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003767 */
3768int apply_workqueue_attrs(struct workqueue_struct *wq,
3769 const struct workqueue_attrs *attrs)
3770{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003771 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003772
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003773 apply_wqattrs_lock();
3774 ret = apply_workqueue_attrs_locked(wq, attrs);
3775 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003776
Tejun Heo48621252013-04-01 11:23:31 -07003777 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003778}
3779
Tejun Heo4c16bd32013-04-01 11:23:36 -07003780/**
3781 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3782 * @wq: the target workqueue
3783 * @cpu: the CPU coming up or going down
3784 * @online: whether @cpu is coming up or going down
3785 *
3786 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3787 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3788 * @wq accordingly.
3789 *
3790 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3791 * falls back to @wq->dfl_pwq which may not be optimal but is always
3792 * correct.
3793 *
3794 * Note that when the last allowed CPU of a NUMA node goes offline for a
3795 * workqueue with a cpumask spanning multiple nodes, the workers which were
3796 * already executing the work items for the workqueue will lose their CPU
3797 * affinity and may execute on any CPU. This is similar to how per-cpu
3798 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3799 * affinity, it's the user's responsibility to flush the work item from
3800 * CPU_DOWN_PREPARE.
3801 */
3802static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3803 bool online)
3804{
3805 int node = cpu_to_node(cpu);
3806 int cpu_off = online ? -1 : cpu;
3807 struct pool_workqueue *old_pwq = NULL, *pwq;
3808 struct workqueue_attrs *target_attrs;
3809 cpumask_t *cpumask;
3810
3811 lockdep_assert_held(&wq_pool_mutex);
3812
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003813 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3814 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003815 return;
3816
3817 /*
3818 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3819 * Let's use a preallocated one. The following buf is protected by
3820 * CPU hotplug exclusion.
3821 */
3822 target_attrs = wq_update_unbound_numa_attrs_buf;
3823 cpumask = target_attrs->cpumask;
3824
Tejun Heo4c16bd32013-04-01 11:23:36 -07003825 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3826 pwq = unbound_pwq_by_node(wq, node);
3827
3828 /*
3829 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003830 * different from the default pwq's, we need to compare it to @pwq's
3831 * and create a new one if they don't match. If the target cpumask
3832 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003833 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003834 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003835 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003836 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003837 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003838 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003839 }
3840
Tejun Heo4c16bd32013-04-01 11:23:36 -07003841 /* create a new pwq */
3842 pwq = alloc_unbound_pwq(wq, target_attrs);
3843 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003844 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3845 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003846 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003847 }
3848
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003849 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003850 mutex_lock(&wq->mutex);
3851 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3852 goto out_unlock;
3853
3854use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003855 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003856 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3857 get_pwq(wq->dfl_pwq);
3858 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3859 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3860out_unlock:
3861 mutex_unlock(&wq->mutex);
3862 put_pwq_unlocked(old_pwq);
3863}
3864
Tejun Heo30cdf242013-03-12 11:29:57 -07003865static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003866{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003867 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003868 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003869
Tejun Heo30cdf242013-03-12 11:29:57 -07003870 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003871 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3872 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003873 return -ENOMEM;
3874
3875 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003876 struct pool_workqueue *pwq =
3877 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003878 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003879 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003880
Tejun Heof147f292013-04-01 11:23:35 -07003881 init_pwq(pwq, wq, &cpu_pools[highpri]);
3882
3883 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003884 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003885 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003886 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003887 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003888 } else if (wq->flags & __WQ_ORDERED) {
3889 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3890 /* there should only be single pwq for ordering guarantee */
3891 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3892 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3893 "ordering guarantee broken for workqueue %s\n", wq->name);
3894 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003895 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003896 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003897 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003898}
3899
Tejun Heof3421792010-07-02 10:03:51 +02003900static int wq_clamp_max_active(int max_active, unsigned int flags,
3901 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003902{
Tejun Heof3421792010-07-02 10:03:51 +02003903 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3904
3905 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003906 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3907 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003908
Tejun Heof3421792010-07-02 10:03:51 +02003909 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003910}
3911
Tejun Heob196be82012-01-10 15:11:35 -08003912struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003913 unsigned int flags,
3914 int max_active,
3915 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003916 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003917{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003918 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003919 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003920 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003921 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003922
Tejun Heo61a0adb2017-07-18 18:41:52 -04003923 /*
3924 * Unbound && max_active == 1 used to imply ordered, which is no
3925 * longer the case on NUMA machines due to per-node pools. While
3926 * alloc_ordered_workqueue() is the right way to create an ordered
3927 * workqueue, keep the previous behavior to avoid subtle breakages
3928 * on NUMA.
3929 */
3930 if ((flags & WQ_UNBOUND) && max_active == 1)
3931 flags |= __WQ_ORDERED;
3932
Viresh Kumarcee22a12013-04-08 16:45:40 +05303933 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3934 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3935 flags |= WQ_UNBOUND;
3936
Tejun Heoecf68812013-04-01 11:23:34 -07003937 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003938 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003939 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003940
3941 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003942 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003943 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003944
Tejun Heo6029a912013-04-01 11:23:34 -07003945 if (flags & WQ_UNBOUND) {
3946 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3947 if (!wq->unbound_attrs)
3948 goto err_free_wq;
3949 }
3950
Tejun Heoecf68812013-04-01 11:23:34 -07003951 va_start(args, lock_name);
3952 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003953 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003954
Tejun Heod320c032010-06-29 10:07:14 +02003955 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003956 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003957
Tejun Heob196be82012-01-10 15:11:35 -08003958 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003959 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003960 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003961 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003962 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003963 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003964 INIT_LIST_HEAD(&wq->flusher_queue);
3965 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003966 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003967
Johannes Bergeb13ba82008-01-16 09:51:58 +01003968 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003969 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003970
Tejun Heo30cdf242013-03-12 11:29:57 -07003971 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003972 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003973
Tejun Heo493008a2013-03-12 11:30:03 -07003974 /*
3975 * Workqueues which may be used during memory reclaim should
3976 * have a rescuer to guarantee forward progress.
3977 */
3978 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003979 struct worker *rescuer;
3980
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003981 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003982 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003983 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003984
Tejun Heo111c2252013-01-17 17:16:24 -08003985 rescuer->rescue_wq = wq;
3986 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003987 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003988 if (IS_ERR(rescuer->task)) {
3989 kfree(rescuer);
3990 goto err_destroy;
3991 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003992
Tejun Heod2c1d402013-03-12 11:30:04 -07003993 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02003994 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003995 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003996 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003997
Tejun Heo226223a2013-03-12 11:30:05 -07003998 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3999 goto err_destroy;
4000
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004001 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004002 * wq_pool_mutex protects global freeze state and workqueues list.
4003 * Grab it, adjust max_active and add the new @wq to workqueues
4004 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004005 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004006 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004007
Lai Jiangshana357fc02013-03-25 16:57:19 -07004008 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004009 for_each_pwq(pwq, wq)
4010 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004011 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004012
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004013 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004014
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004015 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004016
Oleg Nesterov3af244332007-05-09 02:34:09 -07004017 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004018
4019err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004020 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004021 kfree(wq);
4022 return NULL;
4023err_destroy:
4024 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004025 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004026}
Tejun Heod320c032010-06-29 10:07:14 +02004027EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004028
4029/**
4030 * destroy_workqueue - safely terminate a workqueue
4031 * @wq: target workqueue
4032 *
4033 * Safely destroy a workqueue. All work currently pending will be done first.
4034 */
4035void destroy_workqueue(struct workqueue_struct *wq)
4036{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004037 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004038 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004039
Tejun Heo54f859a2019-09-18 18:43:40 -07004040 /*
4041 * Remove it from sysfs first so that sanity check failure doesn't
4042 * lead to sysfs name conflicts.
4043 */
4044 workqueue_sysfs_unregister(wq);
4045
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004046 /* drain it before proceeding with destruction */
4047 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004048
Tejun Heo54f859a2019-09-18 18:43:40 -07004049 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4050 if (wq->rescuer) {
4051 struct worker *rescuer = wq->rescuer;
4052
4053 /* this prevents new queueing */
4054 spin_lock_irq(&wq_mayday_lock);
4055 wq->rescuer = NULL;
4056 spin_unlock_irq(&wq_mayday_lock);
4057
4058 /* rescuer will empty maydays list before exiting */
4059 kthread_stop(rescuer->task);
Tejun Heo1a1e9ff2019-09-20 13:39:57 -07004060 kfree(rescuer);
Tejun Heo54f859a2019-09-18 18:43:40 -07004061 }
4062
Tejun Heo6183c002013-03-12 11:29:57 -07004063 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004064 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004065 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004066 int i;
4067
Tejun Heo76af4d92013-03-12 11:30:00 -07004068 for (i = 0; i < WORK_NR_COLORS; i++) {
4069 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004070 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004071 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004072 }
4073 }
4074
Lai Jiangshan5c529592013-04-04 10:05:38 +08004075 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004076 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004077 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004078 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004079 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004080 }
Tejun Heo6183c002013-03-12 11:29:57 -07004081 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004082 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004083
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004084 /*
4085 * wq list is used to freeze wq, remove from list after
4086 * flushing is complete in case freeze races us.
4087 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004088 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004089 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004090 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004091
Tejun Heo8864b4e2013-03-12 11:30:04 -07004092 if (!(wq->flags & WQ_UNBOUND)) {
4093 /*
4094 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004095 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004096 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004097 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004098 } else {
4099 /*
4100 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004101 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4102 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004103 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004104 for_each_node(node) {
4105 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4106 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4107 put_pwq_unlocked(pwq);
4108 }
4109
4110 /*
4111 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4112 * put. Don't access it afterwards.
4113 */
4114 pwq = wq->dfl_pwq;
4115 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004116 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004117 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004118}
4119EXPORT_SYMBOL_GPL(destroy_workqueue);
4120
Tejun Heodcd989c2010-06-29 10:07:14 +02004121/**
4122 * workqueue_set_max_active - adjust max_active of a workqueue
4123 * @wq: target workqueue
4124 * @max_active: new max_active value.
4125 *
4126 * Set max_active of @wq to @max_active.
4127 *
4128 * CONTEXT:
4129 * Don't call from IRQ context.
4130 */
4131void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4132{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004133 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004134
Tejun Heo8719dce2013-03-12 11:30:04 -07004135 /* disallow meddling with max_active for ordered workqueues */
Tejun Heof9636c92017-07-23 08:36:15 -04004136 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004137 return;
4138
Tejun Heof3421792010-07-02 10:03:51 +02004139 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004140
Lai Jiangshana357fc02013-03-25 16:57:19 -07004141 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004142
Tejun Heof9636c92017-07-23 08:36:15 -04004143 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004144 wq->saved_max_active = max_active;
4145
Tejun Heo699ce092013-03-13 16:51:35 -07004146 for_each_pwq(pwq, wq)
4147 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004148
Lai Jiangshana357fc02013-03-25 16:57:19 -07004149 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004150}
4151EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4152
4153/**
Lukas Wunner225ce6d2018-02-11 10:38:28 +01004154 * current_work - retrieve %current task's work struct
4155 *
4156 * Determine if %current task is a workqueue worker and what it's working on.
4157 * Useful to find out the context that the %current task is running in.
4158 *
4159 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4160 */
4161struct work_struct *current_work(void)
4162{
4163 struct worker *worker = current_wq_worker();
4164
4165 return worker ? worker->current_work : NULL;
4166}
4167EXPORT_SYMBOL(current_work);
4168
4169/**
Tejun Heoe62676162013-03-12 17:41:37 -07004170 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4171 *
4172 * Determine whether %current is a workqueue rescuer. Can be used from
4173 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004174 *
4175 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004176 */
4177bool current_is_workqueue_rescuer(void)
4178{
4179 struct worker *worker = current_wq_worker();
4180
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004181 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004182}
4183
4184/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004185 * workqueue_congested - test whether a workqueue is congested
4186 * @cpu: CPU in question
4187 * @wq: target workqueue
4188 *
4189 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4190 * no synchronization around this function and the test result is
4191 * unreliable and only useful as advisory hints or for debugging.
4192 *
Tejun Heod3251852013-05-10 11:10:17 -07004193 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4194 * Note that both per-cpu and unbound workqueues may be associated with
4195 * multiple pool_workqueues which have separate congested states. A
4196 * workqueue being congested on one CPU doesn't mean the workqueue is also
4197 * contested on other CPUs / NUMA nodes.
4198 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004199 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004200 * %true if congested, %false otherwise.
4201 */
Tejun Heod84ff052013-03-12 11:29:59 -07004202bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004203{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004204 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004205 bool ret;
4206
Lai Jiangshan88109452013-03-20 03:28:10 +08004207 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004208
Tejun Heod3251852013-05-10 11:10:17 -07004209 if (cpu == WORK_CPU_UNBOUND)
4210 cpu = smp_processor_id();
4211
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004212 if (!(wq->flags & WQ_UNBOUND))
4213 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4214 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004215 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004216
Tejun Heo76af4d92013-03-12 11:30:00 -07004217 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004218 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004219
4220 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004221}
4222EXPORT_SYMBOL_GPL(workqueue_congested);
4223
4224/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004225 * work_busy - test whether a work is currently pending or running
4226 * @work: the work to be tested
4227 *
4228 * Test whether @work is currently pending or running. There is no
4229 * synchronization around this function and the test result is
4230 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004231 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004232 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004233 * OR'd bitmask of WORK_BUSY_* bits.
4234 */
4235unsigned int work_busy(struct work_struct *work)
4236{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004237 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004238 unsigned long flags;
4239 unsigned int ret = 0;
4240
Tejun Heodcd989c2010-06-29 10:07:14 +02004241 if (work_pending(work))
4242 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004243
Tejun Heofa1b54e2013-03-12 11:30:00 -07004244 local_irq_save(flags);
4245 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004246 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004247 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004248 if (find_worker_executing_work(pool, work))
4249 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004250 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004251 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004252 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004253
4254 return ret;
4255}
4256EXPORT_SYMBOL_GPL(work_busy);
4257
Tejun Heo3d1cb202013-04-30 15:27:22 -07004258/**
4259 * set_worker_desc - set description for the current work item
4260 * @fmt: printf-style format string
4261 * @...: arguments for the format string
4262 *
4263 * This function can be called by a running work function to describe what
4264 * the work item is about. If the worker task gets dumped, this
4265 * information will be printed out together to help debugging. The
4266 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4267 */
4268void set_worker_desc(const char *fmt, ...)
4269{
4270 struct worker *worker = current_wq_worker();
4271 va_list args;
4272
4273 if (worker) {
4274 va_start(args, fmt);
4275 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4276 va_end(args);
4277 worker->desc_valid = true;
4278 }
4279}
4280
4281/**
4282 * print_worker_info - print out worker information and description
4283 * @log_lvl: the log level to use when printing
4284 * @task: target task
4285 *
4286 * If @task is a worker and currently executing a work item, print out the
4287 * name of the workqueue being serviced and worker description set with
4288 * set_worker_desc() by the currently executing work item.
4289 *
4290 * This function can be safely called on any task as long as the
4291 * task_struct itself is accessible. While safe, this function isn't
4292 * synchronized and may print out mixups or garbages of limited length.
4293 */
4294void print_worker_info(const char *log_lvl, struct task_struct *task)
4295{
4296 work_func_t *fn = NULL;
4297 char name[WQ_NAME_LEN] = { };
4298 char desc[WORKER_DESC_LEN] = { };
4299 struct pool_workqueue *pwq = NULL;
4300 struct workqueue_struct *wq = NULL;
4301 bool desc_valid = false;
4302 struct worker *worker;
4303
4304 if (!(task->flags & PF_WQ_WORKER))
4305 return;
4306
4307 /*
4308 * This function is called without any synchronization and @task
4309 * could be in any state. Be careful with dereferences.
4310 */
Petr Mladeke7005912016-10-11 13:55:17 -07004311 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004312
4313 /*
4314 * Carefully copy the associated workqueue's workfn and name. Keep
4315 * the original last '\0' in case the original contains garbage.
4316 */
4317 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4318 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4319 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4320 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4321
4322 /* copy worker description */
4323 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4324 if (desc_valid)
4325 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4326
4327 if (fn || name[0] || desc[0]) {
4328 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4329 if (desc[0])
4330 pr_cont(" (%s)", desc);
4331 pr_cont("\n");
4332 }
4333}
4334
Tejun Heo3494fc32015-03-09 09:22:28 -04004335static void pr_cont_pool_info(struct worker_pool *pool)
4336{
4337 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4338 if (pool->node != NUMA_NO_NODE)
4339 pr_cont(" node=%d", pool->node);
4340 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4341}
4342
4343static void pr_cont_work(bool comma, struct work_struct *work)
4344{
4345 if (work->func == wq_barrier_func) {
4346 struct wq_barrier *barr;
4347
4348 barr = container_of(work, struct wq_barrier, work);
4349
4350 pr_cont("%s BAR(%d)", comma ? "," : "",
4351 task_pid_nr(barr->task));
4352 } else {
4353 pr_cont("%s %pf", comma ? "," : "", work->func);
4354 }
4355}
4356
4357static void show_pwq(struct pool_workqueue *pwq)
4358{
4359 struct worker_pool *pool = pwq->pool;
4360 struct work_struct *work;
4361 struct worker *worker;
4362 bool has_in_flight = false, has_pending = false;
4363 int bkt;
4364
4365 pr_info(" pwq %d:", pool->id);
4366 pr_cont_pool_info(pool);
4367
Tejun Heo4f5b0c72019-09-25 06:59:15 -07004368 pr_cont(" active=%d/%d refcnt=%d%s\n",
4369 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004370 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4371
4372 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4373 if (worker->current_pwq == pwq) {
4374 has_in_flight = true;
4375 break;
4376 }
4377 }
4378 if (has_in_flight) {
4379 bool comma = false;
4380
4381 pr_info(" in-flight:");
4382 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4383 if (worker->current_pwq != pwq)
4384 continue;
4385
4386 pr_cont("%s %d%s:%pf", comma ? "," : "",
4387 task_pid_nr(worker->task),
4388 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4389 worker->current_func);
4390 list_for_each_entry(work, &worker->scheduled, entry)
4391 pr_cont_work(false, work);
4392 comma = true;
4393 }
4394 pr_cont("\n");
4395 }
4396
4397 list_for_each_entry(work, &pool->worklist, entry) {
4398 if (get_work_pwq(work) == pwq) {
4399 has_pending = true;
4400 break;
4401 }
4402 }
4403 if (has_pending) {
4404 bool comma = false;
4405
4406 pr_info(" pending:");
4407 list_for_each_entry(work, &pool->worklist, entry) {
4408 if (get_work_pwq(work) != pwq)
4409 continue;
4410
4411 pr_cont_work(comma, work);
4412 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4413 }
4414 pr_cont("\n");
4415 }
4416
4417 if (!list_empty(&pwq->delayed_works)) {
4418 bool comma = false;
4419
4420 pr_info(" delayed:");
4421 list_for_each_entry(work, &pwq->delayed_works, entry) {
4422 pr_cont_work(comma, work);
4423 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4424 }
4425 pr_cont("\n");
4426 }
4427}
4428
4429/**
4430 * show_workqueue_state - dump workqueue state
4431 *
Roger Lu7b776af2016-07-01 11:05:02 +08004432 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4433 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004434 */
4435void show_workqueue_state(void)
4436{
4437 struct workqueue_struct *wq;
4438 struct worker_pool *pool;
4439 unsigned long flags;
4440 int pi;
4441
4442 rcu_read_lock_sched();
4443
4444 pr_info("Showing busy workqueues and worker pools:\n");
4445
4446 list_for_each_entry_rcu(wq, &workqueues, list) {
4447 struct pool_workqueue *pwq;
4448 bool idle = true;
4449
4450 for_each_pwq(pwq, wq) {
4451 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4452 idle = false;
4453 break;
4454 }
4455 }
4456 if (idle)
4457 continue;
4458
4459 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4460
4461 for_each_pwq(pwq, wq) {
4462 spin_lock_irqsave(&pwq->pool->lock, flags);
4463 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4464 show_pwq(pwq);
4465 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004466 /*
4467 * We could be printing a lot from atomic context, e.g.
4468 * sysrq-t -> show_workqueue_state(). Avoid triggering
4469 * hard lockup.
4470 */
4471 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004472 }
4473 }
4474
4475 for_each_pool(pool, pi) {
4476 struct worker *worker;
4477 bool first = true;
4478
4479 spin_lock_irqsave(&pool->lock, flags);
4480 if (pool->nr_workers == pool->nr_idle)
4481 goto next_pool;
4482
4483 pr_info("pool %d:", pool->id);
4484 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004485 pr_cont(" hung=%us workers=%d",
4486 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4487 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004488 if (pool->manager)
4489 pr_cont(" manager: %d",
4490 task_pid_nr(pool->manager->task));
4491 list_for_each_entry(worker, &pool->idle_list, entry) {
4492 pr_cont(" %s%d", first ? "idle: " : "",
4493 task_pid_nr(worker->task));
4494 first = false;
4495 }
4496 pr_cont("\n");
4497 next_pool:
4498 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004499 /*
4500 * We could be printing a lot from atomic context, e.g.
4501 * sysrq-t -> show_workqueue_state(). Avoid triggering
4502 * hard lockup.
4503 */
4504 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004505 }
4506
4507 rcu_read_unlock_sched();
4508}
4509
Tejun Heodb7bccf2010-06-29 10:07:12 +02004510/*
4511 * CPU hotplug.
4512 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004513 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004514 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004515 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004516 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004517 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004518 * blocked draining impractical.
4519 *
Tejun Heo24647572013-01-24 11:01:33 -08004520 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004521 * running as an unbound one and allowing it to be reattached later if the
4522 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004523 */
4524
Tejun Heo706026c2013-01-24 11:01:34 -08004525static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004526{
Tejun Heo38db41d2013-01-24 11:01:34 -08004527 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004528 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004529 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004530
Tejun Heof02ae732013-03-12 11:30:03 -07004531 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004532 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004533 spin_lock_irq(&pool->lock);
4534
4535 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004536 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004537 * unbound and set DISASSOCIATED. Before this, all workers
4538 * except for the ones which are still executing works from
4539 * before the last CPU down must be on the cpu. After
4540 * this, they may become diasporas.
4541 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004542 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004543 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004544
Tejun Heo24647572013-01-24 11:01:33 -08004545 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004546
Tejun Heo94cf58b2013-01-24 11:01:33 -08004547 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004548 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004549
Lai Jiangshaneb283422013-03-08 15:18:28 -08004550 /*
4551 * Call schedule() so that we cross rq->lock and thus can
4552 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4553 * This is necessary as scheduler callbacks may be invoked
4554 * from other cpus.
4555 */
4556 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004557
Lai Jiangshaneb283422013-03-08 15:18:28 -08004558 /*
4559 * Sched callbacks are disabled now. Zap nr_running.
4560 * After this, nr_running stays zero and need_more_worker()
4561 * and keep_working() are always true as long as the
4562 * worklist is not empty. This pool now behaves as an
4563 * unbound (in terms of concurrency management) pool which
4564 * are served by workers tied to the pool.
4565 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004566 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004567
4568 /*
4569 * With concurrency management just turned off, a busy
4570 * worker blocking could lead to lengthy stalls. Kick off
4571 * unbound chain execution of currently pending work items.
4572 */
4573 spin_lock_irq(&pool->lock);
4574 wake_up_worker(pool);
4575 spin_unlock_irq(&pool->lock);
4576 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004577}
4578
Tejun Heobd7c0892013-03-19 13:45:21 -07004579/**
4580 * rebind_workers - rebind all workers of a pool to the associated CPU
4581 * @pool: pool of interest
4582 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004583 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004584 */
4585static void rebind_workers(struct worker_pool *pool)
4586{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004587 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004588
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004589 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004590
Tejun Heoa9ab7752013-03-19 13:45:21 -07004591 /*
4592 * Restore CPU affinity of all workers. As all idle workers should
4593 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304594 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004595 * of all workers first and then clear UNBOUND. As we're called
4596 * from CPU_ONLINE, the following shouldn't fail.
4597 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004598 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004599 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4600 pool->attrs->cpumask) < 0);
4601
4602 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004603
4604 /*
4605 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4606 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4607 * being reworked and this can go away in time.
4608 */
4609 if (!(pool->flags & POOL_DISASSOCIATED)) {
4610 spin_unlock_irq(&pool->lock);
4611 return;
4612 }
4613
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004614 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004615
Lai Jiangshanda028462014-05-20 17:46:31 +08004616 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004617 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004618
4619 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004620 * A bound idle worker should actually be on the runqueue
4621 * of the associated CPU for local wake-ups targeting it to
4622 * work. Kick all idle workers so that they migrate to the
4623 * associated CPU. Doing this in the same loop as
4624 * replacing UNBOUND with REBOUND is safe as no worker will
4625 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004626 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004627 if (worker_flags & WORKER_IDLE)
4628 wake_up_process(worker->task);
4629
4630 /*
4631 * We want to clear UNBOUND but can't directly call
4632 * worker_clr_flags() or adjust nr_running. Atomically
4633 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4634 * @worker will clear REBOUND using worker_clr_flags() when
4635 * it initiates the next execution cycle thus restoring
4636 * concurrency management. Note that when or whether
4637 * @worker clears REBOUND doesn't affect correctness.
4638 *
4639 * ACCESS_ONCE() is necessary because @worker->flags may be
4640 * tested without holding any lock in
4641 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4642 * fail incorrectly leading to premature concurrency
4643 * management operations.
4644 */
4645 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4646 worker_flags |= WORKER_REBOUND;
4647 worker_flags &= ~WORKER_UNBOUND;
4648 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004649 }
4650
Tejun Heoa9ab7752013-03-19 13:45:21 -07004651 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004652}
4653
Tejun Heo7dbc7252013-03-19 13:45:21 -07004654/**
4655 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4656 * @pool: unbound pool of interest
4657 * @cpu: the CPU which is coming up
4658 *
4659 * An unbound pool may end up with a cpumask which doesn't have any online
4660 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4661 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4662 * online CPU before, cpus_allowed of all its workers should be restored.
4663 */
4664static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4665{
4666 static cpumask_t cpumask;
4667 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004668
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004669 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004670
4671 /* is @cpu allowed for @pool? */
4672 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4673 return;
4674
Tejun Heo7dbc7252013-03-19 13:45:21 -07004675 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004676
4677 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004678 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004679 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004680}
4681
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004682int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004683{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004684 struct worker_pool *pool;
4685
4686 for_each_cpu_worker_pool(pool, cpu) {
4687 if (pool->nr_workers)
4688 continue;
4689 if (!create_worker(pool))
4690 return -ENOMEM;
4691 }
4692 return 0;
4693}
4694
4695int workqueue_online_cpu(unsigned int cpu)
4696{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004697 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004698 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004699 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004700
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004701 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004702
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004703 for_each_pool(pool, pi) {
4704 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004705
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004706 if (pool->cpu == cpu)
4707 rebind_workers(pool);
4708 else if (pool->cpu < 0)
4709 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004710
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004711 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004712 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004713
4714 /* update NUMA affinity of unbound workqueues */
4715 list_for_each_entry(wq, &workqueues, list)
4716 wq_update_unbound_numa(wq, cpu, true);
4717
4718 mutex_unlock(&wq_pool_mutex);
4719 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004720}
4721
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004722int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004723{
Tejun Heo8db25e72012-07-17 12:39:28 -07004724 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004725 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004726
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004727 /* unbinding per-cpu workers should happen on the local CPU */
4728 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4729 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004730
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004731 /* update NUMA affinity of unbound workqueues */
4732 mutex_lock(&wq_pool_mutex);
4733 list_for_each_entry(wq, &workqueues, list)
4734 wq_update_unbound_numa(wq, cpu, false);
4735 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004736
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004737 /* wait for per-cpu unbinding to finish */
4738 flush_work(&unbind_work);
4739 destroy_work_on_stack(&unbind_work);
4740 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004741}
4742
Rusty Russell2d3854a2008-11-05 13:39:10 +11004743#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004744
Rusty Russell2d3854a2008-11-05 13:39:10 +11004745struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004746 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004747 long (*fn)(void *);
4748 void *arg;
4749 long ret;
4750};
4751
Tejun Heoed48ece2012-09-18 12:48:43 -07004752static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004753{
Tejun Heoed48ece2012-09-18 12:48:43 -07004754 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4755
Rusty Russell2d3854a2008-11-05 13:39:10 +11004756 wfc->ret = wfc->fn(wfc->arg);
4757}
4758
4759/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004760 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004761 * @cpu: the cpu to run on
4762 * @fn: the function to run
4763 * @arg: the function arg
4764 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004765 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004766 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004767 *
4768 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004769 */
Tejun Heod84ff052013-03-12 11:29:59 -07004770long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004771{
Tejun Heoed48ece2012-09-18 12:48:43 -07004772 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004773
Tejun Heoed48ece2012-09-18 12:48:43 -07004774 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4775 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004776 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004777 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004778 return wfc.ret;
4779}
4780EXPORT_SYMBOL_GPL(work_on_cpu);
4781#endif /* CONFIG_SMP */
4782
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004783#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304784
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004785/**
4786 * freeze_workqueues_begin - begin freezing workqueues
4787 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004788 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004789 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004790 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004791 *
4792 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004793 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004794 */
4795void freeze_workqueues_begin(void)
4796{
Tejun Heo24b8a842013-03-12 11:29:58 -07004797 struct workqueue_struct *wq;
4798 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004799
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004800 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004801
Tejun Heo6183c002013-03-12 11:29:57 -07004802 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004803 workqueue_freezing = true;
4804
Tejun Heo24b8a842013-03-12 11:29:58 -07004805 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004806 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004807 for_each_pwq(pwq, wq)
4808 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004809 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004810 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004811
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004812 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004813}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004814
4815/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004816 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004817 *
4818 * Check whether freezing is complete. This function must be called
4819 * between freeze_workqueues_begin() and thaw_workqueues().
4820 *
4821 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004822 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004823 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004824 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004825 * %true if some freezable workqueues are still busy. %false if freezing
4826 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004827 */
4828bool freeze_workqueues_busy(void)
4829{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004830 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004831 struct workqueue_struct *wq;
4832 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004833
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004834 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004835
Tejun Heo6183c002013-03-12 11:29:57 -07004836 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004837
Tejun Heo24b8a842013-03-12 11:29:58 -07004838 list_for_each_entry(wq, &workqueues, list) {
4839 if (!(wq->flags & WQ_FREEZABLE))
4840 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004841 /*
4842 * nr_active is monotonically decreasing. It's safe
4843 * to peek without lock.
4844 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004845 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004846 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004847 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004848 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004849 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004850 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004851 goto out_unlock;
4852 }
4853 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004854 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004855 }
4856out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004857 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004858 return busy;
4859}
4860
4861/**
4862 * thaw_workqueues - thaw workqueues
4863 *
4864 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004865 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004866 *
4867 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004868 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004869 */
4870void thaw_workqueues(void)
4871{
Tejun Heo24b8a842013-03-12 11:29:58 -07004872 struct workqueue_struct *wq;
4873 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004874
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004875 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004876
4877 if (!workqueue_freezing)
4878 goto out_unlock;
4879
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004880 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004881
Tejun Heo24b8a842013-03-12 11:29:58 -07004882 /* restore max_active and repopulate worklist */
4883 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004884 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004885 for_each_pwq(pwq, wq)
4886 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004887 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004888 }
4889
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004890out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004891 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004892}
4893#endif /* CONFIG_FREEZER */
4894
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004895static int workqueue_apply_unbound_cpumask(void)
4896{
4897 LIST_HEAD(ctxs);
4898 int ret = 0;
4899 struct workqueue_struct *wq;
4900 struct apply_wqattrs_ctx *ctx, *n;
4901
4902 lockdep_assert_held(&wq_pool_mutex);
4903
4904 list_for_each_entry(wq, &workqueues, list) {
4905 if (!(wq->flags & WQ_UNBOUND))
4906 continue;
4907 /* creating multiple pwqs breaks ordering guarantee */
4908 if (wq->flags & __WQ_ORDERED)
4909 continue;
4910
4911 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4912 if (!ctx) {
4913 ret = -ENOMEM;
4914 break;
4915 }
4916
4917 list_add_tail(&ctx->list, &ctxs);
4918 }
4919
4920 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4921 if (!ret)
4922 apply_wqattrs_commit(ctx);
4923 apply_wqattrs_cleanup(ctx);
4924 }
4925
4926 return ret;
4927}
4928
4929/**
4930 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4931 * @cpumask: the cpumask to set
4932 *
4933 * The low-level workqueues cpumask is a global cpumask that limits
4934 * the affinity of all unbound workqueues. This function check the @cpumask
4935 * and apply it to all unbound workqueues and updates all pwqs of them.
4936 *
4937 * Retun: 0 - Success
4938 * -EINVAL - Invalid @cpumask
4939 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4940 */
4941int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4942{
4943 int ret = -EINVAL;
4944 cpumask_var_t saved_cpumask;
4945
4946 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4947 return -ENOMEM;
4948
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004949 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4950 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004951 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004952
4953 /* save the old wq_unbound_cpumask. */
4954 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4955
4956 /* update wq_unbound_cpumask at first and apply it to wqs. */
4957 cpumask_copy(wq_unbound_cpumask, cpumask);
4958 ret = workqueue_apply_unbound_cpumask();
4959
4960 /* restore the wq_unbound_cpumask when failed. */
4961 if (ret < 0)
4962 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4963
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004964 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004965 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004966
4967 free_cpumask_var(saved_cpumask);
4968 return ret;
4969}
4970
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004971#ifdef CONFIG_SYSFS
4972/*
4973 * Workqueues with WQ_SYSFS flag set is visible to userland via
4974 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4975 * following attributes.
4976 *
4977 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4978 * max_active RW int : maximum number of in-flight work items
4979 *
4980 * Unbound workqueues have the following extra attributes.
4981 *
4982 * id RO int : the associated pool ID
4983 * nice RW int : nice value of the workers
4984 * cpumask RW mask : bitmask of allowed CPUs for the workers
4985 */
4986struct wq_device {
4987 struct workqueue_struct *wq;
4988 struct device dev;
4989};
4990
4991static struct workqueue_struct *dev_to_wq(struct device *dev)
4992{
4993 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4994
4995 return wq_dev->wq;
4996}
4997
4998static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4999 char *buf)
5000{
5001 struct workqueue_struct *wq = dev_to_wq(dev);
5002
5003 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5004}
5005static DEVICE_ATTR_RO(per_cpu);
5006
5007static ssize_t max_active_show(struct device *dev,
5008 struct device_attribute *attr, char *buf)
5009{
5010 struct workqueue_struct *wq = dev_to_wq(dev);
5011
5012 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5013}
5014
5015static ssize_t max_active_store(struct device *dev,
5016 struct device_attribute *attr, const char *buf,
5017 size_t count)
5018{
5019 struct workqueue_struct *wq = dev_to_wq(dev);
5020 int val;
5021
5022 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5023 return -EINVAL;
5024
5025 workqueue_set_max_active(wq, val);
5026 return count;
5027}
5028static DEVICE_ATTR_RW(max_active);
5029
5030static struct attribute *wq_sysfs_attrs[] = {
5031 &dev_attr_per_cpu.attr,
5032 &dev_attr_max_active.attr,
5033 NULL,
5034};
5035ATTRIBUTE_GROUPS(wq_sysfs);
5036
5037static ssize_t wq_pool_ids_show(struct device *dev,
5038 struct device_attribute *attr, char *buf)
5039{
5040 struct workqueue_struct *wq = dev_to_wq(dev);
5041 const char *delim = "";
5042 int node, written = 0;
5043
5044 rcu_read_lock_sched();
5045 for_each_node(node) {
5046 written += scnprintf(buf + written, PAGE_SIZE - written,
5047 "%s%d:%d", delim, node,
5048 unbound_pwq_by_node(wq, node)->pool->id);
5049 delim = " ";
5050 }
5051 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5052 rcu_read_unlock_sched();
5053
5054 return written;
5055}
5056
5057static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5058 char *buf)
5059{
5060 struct workqueue_struct *wq = dev_to_wq(dev);
5061 int written;
5062
5063 mutex_lock(&wq->mutex);
5064 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5065 mutex_unlock(&wq->mutex);
5066
5067 return written;
5068}
5069
5070/* prepare workqueue_attrs for sysfs store operations */
5071static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5072{
5073 struct workqueue_attrs *attrs;
5074
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005075 lockdep_assert_held(&wq_pool_mutex);
5076
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005077 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5078 if (!attrs)
5079 return NULL;
5080
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005081 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005082 return attrs;
5083}
5084
5085static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5086 const char *buf, size_t count)
5087{
5088 struct workqueue_struct *wq = dev_to_wq(dev);
5089 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005090 int ret = -ENOMEM;
5091
5092 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005093
5094 attrs = wq_sysfs_prep_attrs(wq);
5095 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005096 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005097
5098 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5099 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005100 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005101 else
5102 ret = -EINVAL;
5103
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005104out_unlock:
5105 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005106 free_workqueue_attrs(attrs);
5107 return ret ?: count;
5108}
5109
5110static ssize_t wq_cpumask_show(struct device *dev,
5111 struct device_attribute *attr, char *buf)
5112{
5113 struct workqueue_struct *wq = dev_to_wq(dev);
5114 int written;
5115
5116 mutex_lock(&wq->mutex);
5117 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5118 cpumask_pr_args(wq->unbound_attrs->cpumask));
5119 mutex_unlock(&wq->mutex);
5120 return written;
5121}
5122
5123static ssize_t wq_cpumask_store(struct device *dev,
5124 struct device_attribute *attr,
5125 const char *buf, size_t count)
5126{
5127 struct workqueue_struct *wq = dev_to_wq(dev);
5128 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005129 int ret = -ENOMEM;
5130
5131 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005132
5133 attrs = wq_sysfs_prep_attrs(wq);
5134 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005135 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005136
5137 ret = cpumask_parse(buf, attrs->cpumask);
5138 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005139 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005140
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005141out_unlock:
5142 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005143 free_workqueue_attrs(attrs);
5144 return ret ?: count;
5145}
5146
5147static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5148 char *buf)
5149{
5150 struct workqueue_struct *wq = dev_to_wq(dev);
5151 int written;
5152
5153 mutex_lock(&wq->mutex);
5154 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5155 !wq->unbound_attrs->no_numa);
5156 mutex_unlock(&wq->mutex);
5157
5158 return written;
5159}
5160
5161static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5162 const char *buf, size_t count)
5163{
5164 struct workqueue_struct *wq = dev_to_wq(dev);
5165 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005166 int v, ret = -ENOMEM;
5167
5168 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005169
5170 attrs = wq_sysfs_prep_attrs(wq);
5171 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005172 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005173
5174 ret = -EINVAL;
5175 if (sscanf(buf, "%d", &v) == 1) {
5176 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005177 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005178 }
5179
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005180out_unlock:
5181 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005182 free_workqueue_attrs(attrs);
5183 return ret ?: count;
5184}
5185
5186static struct device_attribute wq_sysfs_unbound_attrs[] = {
5187 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5188 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5189 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5190 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5191 __ATTR_NULL,
5192};
5193
5194static struct bus_type wq_subsys = {
5195 .name = "workqueue",
5196 .dev_groups = wq_sysfs_groups,
5197};
5198
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005199static ssize_t wq_unbound_cpumask_show(struct device *dev,
5200 struct device_attribute *attr, char *buf)
5201{
5202 int written;
5203
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005204 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005205 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5206 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005207 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005208
5209 return written;
5210}
5211
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005212static ssize_t wq_unbound_cpumask_store(struct device *dev,
5213 struct device_attribute *attr, const char *buf, size_t count)
5214{
5215 cpumask_var_t cpumask;
5216 int ret;
5217
5218 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5219 return -ENOMEM;
5220
5221 ret = cpumask_parse(buf, cpumask);
5222 if (!ret)
5223 ret = workqueue_set_unbound_cpumask(cpumask);
5224
5225 free_cpumask_var(cpumask);
5226 return ret ? ret : count;
5227}
5228
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005229static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005230 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5231 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005232
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005233static int __init wq_sysfs_init(void)
5234{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005235 int err;
5236
5237 err = subsys_virtual_register(&wq_subsys, NULL);
5238 if (err)
5239 return err;
5240
5241 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005242}
5243core_initcall(wq_sysfs_init);
5244
5245static void wq_device_release(struct device *dev)
5246{
5247 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5248
5249 kfree(wq_dev);
5250}
5251
5252/**
5253 * workqueue_sysfs_register - make a workqueue visible in sysfs
5254 * @wq: the workqueue to register
5255 *
5256 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5257 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5258 * which is the preferred method.
5259 *
5260 * Workqueue user should use this function directly iff it wants to apply
5261 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5262 * apply_workqueue_attrs() may race against userland updating the
5263 * attributes.
5264 *
5265 * Return: 0 on success, -errno on failure.
5266 */
5267int workqueue_sysfs_register(struct workqueue_struct *wq)
5268{
5269 struct wq_device *wq_dev;
5270 int ret;
5271
5272 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305273 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005274 * attributes breaks ordering guarantee. Disallow exposing ordered
5275 * workqueues.
5276 */
Tejun Heof9636c92017-07-23 08:36:15 -04005277 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005278 return -EINVAL;
5279
5280 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5281 if (!wq_dev)
5282 return -ENOMEM;
5283
5284 wq_dev->wq = wq;
5285 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005286 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005287 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005288
5289 /*
5290 * unbound_attrs are created separately. Suppress uevent until
5291 * everything is ready.
5292 */
5293 dev_set_uevent_suppress(&wq_dev->dev, true);
5294
5295 ret = device_register(&wq_dev->dev);
5296 if (ret) {
Arvind Yadav30393942018-03-06 15:35:43 +05305297 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005298 wq->wq_dev = NULL;
5299 return ret;
5300 }
5301
5302 if (wq->flags & WQ_UNBOUND) {
5303 struct device_attribute *attr;
5304
5305 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5306 ret = device_create_file(&wq_dev->dev, attr);
5307 if (ret) {
5308 device_unregister(&wq_dev->dev);
5309 wq->wq_dev = NULL;
5310 return ret;
5311 }
5312 }
5313 }
5314
5315 dev_set_uevent_suppress(&wq_dev->dev, false);
5316 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5317 return 0;
5318}
5319
5320/**
5321 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5322 * @wq: the workqueue to unregister
5323 *
5324 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5325 */
5326static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5327{
5328 struct wq_device *wq_dev = wq->wq_dev;
5329
5330 if (!wq->wq_dev)
5331 return;
5332
5333 wq->wq_dev = NULL;
5334 device_unregister(&wq_dev->dev);
5335}
5336#else /* CONFIG_SYSFS */
5337static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5338#endif /* CONFIG_SYSFS */
5339
Tejun Heo82607adc2015-12-08 11:28:04 -05005340/*
5341 * Workqueue watchdog.
5342 *
5343 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5344 * flush dependency, a concurrency managed work item which stays RUNNING
5345 * indefinitely. Workqueue stalls can be very difficult to debug as the
5346 * usual warning mechanisms don't trigger and internal workqueue state is
5347 * largely opaque.
5348 *
5349 * Workqueue watchdog monitors all worker pools periodically and dumps
5350 * state if some pools failed to make forward progress for a while where
5351 * forward progress is defined as the first item on ->worklist changing.
5352 *
5353 * This mechanism is controlled through the kernel parameter
5354 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5355 * corresponding sysfs parameter file.
5356 */
5357#ifdef CONFIG_WQ_WATCHDOG
5358
5359static void wq_watchdog_timer_fn(unsigned long data);
5360
5361static unsigned long wq_watchdog_thresh = 30;
5362static struct timer_list wq_watchdog_timer =
5363 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5364
5365static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5366static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5367
5368static void wq_watchdog_reset_touched(void)
5369{
5370 int cpu;
5371
5372 wq_watchdog_touched = jiffies;
5373 for_each_possible_cpu(cpu)
5374 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5375}
5376
5377static void wq_watchdog_timer_fn(unsigned long data)
5378{
5379 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5380 bool lockup_detected = false;
5381 struct worker_pool *pool;
5382 int pi;
5383
5384 if (!thresh)
5385 return;
5386
5387 rcu_read_lock();
5388
5389 for_each_pool(pool, pi) {
5390 unsigned long pool_ts, touched, ts;
5391
5392 if (list_empty(&pool->worklist))
5393 continue;
5394
5395 /* get the latest of pool and touched timestamps */
5396 pool_ts = READ_ONCE(pool->watchdog_ts);
5397 touched = READ_ONCE(wq_watchdog_touched);
5398
5399 if (time_after(pool_ts, touched))
5400 ts = pool_ts;
5401 else
5402 ts = touched;
5403
5404 if (pool->cpu >= 0) {
5405 unsigned long cpu_touched =
5406 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5407 pool->cpu));
5408 if (time_after(cpu_touched, ts))
5409 ts = cpu_touched;
5410 }
5411
5412 /* did we stall? */
5413 if (time_after(jiffies, ts + thresh)) {
5414 lockup_detected = true;
5415 pr_emerg("BUG: workqueue lockup - pool");
5416 pr_cont_pool_info(pool);
5417 pr_cont(" stuck for %us!\n",
5418 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5419 }
5420 }
5421
5422 rcu_read_unlock();
5423
5424 if (lockup_detected)
5425 show_workqueue_state();
5426
5427 wq_watchdog_reset_touched();
5428 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5429}
5430
5431void wq_watchdog_touch(int cpu)
5432{
5433 if (cpu >= 0)
5434 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5435 else
5436 wq_watchdog_touched = jiffies;
5437}
5438
5439static void wq_watchdog_set_thresh(unsigned long thresh)
5440{
5441 wq_watchdog_thresh = 0;
5442 del_timer_sync(&wq_watchdog_timer);
5443
5444 if (thresh) {
5445 wq_watchdog_thresh = thresh;
5446 wq_watchdog_reset_touched();
5447 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5448 }
5449}
5450
5451static int wq_watchdog_param_set_thresh(const char *val,
5452 const struct kernel_param *kp)
5453{
5454 unsigned long thresh;
5455 int ret;
5456
5457 ret = kstrtoul(val, 0, &thresh);
5458 if (ret)
5459 return ret;
5460
5461 if (system_wq)
5462 wq_watchdog_set_thresh(thresh);
5463 else
5464 wq_watchdog_thresh = thresh;
5465
5466 return 0;
5467}
5468
5469static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5470 .set = wq_watchdog_param_set_thresh,
5471 .get = param_get_ulong,
5472};
5473
5474module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5475 0644);
5476
5477static void wq_watchdog_init(void)
5478{
5479 wq_watchdog_set_thresh(wq_watchdog_thresh);
5480}
5481
5482#else /* CONFIG_WQ_WATCHDOG */
5483
5484static inline void wq_watchdog_init(void) { }
5485
5486#endif /* CONFIG_WQ_WATCHDOG */
5487
Tejun Heobce90382013-04-01 11:23:32 -07005488static void __init wq_numa_init(void)
5489{
5490 cpumask_var_t *tbl;
5491 int node, cpu;
5492
Tejun Heobce90382013-04-01 11:23:32 -07005493 if (num_possible_nodes() <= 1)
5494 return;
5495
Tejun Heod55262c2013-04-01 11:23:38 -07005496 if (wq_disable_numa) {
5497 pr_info("workqueue: NUMA affinity support disabled\n");
5498 return;
5499 }
5500
Tejun Heo4c16bd32013-04-01 11:23:36 -07005501 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5502 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5503
Tejun Heobce90382013-04-01 11:23:32 -07005504 /*
5505 * We want masks of possible CPUs of each node which isn't readily
5506 * available. Build one from cpu_to_node() which should have been
5507 * fully initialized by now.
5508 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005509 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005510 BUG_ON(!tbl);
5511
5512 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005513 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005514 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005515
5516 for_each_possible_cpu(cpu) {
5517 node = cpu_to_node(cpu);
5518 if (WARN_ON(node == NUMA_NO_NODE)) {
5519 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5520 /* happens iff arch is bonkers, let's just proceed */
5521 return;
5522 }
5523 cpumask_set_cpu(cpu, tbl[node]);
5524 }
5525
5526 wq_numa_possible_cpumask = tbl;
5527 wq_numa_enabled = true;
5528}
5529
Suresh Siddha6ee05782010-07-30 14:57:37 -07005530static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005531{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005532 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5533 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005534
Tejun Heoe904e6c2013-03-12 11:29:57 -07005535 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5536
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005537 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5538 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5539
Tejun Heoe904e6c2013-03-12 11:29:57 -07005540 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5541
Tejun Heobce90382013-04-01 11:23:32 -07005542 wq_numa_init();
5543
Tejun Heo706026c2013-01-24 11:01:34 -08005544 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005545 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005546 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005547
Tejun Heo7a4e3442013-03-12 11:30:00 -07005548 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005549 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005550 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005551 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005552 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005553 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005554 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005555
Tejun Heo9daf9e62013-01-24 11:01:33 -08005556 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005557 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005558 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005559 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005560 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005561 }
5562
Tejun Heoe22bee72010-06-29 10:07:14 +02005563 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005564 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005565 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005566
Tejun Heof02ae732013-03-12 11:30:03 -07005567 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005568 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005569 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005570 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005571 }
5572
Tejun Heo8a2b7532013-09-05 12:30:04 -04005573 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005574 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5575 struct workqueue_attrs *attrs;
5576
5577 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005578 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005579 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005580
5581 /*
5582 * An ordered wq should have only one pwq as ordering is
5583 * guaranteed by max_active which is enforced by pwqs.
5584 * Turn off NUMA so that dfl_pwq is used for all nodes.
5585 */
5586 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5587 attrs->nice = std_nice[i];
5588 attrs->no_numa = true;
5589 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005590 }
5591
Tejun Heod320c032010-06-29 10:07:14 +02005592 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005593 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005594 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005595 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5596 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005597 system_freezable_wq = alloc_workqueue("events_freezable",
5598 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305599 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5600 WQ_POWER_EFFICIENT, 0);
5601 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5602 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5603 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005604 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305605 !system_unbound_wq || !system_freezable_wq ||
5606 !system_power_efficient_wq ||
5607 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005608
5609 wq_watchdog_init();
5610
Suresh Siddha6ee05782010-07-30 14:57:37 -07005611 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005612}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005613early_initcall(init_workqueues);