blob: 812b8f898759b8b3bbb7f2a3cc0f6899d1e40ac9 [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>
Pavankumar Kondeti0c0b7642017-01-04 10:41:15 +053051#include <linux/bug.h>
52#include <linux/delay.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020053
Tejun Heoea138442013-01-18 14:05:55 -080054#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Tejun Heoc8e55f32010-06-29 10:07:12 +020056enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 /*
Tejun Heo24647572013-01-24 11:01:33 -080058 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 *
Tejun Heo24647572013-01-24 11:01:33 -080060 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070061 * While associated (!DISASSOCIATED), all workers are bound to the
62 * CPU and none has %WORKER_UNBOUND set and concurrency management
63 * is in effect.
64 *
65 * While DISASSOCIATED, the cpu may be offline and all workers have
66 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080067 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070068 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070069 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080070 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080071 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070072 */
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 Heo34a06bd2013-03-12 11:30:00 -0700170 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400171 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800172 struct mutex attach_mutex; /* attach/detach exclusion */
173 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800174 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800175
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800176 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800177
Tejun Heo7a4e3442013-03-12 11:30:00 -0700178 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700179 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
180 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700181
Tejun Heoe19e3972013-01-24 11:39:44 -0800182 /*
183 * The current concurrency level. As it's likely to be accessed
184 * from other CPUs during try_to_wake_up(), put it in a separate
185 * cacheline.
186 */
187 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700188
189 /*
190 * Destruction of pool is sched-RCU protected to allow dereferences
191 * from get_work_pool().
192 */
193 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200194} ____cacheline_aligned_in_smp;
195
196/*
Tejun Heo112202d2013-02-13 19:29:12 -0800197 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
198 * of work_struct->data are used for flags and the remaining high bits
199 * point to the pwq; thus, pwqs need to be aligned at two's power of the
200 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
Tejun Heo112202d2013-02-13 19:29:12 -0800202struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700203 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200204 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200205 int work_color; /* L: current color */
206 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700207 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200208 int nr_in_flight[WORK_NR_COLORS];
209 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200210 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200211 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200212 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700213 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700214 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700215
216 /*
217 * Release of unbound pwq is punted to system_wq. See put_pwq()
218 * and pwq_unbound_release_workfn() for details. pool_workqueue
219 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700220 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700221 */
222 struct work_struct unbound_release_work;
223 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700224} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200227 * Structure used to wait for workqueue flush.
228 */
229struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700230 struct list_head list; /* WQ: list of flushers */
231 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200232 struct completion done; /* flush completion */
233};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Tejun Heo226223a2013-03-12 11:30:05 -0700235struct wq_device;
236
Tejun Heo73f53c42010-06-29 10:07:11 +0200237/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700238 * The externally visible workqueue. It relays the issued work items to
239 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 */
241struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700242 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400243 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200244
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct mutex mutex; /* protects this wq */
246 int work_color; /* WQ: current work color */
247 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800248 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700249 struct wq_flusher *first_flusher; /* WQ: first flusher */
250 struct list_head flusher_queue; /* WQ: flush waiters */
251 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200252
Tejun Heo2e109a22013-03-13 19:47:40 -0700253 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200254 struct worker *rescuer; /* I: rescue worker */
255
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700256 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700257 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700258
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800259 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
260 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700261
Tejun Heo226223a2013-03-12 11:30:05 -0700262#ifdef CONFIG_SYSFS
263 struct wq_device *wq_dev; /* I: for sysfs interface */
264#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200266 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700267#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700268 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700269
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400270 /*
271 * Destruction of workqueue_struct is sched-RCU protected to allow
272 * walking the workqueues list without grabbing wq_pool_mutex.
273 * This is used to dump all workqueues from sysrq.
274 */
275 struct rcu_head rcu;
276
Tejun Heo2728fd22013-04-01 11:23:35 -0700277 /* hot fields used during command issue, aligned to cacheline */
278 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
279 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800280 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
Tejun Heoe904e6c2013-03-12 11:29:57 -0700283static struct kmem_cache *pwq_cache;
284
Tejun Heobce90382013-04-01 11:23:32 -0700285static cpumask_var_t *wq_numa_possible_cpumask;
286 /* possible CPUs of each node */
287
Tejun Heod55262c2013-04-01 11:23:38 -0700288static bool wq_disable_numa;
289module_param_named(disable_numa, wq_disable_numa, bool, 0444);
290
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930292static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530293module_param_named(power_efficient, wq_power_efficient, bool, 0444);
294
Tejun Heobce90382013-04-01 11:23:32 -0700295static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
296
Tejun Heo4c16bd32013-04-01 11:23:36 -0700297/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
298static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
299
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700300static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700301static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
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 Heo34a06bd2013-03-12 11:30:00 -0700804 bool managing = mutex_is_locked(&pool->manager_arb);
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();
Pavankumar Kondeti0c0b7642017-01-04 10:41:15 +05301277 /*
1278 * The queueing is in progress in another context. If we keep
1279 * taking the pool->lock in a busy loop, the other context may
1280 * never get the lock. Give 1 usec delay to avoid this contention.
1281 */
1282 udelay(1);
Tejun Heo36e227d2012-08-03 10:30:46 -07001283 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001284}
1285
1286/**
Tejun Heo706026c2013-01-24 11:01:34 -08001287 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001288 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001289 * @work: work to insert
1290 * @head: insertion point
1291 * @extra_flags: extra WORK_STRUCT_* flags to set
1292 *
Tejun Heo112202d2013-02-13 19:29:12 -08001293 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001294 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001295 *
1296 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001297 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001298 */
Tejun Heo112202d2013-02-13 19:29:12 -08001299static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1300 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001301{
Tejun Heo112202d2013-02-13 19:29:12 -08001302 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001303
Tejun Heo4690c4a2010-06-29 10:07:10 +02001304 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001305 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001306 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001307 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001308
1309 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001310 * Ensure either wq_worker_sleeping() sees the above
1311 * list_add_tail() or we see zero nr_running to avoid workers lying
1312 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001313 */
1314 smp_mb();
1315
Tejun Heo63d95a92012-07-12 14:46:37 -07001316 if (__need_more_worker(pool))
1317 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001318}
1319
Tejun Heoc8efcc22010-12-20 19:32:04 +01001320/*
1321 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001322 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001323 */
1324static bool is_chained_work(struct workqueue_struct *wq)
1325{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001326 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001327
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001328 worker = current_wq_worker();
1329 /*
1330 * Return %true iff I'm a worker execuing a work item on @wq. If
1331 * I'm @worker, it's safe to dereference it without locking.
1332 */
Tejun Heo112202d2013-02-13 19:29:12 -08001333 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001334}
1335
Mike Galbraithef5571802016-02-09 17:59:38 -05001336/*
1337 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1338 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1339 * avoid perturbing sensitive tasks.
1340 */
1341static int wq_select_unbound_cpu(int cpu)
1342{
Tejun Heof303fcc2016-02-09 17:59:38 -05001343 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001344 int new_cpu;
1345
Tejun Heof303fcc2016-02-09 17:59:38 -05001346 if (likely(!wq_debug_force_rr_cpu)) {
1347 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1348 return cpu;
1349 } else if (!printed_dbg_warning) {
1350 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1351 printed_dbg_warning = true;
1352 }
1353
Mike Galbraithef5571802016-02-09 17:59:38 -05001354 if (cpumask_empty(wq_unbound_cpumask))
1355 return cpu;
1356
1357 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1358 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1359 if (unlikely(new_cpu >= nr_cpu_ids)) {
1360 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1361 if (unlikely(new_cpu >= nr_cpu_ids))
1362 return cpu;
1363 }
1364 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1365
1366 return new_cpu;
1367}
1368
Tejun Heod84ff052013-03-12 11:29:59 -07001369static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 struct work_struct *work)
1371{
Tejun Heo112202d2013-02-13 19:29:12 -08001372 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001373 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001374 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001375 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001376 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001377
1378 /*
1379 * While a work item is PENDING && off queue, a task trying to
1380 * steal the PENDING will busy-loop waiting for it to either get
1381 * queued or lose PENDING. Grabbing PENDING and queueing should
1382 * happen with IRQ disabled.
1383 */
1384 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001386 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001387
Li Bin9ef28a72013-09-09 13:13:58 +08001388 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001389 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001390 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001391 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001392retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001394 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001395
Tejun Heoc9178082013-03-12 11:30:04 -07001396 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001397 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001398 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001399 else
1400 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001401
Tejun Heoc9178082013-03-12 11:30:04 -07001402 /*
1403 * If @work was previously on a different pool, it might still be
1404 * running there, in which case the work needs to be queued on that
1405 * pool to guarantee non-reentrancy.
1406 */
1407 last_pool = get_work_pool(work);
1408 if (last_pool && last_pool != pwq->pool) {
1409 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001410
Tejun Heoc9178082013-03-12 11:30:04 -07001411 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001412
Tejun Heoc9178082013-03-12 11:30:04 -07001413 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001414
Tejun Heoc9178082013-03-12 11:30:04 -07001415 if (worker && worker->current_pwq->wq == wq) {
1416 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001417 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001418 /* meh... not running there, queue here */
1419 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001420 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001421 }
Tejun Heof3421792010-07-02 10:03:51 +02001422 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001423 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001424 }
1425
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001426 /*
1427 * pwq is determined and locked. For unbound pools, we could have
1428 * raced with pwq release and it could already be dead. If its
1429 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001430 * without another pwq replacing it in the numa_pwq_tbl or while
1431 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001432 * make forward-progress.
1433 */
1434 if (unlikely(!pwq->refcnt)) {
1435 if (wq->flags & WQ_UNBOUND) {
1436 spin_unlock(&pwq->pool->lock);
1437 cpu_relax();
1438 goto retry;
1439 }
1440 /* oops */
1441 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1442 wq->name, cpu);
1443 }
1444
Tejun Heo112202d2013-02-13 19:29:12 -08001445 /* pwq determined, queue */
1446 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001447
Dan Carpenterf5b25522012-04-13 22:06:58 +03001448 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001449 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001450 return;
1451 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001452
Tejun Heo112202d2013-02-13 19:29:12 -08001453 pwq->nr_in_flight[pwq->work_color]++;
1454 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001455
Tejun Heo112202d2013-02-13 19:29:12 -08001456 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001457 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001458 pwq->nr_active++;
1459 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001460 if (list_empty(worklist))
1461 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001462 } else {
1463 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001464 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001465 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001466
Tejun Heo112202d2013-02-13 19:29:12 -08001467 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001468
Tejun Heo112202d2013-02-13 19:29:12 -08001469 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470}
1471
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001472/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001473 * queue_work_on - queue work on specific cpu
1474 * @cpu: CPU number to execute work on
1475 * @wq: workqueue to use
1476 * @work: work to queue
1477 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001478 * We queue the work to a specific CPU, the caller must ensure it
1479 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001480 *
1481 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001482 */
Tejun Heod4283e92012-08-03 10:30:44 -07001483bool queue_work_on(int cpu, struct workqueue_struct *wq,
1484 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001485{
Tejun Heod4283e92012-08-03 10:30:44 -07001486 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001487 unsigned long flags;
1488
1489 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001490
Tejun Heo22df02b2010-06-29 10:07:10 +02001491 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001492 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001493 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001495
1496 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001497 return ret;
1498}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001499EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001500
Tejun Heod8e794d2012-08-03 10:30:45 -07001501void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502{
David Howells52bad642006-11-22 14:54:01 +00001503 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001505 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001506 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001508EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001510static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1511 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001513 struct timer_list *timer = &dwork->timer;
1514 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001516 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1517 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001518 WARN_ON_ONCE(timer_pending(timer));
1519 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001520
Tejun Heo8852aac2012-12-01 16:23:42 -08001521 /*
1522 * If @delay is 0, queue @dwork->work immediately. This is for
1523 * both optimization and correctness. The earliest @timer can
1524 * expire is on the closest next tick and delayed_work users depend
1525 * on that there's no such delay when @delay is 0.
1526 */
1527 if (!delay) {
1528 __queue_work(cpu, wq, &dwork->work);
1529 return;
1530 }
1531
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001532 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001533 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001534 timer->expires = jiffies + delay;
1535
Tejun Heo041bd122016-02-09 16:11:26 -05001536 if (unlikely(cpu != WORK_CPU_UNBOUND))
1537 add_timer_on(timer, cpu);
1538 else
1539 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540}
1541
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001542/**
1543 * queue_delayed_work_on - queue work on specific CPU after delay
1544 * @cpu: CPU number to execute work on
1545 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001546 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001547 * @delay: number of jiffies to wait before queueing
1548 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001549 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001550 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1551 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001552 */
Tejun Heod4283e92012-08-03 10:30:44 -07001553bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1554 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001555{
David Howells52bad642006-11-22 14:54:01 +00001556 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001557 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001558 unsigned long flags;
1559
1560 /* read the comment in __queue_work() */
1561 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001562
Tejun Heo22df02b2010-06-29 10:07:10 +02001563 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001564 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001565 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001566 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001567
1568 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001569 return ret;
1570}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001571EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Tejun Heoc8e55f32010-06-29 10:07:12 +02001573/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001574 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1575 * @cpu: CPU number to execute work on
1576 * @wq: workqueue to use
1577 * @dwork: work to queue
1578 * @delay: number of jiffies to wait before queueing
1579 *
1580 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1581 * modify @dwork's timer so that it expires after @delay. If @delay is
1582 * zero, @work is guaranteed to be scheduled immediately regardless of its
1583 * current state.
1584 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001585 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001586 * pending and its timer was modified.
1587 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001588 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001589 * See try_to_grab_pending() for details.
1590 */
1591bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1592 struct delayed_work *dwork, unsigned long delay)
1593{
1594 unsigned long flags;
1595 int ret;
1596
1597 do {
1598 ret = try_to_grab_pending(&dwork->work, true, &flags);
1599 } while (unlikely(ret == -EAGAIN));
1600
1601 if (likely(ret >= 0)) {
1602 __queue_delayed_work(cpu, wq, dwork, delay);
1603 local_irq_restore(flags);
1604 }
1605
1606 /* -ENOENT from try_to_grab_pending() becomes %true */
1607 return ret;
1608}
1609EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1610
1611/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001612 * worker_enter_idle - enter idle state
1613 * @worker: worker which is entering idle state
1614 *
1615 * @worker is entering idle state. Update stats and idle timer if
1616 * necessary.
1617 *
1618 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001619 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001620 */
1621static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001623 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Tejun Heo6183c002013-03-12 11:29:57 -07001625 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1626 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1627 (worker->hentry.next || worker->hentry.pprev)))
1628 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Lai Jiangshan051e1852014-07-22 13:03:02 +08001630 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001631 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001632 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001633 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001634
Tejun Heoc8e55f32010-06-29 10:07:12 +02001635 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001636 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001637
Tejun Heo628c78e2012-07-17 12:39:27 -07001638 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1639 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001640
Tejun Heo544ecf32012-05-14 15:04:50 -07001641 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001642 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001643 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001644 * nr_running, the warning may trigger spuriously. Check iff
1645 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001646 */
Tejun Heo24647572013-01-24 11:01:33 -08001647 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001648 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001649 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650}
1651
Tejun Heoc8e55f32010-06-29 10:07:12 +02001652/**
1653 * worker_leave_idle - leave idle state
1654 * @worker: worker which is leaving idle state
1655 *
1656 * @worker is leaving idle state. Update stats.
1657 *
1658 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001659 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001660 */
1661static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001663 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664
Tejun Heo6183c002013-03-12 11:29:57 -07001665 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1666 return;
Tejun Heod302f012010-06-29 10:07:13 +02001667 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001668 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001669 list_del_init(&worker->entry);
1670}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001672static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001673{
1674 struct worker *worker;
1675
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001676 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001677 if (worker) {
1678 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001679 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001680 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001681 /* on creation a worker is in !idle && prep state */
1682 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001683 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001684 return worker;
1685}
1686
1687/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001688 * worker_attach_to_pool() - attach a worker to a pool
1689 * @worker: worker to be attached
1690 * @pool: the target pool
1691 *
1692 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1693 * cpu-binding of @worker are kept coordinated with the pool across
1694 * cpu-[un]hotplugs.
1695 */
1696static void worker_attach_to_pool(struct worker *worker,
1697 struct worker_pool *pool)
1698{
1699 mutex_lock(&pool->attach_mutex);
1700
1701 /*
1702 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1703 * online CPUs. It'll be re-applied when any of the CPUs come up.
1704 */
1705 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1706
1707 /*
1708 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1709 * stable across this function. See the comments above the
1710 * flag definition for details.
1711 */
1712 if (pool->flags & POOL_DISASSOCIATED)
1713 worker->flags |= WORKER_UNBOUND;
1714
1715 list_add_tail(&worker->node, &pool->workers);
1716
1717 mutex_unlock(&pool->attach_mutex);
1718}
1719
1720/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001721 * worker_detach_from_pool() - detach a worker from its pool
1722 * @worker: worker which is attached to its pool
1723 * @pool: the pool @worker is attached to
1724 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001725 * Undo the attaching which had been done in worker_attach_to_pool(). The
1726 * caller worker shouldn't access to the pool after detached except it has
1727 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001728 */
1729static void worker_detach_from_pool(struct worker *worker,
1730 struct worker_pool *pool)
1731{
1732 struct completion *detach_completion = NULL;
1733
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001734 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001735 list_del(&worker->node);
1736 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001737 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001738 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001739
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001740 /* clear leftover flags without pool->lock after it is detached */
1741 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1742
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001743 if (detach_completion)
1744 complete(detach_completion);
1745}
1746
1747/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001748 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001749 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001750 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001751 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001752 *
1753 * CONTEXT:
1754 * Might sleep. Does GFP_KERNEL allocations.
1755 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001756 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001757 * Pointer to the newly created worker.
1758 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001759static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001760{
Tejun Heoc34056a2010-06-29 10:07:11 +02001761 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001762 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001763 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001764
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001765 /* ID is needed to determine kthread name */
1766 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001767 if (id < 0)
1768 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001769
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001770 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001771 if (!worker)
1772 goto fail;
1773
Tejun Heobd7bdd42012-07-12 14:46:37 -07001774 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001775 worker->id = id;
1776
Tejun Heo29c91e92013-03-12 11:30:03 -07001777 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001778 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1779 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001780 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001781 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1782
Tejun Heof3f90ad2013-04-01 11:23:34 -07001783 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001784 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001785 if (IS_ERR(worker->task))
1786 goto fail;
1787
Oleg Nesterov91151222013-11-14 12:56:18 +01001788 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001789 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001790
Lai Jiangshanda028462014-05-20 17:46:31 +08001791 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001792 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001793
Lai Jiangshan051e1852014-07-22 13:03:02 +08001794 /* start the newly created worker */
1795 spin_lock_irq(&pool->lock);
1796 worker->pool->nr_workers++;
1797 worker_enter_idle(worker);
1798 wake_up_process(worker->task);
1799 spin_unlock_irq(&pool->lock);
1800
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001802
Tejun Heoc34056a2010-06-29 10:07:11 +02001803fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001804 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001805 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001806 kfree(worker);
1807 return NULL;
1808}
1809
1810/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001811 * destroy_worker - destroy a workqueue worker
1812 * @worker: worker to be destroyed
1813 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001814 * Destroy @worker and adjust @pool stats accordingly. The worker should
1815 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001816 *
1817 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001818 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001819 */
1820static void destroy_worker(struct worker *worker)
1821{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001822 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001823
Tejun Heocd549682013-03-13 19:47:39 -07001824 lockdep_assert_held(&pool->lock);
1825
Tejun Heoc34056a2010-06-29 10:07:11 +02001826 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001827 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001828 WARN_ON(!list_empty(&worker->scheduled)) ||
1829 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001830 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001831
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001832 pool->nr_workers--;
1833 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001834
Tejun Heoc8e55f32010-06-29 10:07:12 +02001835 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001836 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001837 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001838}
1839
Tejun Heo63d95a92012-07-12 14:46:37 -07001840static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001841{
Tejun Heo63d95a92012-07-12 14:46:37 -07001842 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001843
Tejun Heod565ed62013-01-24 11:01:33 -08001844 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001845
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001846 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001847 struct worker *worker;
1848 unsigned long expires;
1849
1850 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001851 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001852 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1853
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001854 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001855 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001856 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001857 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001858
1859 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001860 }
1861
Tejun Heod565ed62013-01-24 11:01:33 -08001862 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001863}
1864
Tejun Heo493a1722013-03-12 11:29:59 -07001865static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001866{
Tejun Heo112202d2013-02-13 19:29:12 -08001867 struct pool_workqueue *pwq = get_work_pwq(work);
1868 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001869
Tejun Heo2e109a22013-03-13 19:47:40 -07001870 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001871
Tejun Heo493008a2013-03-12 11:30:03 -07001872 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001873 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001874
1875 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001876 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001877 /*
1878 * If @pwq is for an unbound wq, its base ref may be put at
1879 * any time due to an attribute change. Pin @pwq until the
1880 * rescuer is done with it.
1881 */
1882 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001883 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001884 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001885 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001886}
1887
Tejun Heo706026c2013-01-24 11:01:34 -08001888static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001889{
Tejun Heo63d95a92012-07-12 14:46:37 -07001890 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001891 struct work_struct *work;
1892
Tejun Heob2d82902014-12-08 12:39:16 -05001893 spin_lock_irq(&pool->lock);
1894 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001895
Tejun Heo63d95a92012-07-12 14:46:37 -07001896 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001897 /*
1898 * We've been trying to create a new worker but
1899 * haven't been successful. We might be hitting an
1900 * allocation deadlock. Send distress signals to
1901 * rescuers.
1902 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001903 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001904 send_mayday(work);
1905 }
1906
Tejun Heob2d82902014-12-08 12:39:16 -05001907 spin_unlock(&wq_mayday_lock);
1908 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001909
Tejun Heo63d95a92012-07-12 14:46:37 -07001910 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001911}
1912
1913/**
1914 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001915 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001916 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 * have at least one idle worker on return from this function. If
1919 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001920 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 * possible allocation deadlock.
1922 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001923 * On return, need_to_create_worker() is guaranteed to be %false and
1924 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 *
1926 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001927 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001928 * multiple times. Does GFP_KERNEL allocations. Called only from
1929 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001930 */
Tejun Heo29187a92015-01-16 14:21:16 -05001931static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001932__releases(&pool->lock)
1933__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001934{
Tejun Heoe22bee72010-06-29 10:07:14 +02001935restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001936 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001937
Tejun Heoe22bee72010-06-29 10:07:14 +02001938 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001939 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001940
1941 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001942 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 break;
1944
Lai Jiangshane212f362014-06-03 15:32:17 +08001945 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001946
Tejun Heo63d95a92012-07-12 14:46:37 -07001947 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001948 break;
1949 }
1950
Tejun Heo63d95a92012-07-12 14:46:37 -07001951 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001952 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001953 /*
1954 * This is necessary even after a new worker was just successfully
1955 * created as @pool->lock was dropped and the new worker might have
1956 * already become busy.
1957 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001960}
1961
1962/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001963 * manage_workers - manage worker pool
1964 * @worker: self
1965 *
Tejun Heo706026c2013-01-24 11:01:34 -08001966 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001968 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001969 *
1970 * The caller can safely start processing works on false return. On
1971 * true return, it's guaranteed that need_to_create_worker() is false
1972 * and may_start_working() is true.
1973 *
1974 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001975 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001976 * multiple times. Does GFP_KERNEL allocations.
1977 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001978 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001979 * %false if the pool doesn't need management and the caller can safely
1980 * start processing works, %true if management function was performed and
1981 * the conditions that the caller verified before calling the function may
1982 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001983 */
1984static bool manage_workers(struct worker *worker)
1985{
Tejun Heo63d95a92012-07-12 14:46:37 -07001986 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001987
Tejun Heobc3a1af2013-03-13 19:47:39 -07001988 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001989 * Anyone who successfully grabs manager_arb wins the arbitration
1990 * and becomes the manager. mutex_trylock() on pool->manager_arb
1991 * failure while holding pool->lock reliably indicates that someone
1992 * else is managing the pool and the worker which failed trylock
1993 * can proceed to executing work items. This means that anyone
1994 * grabbing manager_arb is responsible for actually performing
1995 * manager duties. If manager_arb is grabbed and released without
1996 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001997 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001998 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001999 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002000 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002001
Tejun Heo29187a92015-01-16 14:21:16 -05002002 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002003
Tejun Heo2607d7a2015-03-09 09:22:28 -04002004 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07002005 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05002006 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002007}
2008
Tejun Heoa62428c2010-06-29 10:07:10 +02002009/**
2010 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002011 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002012 * @work: work to process
2013 *
2014 * Process @work. This function contains all the logics necessary to
2015 * process a single work including synchronization against and
2016 * interaction with other workers on the same cpu, queueing and
2017 * flushing. As long as context requirement is met, any worker can
2018 * call this function to process a work.
2019 *
2020 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002021 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002022 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002023static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002024__releases(&pool->lock)
2025__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002026{
Tejun Heo112202d2013-02-13 19:29:12 -08002027 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002028 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002029 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002030 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002031 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002032#ifdef CONFIG_LOCKDEP
2033 /*
2034 * It is permissible to free the struct work_struct from
2035 * inside the function that is called from it, this we need to
2036 * take into account for lockdep too. To avoid bogus "held
2037 * lock freed" warnings as well as problems when looking into
2038 * work->lockdep_map, make a copy and use that here.
2039 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002040 struct lockdep_map lockdep_map;
2041
2042 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002043#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002044 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002045 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002046 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002047
Tejun Heo7e116292010-06-29 10:07:13 +02002048 /*
2049 * A single work shouldn't be executed concurrently by
2050 * multiple workers on a single cpu. Check whether anyone is
2051 * already processing the work. If so, defer the work to the
2052 * currently executing one.
2053 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002054 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002055 if (unlikely(collision)) {
2056 move_linked_works(work, &collision->scheduled, NULL);
2057 return;
2058 }
2059
Tejun Heo8930cab2012-08-03 10:30:45 -07002060 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002061 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002062 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002063 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002064 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002065 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002066 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002067
Tejun Heoa62428c2010-06-29 10:07:10 +02002068 list_del_init(&work->entry);
2069
Tejun Heo649027d2010-06-29 10:07:14 +02002070 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002071 * CPU intensive works don't participate in concurrency management.
2072 * They're the scheduler's responsibility. This takes @worker out
2073 * of concurrency management and the next code block will chain
2074 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002075 */
2076 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002077 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002078
Tejun Heo974271c2012-07-12 14:46:37 -07002079 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002080 * Wake up another worker if necessary. The condition is always
2081 * false for normal per-cpu workers since nr_running would always
2082 * be >= 1 at this point. This is used to chain execution of the
2083 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002084 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002085 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002086 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002087 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002088
Tejun Heo8930cab2012-08-03 10:30:45 -07002089 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002090 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002091 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002092 * PENDING and queued state changes happen together while IRQ is
2093 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002094 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002095 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002096
Tejun Heod565ed62013-01-24 11:01:33 -08002097 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002098
Tejun Heo112202d2013-02-13 19:29:12 -08002099 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002100 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002101 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002102 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002103 /*
2104 * While we must be careful to not use "work" after this, the trace
2105 * point will only record its address.
2106 */
2107 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002108 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002109 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002110
2111 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002112 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2113 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002114 current->comm, preempt_count(), task_pid_nr(current),
2115 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002116 debug_show_held_locks(current);
Syed Rameez Mustafacf9c1e42013-07-15 11:52:09 -07002117 BUG_ON(PANIC_CORRUPTION);
Tejun Heoa62428c2010-06-29 10:07:10 +02002118 dump_stack();
2119 }
2120
Tejun Heob22ce272013-08-28 17:33:37 -04002121 /*
2122 * The following prevents a kworker from hogging CPU on !PREEMPT
2123 * kernels, where a requeueing work item waiting for something to
2124 * happen could deadlock with stop_machine as such work item could
2125 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002126 * stop_machine. At the same time, report a quiescent RCU state so
2127 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002128 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002129 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002130
Tejun Heod565ed62013-01-24 11:01:33 -08002131 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002132
Tejun Heofb0e7be2010-06-29 10:07:15 +02002133 /* clear cpu intensive status */
2134 if (unlikely(cpu_intensive))
2135 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2136
Tejun Heoa62428c2010-06-29 10:07:10 +02002137 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002138 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002139 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002140 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002141 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002142 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002143 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002144}
2145
Tejun Heoaffee4b2010-06-29 10:07:12 +02002146/**
2147 * process_scheduled_works - process scheduled works
2148 * @worker: self
2149 *
2150 * Process all scheduled works. Please note that the scheduled list
2151 * may change while processing a work, so this function repeatedly
2152 * fetches a work from the top and executes it.
2153 *
2154 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002155 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002156 * multiple times.
2157 */
2158static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002160 while (!list_empty(&worker->scheduled)) {
2161 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002163 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165}
2166
Tejun Heo4690c4a2010-06-29 10:07:10 +02002167/**
2168 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002169 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002170 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002171 * The worker thread function. All workers belong to a worker_pool -
2172 * either a per-cpu one or dynamic unbound one. These workers process all
2173 * work items regardless of their specific target workqueue. The only
2174 * exception is work items which belong to workqueues with a rescuer which
2175 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002176 *
2177 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002178 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002179static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180{
Tejun Heoc34056a2010-06-29 10:07:11 +02002181 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002182 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183
Tejun Heoe22bee72010-06-29 10:07:14 +02002184 /* tell the scheduler that this is a workqueue worker */
2185 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002186woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002187 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002188
Tejun Heoa9ab7752013-03-19 13:45:21 -07002189 /* am I supposed to die? */
2190 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002191 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002192 WARN_ON_ONCE(!list_empty(&worker->entry));
2193 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002194
2195 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002196 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002197 worker_detach_from_pool(worker, pool);
2198 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002199 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002201
Tejun Heoc8e55f32010-06-29 10:07:12 +02002202 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002203recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002204 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002205 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002206 goto sleep;
2207
2208 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002209 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002210 goto recheck;
2211
Tejun Heoc8e55f32010-06-29 10:07:12 +02002212 /*
2213 * ->scheduled list can only be filled while a worker is
2214 * preparing to process a work or actually processing it.
2215 * Make sure nobody diddled with it while I was sleeping.
2216 */
Tejun Heo6183c002013-03-12 11:29:57 -07002217 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002218
Tejun Heoe22bee72010-06-29 10:07:14 +02002219 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002220 * Finish PREP stage. We're guaranteed to have at least one idle
2221 * worker or that someone else has already assumed the manager
2222 * role. This is where @worker starts participating in concurrency
2223 * management if applicable and concurrency management is restored
2224 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002225 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002226 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002227
2228 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002229 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002230 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002231 struct work_struct, entry);
2232
Tejun Heo82607adc2015-12-08 11:28:04 -05002233 pool->watchdog_ts = jiffies;
2234
Tejun Heoc8e55f32010-06-29 10:07:12 +02002235 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2236 /* optimization path, not strictly necessary */
2237 process_one_work(worker, work);
2238 if (unlikely(!list_empty(&worker->scheduled)))
2239 process_scheduled_works(worker);
2240 } else {
2241 move_linked_works(work, &worker->scheduled, NULL);
2242 process_scheduled_works(worker);
2243 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002244 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002246 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002247sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002248 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002249 * pool->lock is held and there's no work to process and no need to
2250 * manage, sleep. Workers are woken up only while holding
2251 * pool->lock or from local cpu, so setting the current state
2252 * before releasing pool->lock is enough to prevent losing any
2253 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002254 */
2255 worker_enter_idle(worker);
2256 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002257 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002258 schedule();
2259 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260}
2261
Tejun Heoe22bee72010-06-29 10:07:14 +02002262/**
2263 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002264 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002265 *
2266 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002267 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002268 *
Tejun Heo706026c2013-01-24 11:01:34 -08002269 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002270 * worker which uses GFP_KERNEL allocation which has slight chance of
2271 * developing into deadlock if some works currently on the same queue
2272 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2273 * the problem rescuer solves.
2274 *
Tejun Heo706026c2013-01-24 11:01:34 -08002275 * When such condition is possible, the pool summons rescuers of all
2276 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002277 * those works so that forward progress can be guaranteed.
2278 *
2279 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002280 *
2281 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002282 */
Tejun Heo111c2252013-01-17 17:16:24 -08002283static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002284{
Tejun Heo111c2252013-01-17 17:16:24 -08002285 struct worker *rescuer = __rescuer;
2286 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002287 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002288 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002289
2290 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002291
2292 /*
2293 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2294 * doesn't participate in concurrency management.
2295 */
2296 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002297repeat:
2298 set_current_state(TASK_INTERRUPTIBLE);
2299
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002300 /*
2301 * By the time the rescuer is requested to stop, the workqueue
2302 * shouldn't have any work pending, but @wq->maydays may still have
2303 * pwq(s) queued. This can happen by non-rescuer workers consuming
2304 * all the work items before the rescuer got to them. Go through
2305 * @wq->maydays processing before acting on should_stop so that the
2306 * list is always empty on exit.
2307 */
2308 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002309
Tejun Heo493a1722013-03-12 11:29:59 -07002310 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002311 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002312
2313 while (!list_empty(&wq->maydays)) {
2314 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2315 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002316 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002317 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002318 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002319
2320 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002321 list_del_init(&pwq->mayday_node);
2322
Tejun Heo2e109a22013-03-13 19:47:40 -07002323 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002324
Lai Jiangshan51697d392014-05-20 17:46:36 +08002325 worker_attach_to_pool(rescuer, pool);
2326
2327 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002328 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002329
2330 /*
2331 * Slurp in all works issued via this workqueue and
2332 * process'em.
2333 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002334 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002335 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2336 if (get_work_pwq(work) == pwq) {
2337 if (first)
2338 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002339 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002340 }
2341 first = false;
2342 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002343
NeilBrown008847f2014-12-08 12:39:16 -05002344 if (!list_empty(scheduled)) {
2345 process_scheduled_works(rescuer);
2346
2347 /*
2348 * The above execution of rescued work items could
2349 * have created more to rescue through
2350 * pwq_activate_first_delayed() or chained
2351 * queueing. Let's put @pwq back on mayday list so
2352 * that such back-to-back work items, which may be
2353 * being used to relieve memory pressure, don't
2354 * incur MAYDAY_INTERVAL delay inbetween.
2355 */
2356 if (need_to_create_worker(pool)) {
2357 spin_lock(&wq_mayday_lock);
2358 get_pwq(pwq);
2359 list_move_tail(&pwq->mayday_node, &wq->maydays);
2360 spin_unlock(&wq_mayday_lock);
2361 }
2362 }
Tejun Heo75769582011-02-14 14:04:46 +01002363
2364 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002365 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002366 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002367 */
2368 put_pwq(pwq);
2369
2370 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002371 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002372 * regular worker; otherwise, we end up with 0 concurrency
2373 * and stalling the execution.
2374 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002375 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002376 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002377
Lai Jiangshanb3104102013-02-19 12:17:02 -08002378 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002379 spin_unlock_irq(&pool->lock);
2380
2381 worker_detach_from_pool(rescuer, pool);
2382
2383 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002384 }
2385
Tejun Heo2e109a22013-03-13 19:47:40 -07002386 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002387
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002388 if (should_stop) {
2389 __set_current_state(TASK_RUNNING);
2390 rescuer->task->flags &= ~PF_WQ_WORKER;
2391 return 0;
2392 }
2393
Tejun Heo111c2252013-01-17 17:16:24 -08002394 /* rescuers should never participate in concurrency management */
2395 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002396 schedule();
2397 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398}
2399
Tejun Heofca839c2015-12-07 10:58:57 -05002400/**
2401 * check_flush_dependency - check for flush dependency sanity
2402 * @target_wq: workqueue being flushed
2403 * @target_work: work item being flushed (NULL for workqueue flushes)
2404 *
2405 * %current is trying to flush the whole @target_wq or @target_work on it.
2406 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2407 * reclaiming memory or running on a workqueue which doesn't have
2408 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2409 * a deadlock.
2410 */
2411static void check_flush_dependency(struct workqueue_struct *target_wq,
2412 struct work_struct *target_work)
2413{
2414 work_func_t target_func = target_work ? target_work->func : NULL;
2415 struct worker *worker;
2416
2417 if (target_wq->flags & WQ_MEM_RECLAIM)
2418 return;
2419
2420 worker = current_wq_worker();
2421
2422 WARN_ONCE(current->flags & PF_MEMALLOC,
2423 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2424 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002425 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2426 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002427 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2428 worker->current_pwq->wq->name, worker->current_func,
2429 target_wq->name, target_func);
2430}
2431
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002432struct wq_barrier {
2433 struct work_struct work;
2434 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002435 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002436};
2437
2438static void wq_barrier_func(struct work_struct *work)
2439{
2440 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2441 complete(&barr->done);
2442}
2443
Tejun Heo4690c4a2010-06-29 10:07:10 +02002444/**
2445 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002446 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002447 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002448 * @target: target work to attach @barr to
2449 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002450 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002451 * @barr is linked to @target such that @barr is completed only after
2452 * @target finishes execution. Please note that the ordering
2453 * guarantee is observed only with respect to @target and on the local
2454 * cpu.
2455 *
2456 * Currently, a queued barrier can't be canceled. This is because
2457 * try_to_grab_pending() can't determine whether the work to be
2458 * grabbed is at the head of the queue and thus can't clear LINKED
2459 * flag of the previous work while there must be a valid next work
2460 * after a work with LINKED flag set.
2461 *
2462 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002463 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002464 *
2465 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002466 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002467 */
Tejun Heo112202d2013-02-13 19:29:12 -08002468static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002469 struct wq_barrier *barr,
2470 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002471{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002472 struct list_head *head;
2473 unsigned int linked = 0;
2474
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002475 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002476 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002477 * as we know for sure that this will not trigger any of the
2478 * checks and call back into the fixup functions where we
2479 * might deadlock.
2480 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002481 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002482 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002483 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002484 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002485
Tejun Heoaffee4b2010-06-29 10:07:12 +02002486 /*
2487 * If @target is currently being executed, schedule the
2488 * barrier to the worker; otherwise, put it after @target.
2489 */
2490 if (worker)
2491 head = worker->scheduled.next;
2492 else {
2493 unsigned long *bits = work_data_bits(target);
2494
2495 head = target->entry.next;
2496 /* there can already be other linked works, inherit and set */
2497 linked = *bits & WORK_STRUCT_LINKED;
2498 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2499 }
2500
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002501 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002502 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002503 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002504}
2505
Tejun Heo73f53c42010-06-29 10:07:11 +02002506/**
Tejun Heo112202d2013-02-13 19:29:12 -08002507 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002508 * @wq: workqueue being flushed
2509 * @flush_color: new flush color, < 0 for no-op
2510 * @work_color: new work color, < 0 for no-op
2511 *
Tejun Heo112202d2013-02-13 19:29:12 -08002512 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002513 *
Tejun Heo112202d2013-02-13 19:29:12 -08002514 * If @flush_color is non-negative, flush_color on all pwqs should be
2515 * -1. If no pwq has in-flight commands at the specified color, all
2516 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2517 * has in flight commands, its pwq->flush_color is set to
2518 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002519 * wakeup logic is armed and %true is returned.
2520 *
2521 * The caller should have initialized @wq->first_flusher prior to
2522 * calling this function with non-negative @flush_color. If
2523 * @flush_color is negative, no flush color update is done and %false
2524 * is returned.
2525 *
Tejun Heo112202d2013-02-13 19:29:12 -08002526 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002527 * work_color which is previous to @work_color and all will be
2528 * advanced to @work_color.
2529 *
2530 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002531 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002532 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002533 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002534 * %true if @flush_color >= 0 and there's something to flush. %false
2535 * otherwise.
2536 */
Tejun Heo112202d2013-02-13 19:29:12 -08002537static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002538 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539{
Tejun Heo73f53c42010-06-29 10:07:11 +02002540 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002541 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002542
Tejun Heo73f53c42010-06-29 10:07:11 +02002543 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002544 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002545 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002546 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002547
Tejun Heo49e3cf42013-03-12 11:29:58 -07002548 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002549 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002550
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002551 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002552
2553 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002554 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002555
Tejun Heo112202d2013-02-13 19:29:12 -08002556 if (pwq->nr_in_flight[flush_color]) {
2557 pwq->flush_color = flush_color;
2558 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002559 wait = true;
2560 }
2561 }
2562
2563 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002564 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002565 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002566 }
2567
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002568 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002569 }
2570
Tejun Heo112202d2013-02-13 19:29:12 -08002571 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002572 complete(&wq->first_flusher->done);
2573
2574 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575}
2576
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002577/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002579 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002581 * This function sleeps until all work items which were queued on entry
2582 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002584void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585{
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 struct wq_flusher this_flusher = {
2587 .list = LIST_HEAD_INIT(this_flusher.list),
2588 .flush_color = -1,
2589 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2590 };
2591 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002592
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002593 lock_map_acquire(&wq->lockdep_map);
2594 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002595
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002596 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002597
2598 /*
2599 * Start-to-wait phase
2600 */
2601 next_color = work_next_color(wq->work_color);
2602
2603 if (next_color != wq->flush_color) {
2604 /*
2605 * Color space is not full. The current work_color
2606 * becomes our flush_color and work_color is advanced
2607 * by one.
2608 */
Tejun Heo6183c002013-03-12 11:29:57 -07002609 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002610 this_flusher.flush_color = wq->work_color;
2611 wq->work_color = next_color;
2612
2613 if (!wq->first_flusher) {
2614 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002615 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002616
2617 wq->first_flusher = &this_flusher;
2618
Tejun Heo112202d2013-02-13 19:29:12 -08002619 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002620 wq->work_color)) {
2621 /* nothing to flush, done */
2622 wq->flush_color = next_color;
2623 wq->first_flusher = NULL;
2624 goto out_unlock;
2625 }
2626 } else {
2627 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002628 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002629 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002630 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002631 }
2632 } else {
2633 /*
2634 * Oops, color space is full, wait on overflow queue.
2635 * The next flush completion will assign us
2636 * flush_color and transfer to flusher_queue.
2637 */
2638 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2639 }
2640
Tejun Heofca839c2015-12-07 10:58:57 -05002641 check_flush_dependency(wq, NULL);
2642
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002643 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002644
2645 wait_for_completion(&this_flusher.done);
2646
2647 /*
2648 * Wake-up-and-cascade phase
2649 *
2650 * First flushers are responsible for cascading flushes and
2651 * handling overflow. Non-first flushers can simply return.
2652 */
2653 if (wq->first_flusher != &this_flusher)
2654 return;
2655
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002656 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002657
Tejun Heo4ce48b32010-07-02 10:03:51 +02002658 /* we might have raced, check again with mutex held */
2659 if (wq->first_flusher != &this_flusher)
2660 goto out_unlock;
2661
Tejun Heo73f53c42010-06-29 10:07:11 +02002662 wq->first_flusher = NULL;
2663
Tejun Heo6183c002013-03-12 11:29:57 -07002664 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2665 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002666
2667 while (true) {
2668 struct wq_flusher *next, *tmp;
2669
2670 /* complete all the flushers sharing the current flush color */
2671 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2672 if (next->flush_color != wq->flush_color)
2673 break;
2674 list_del_init(&next->list);
2675 complete(&next->done);
2676 }
2677
Tejun Heo6183c002013-03-12 11:29:57 -07002678 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2679 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002680
2681 /* this flush_color is finished, advance by one */
2682 wq->flush_color = work_next_color(wq->flush_color);
2683
2684 /* one color has been freed, handle overflow queue */
2685 if (!list_empty(&wq->flusher_overflow)) {
2686 /*
2687 * Assign the same color to all overflowed
2688 * flushers, advance work_color and append to
2689 * flusher_queue. This is the start-to-wait
2690 * phase for these overflowed flushers.
2691 */
2692 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2693 tmp->flush_color = wq->work_color;
2694
2695 wq->work_color = work_next_color(wq->work_color);
2696
2697 list_splice_tail_init(&wq->flusher_overflow,
2698 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002699 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002700 }
2701
2702 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002703 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002704 break;
2705 }
2706
2707 /*
2708 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002709 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002710 */
Tejun Heo6183c002013-03-12 11:29:57 -07002711 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2712 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002713
2714 list_del_init(&next->list);
2715 wq->first_flusher = next;
2716
Tejun Heo112202d2013-02-13 19:29:12 -08002717 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002718 break;
2719
2720 /*
2721 * Meh... this color is already done, clear first
2722 * flusher and repeat cascading.
2723 */
2724 wq->first_flusher = NULL;
2725 }
2726
2727out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002728 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002730EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002732/**
2733 * drain_workqueue - drain a workqueue
2734 * @wq: workqueue to drain
2735 *
2736 * Wait until the workqueue becomes empty. While draining is in progress,
2737 * only chain queueing is allowed. IOW, only currently pending or running
2738 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002739 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002740 * by the depth of chaining and should be relatively short. Whine if it
2741 * takes too long.
2742 */
2743void drain_workqueue(struct workqueue_struct *wq)
2744{
2745 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002746 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002747
2748 /*
2749 * __queue_work() needs to test whether there are drainers, is much
2750 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002751 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002753 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002754 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002755 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002756 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002757reflush:
2758 flush_workqueue(wq);
2759
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002760 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002761
Tejun Heo49e3cf42013-03-12 11:29:58 -07002762 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002763 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002765 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002766 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002767 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002768
2769 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002770 continue;
2771
2772 if (++flush_cnt == 10 ||
2773 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002774 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002775 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002776
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002777 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002778 goto reflush;
2779 }
2780
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002781 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002782 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002783 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784}
2785EXPORT_SYMBOL_GPL(drain_workqueue);
2786
Tejun Heo606a5022012-08-20 14:51:23 -07002787static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002788{
2789 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002790 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002791 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002792
2793 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002794
Tejun Heofa1b54e2013-03-12 11:30:00 -07002795 local_irq_disable();
2796 pool = get_work_pool(work);
2797 if (!pool) {
2798 local_irq_enable();
2799 return false;
2800 }
2801
2802 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002803 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002804 pwq = get_work_pwq(work);
2805 if (pwq) {
2806 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002807 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002808 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002809 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002810 if (!worker)
2811 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002812 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002813 }
Tejun Heobaf59022010-09-16 10:42:16 +02002814
Tejun Heofca839c2015-12-07 10:58:57 -05002815 check_flush_dependency(pwq->wq, work);
2816
Tejun Heo112202d2013-02-13 19:29:12 -08002817 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002818 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002819
Tejun Heoe1594892011-01-09 23:32:15 +01002820 /*
2821 * If @max_active is 1 or rescuer is in use, flushing another work
2822 * item on the same workqueue may lead to deadlock. Make sure the
2823 * flusher is not running on the same workqueue by verifying write
2824 * access.
2825 */
Tejun Heo493008a2013-03-12 11:30:03 -07002826 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002827 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002828 else
Tejun Heo112202d2013-02-13 19:29:12 -08002829 lock_map_acquire_read(&pwq->wq->lockdep_map);
2830 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002831
Tejun Heobaf59022010-09-16 10:42:16 +02002832 return true;
2833already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002834 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002835 return false;
2836}
2837
Oleg Nesterovdb700892008-07-25 01:47:49 -07002838/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002839 * flush_work - wait for a work to finish executing the last queueing instance
2840 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002841 *
Tejun Heo606a5022012-08-20 14:51:23 -07002842 * Wait until @work has finished execution. @work is guaranteed to be idle
2843 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002844 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002845 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002846 * %true if flush_work() waited for the work to finish execution,
2847 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002848 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002849bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002850{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002851 struct wq_barrier barr;
2852
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002853 lock_map_acquire(&work->lockdep_map);
2854 lock_map_release(&work->lockdep_map);
2855
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002856 if (start_flush_work(work, &barr)) {
2857 wait_for_completion(&barr.done);
2858 destroy_work_on_stack(&barr.work);
2859 return true;
2860 } else {
2861 return false;
2862 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002863}
2864EXPORT_SYMBOL_GPL(flush_work);
2865
Tejun Heo8603e1b32015-03-05 08:04:13 -05002866struct cwt_wait {
2867 wait_queue_t wait;
2868 struct work_struct *work;
2869};
2870
2871static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2872{
2873 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2874
2875 if (cwait->work != key)
2876 return 0;
2877 return autoremove_wake_function(wait, mode, sync, key);
2878}
2879
Tejun Heo36e227d2012-08-03 10:30:46 -07002880static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002881{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002882 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002883 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002884 int ret;
2885
2886 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002887 ret = try_to_grab_pending(work, is_dwork, &flags);
2888 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002889 * If someone else is already canceling, wait for it to
2890 * finish. flush_work() doesn't work for PREEMPT_NONE
2891 * because we may get scheduled between @work's completion
2892 * and the other canceling task resuming and clearing
2893 * CANCELING - flush_work() will return false immediately
2894 * as @work is no longer busy, try_to_grab_pending() will
2895 * return -ENOENT as @work is still being canceled and the
2896 * other canceling task won't be able to clear CANCELING as
2897 * we're hogging the CPU.
2898 *
2899 * Let's wait for completion using a waitqueue. As this
2900 * may lead to the thundering herd problem, use a custom
2901 * wake function which matches @work along with exclusive
2902 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002903 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002904 if (unlikely(ret == -ENOENT)) {
2905 struct cwt_wait cwait;
2906
2907 init_wait(&cwait.wait);
2908 cwait.wait.func = cwt_wakefn;
2909 cwait.work = work;
2910
2911 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2912 TASK_UNINTERRUPTIBLE);
2913 if (work_is_canceling(work))
2914 schedule();
2915 finish_wait(&cancel_waitq, &cwait.wait);
2916 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002917 } while (unlikely(ret < 0));
2918
Tejun Heobbb68df2012-08-03 10:30:46 -07002919 /* tell other tasks trying to grab @work to back off */
2920 mark_work_canceling(work);
2921 local_irq_restore(flags);
2922
Tejun Heo606a5022012-08-20 14:51:23 -07002923 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002924 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002925
2926 /*
2927 * Paired with prepare_to_wait() above so that either
2928 * waitqueue_active() is visible here or !work_is_canceling() is
2929 * visible there.
2930 */
2931 smp_mb();
2932 if (waitqueue_active(&cancel_waitq))
2933 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2934
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002935 return ret;
2936}
2937
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002938/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002939 * cancel_work_sync - cancel a work and wait for it to finish
2940 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002941 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002942 * Cancel @work and wait for its execution to finish. This function
2943 * can be used even if the work re-queues itself or migrates to
2944 * another workqueue. On return from this function, @work is
2945 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002946 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002947 * cancel_work_sync(&delayed_work->work) must not be used for
2948 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002949 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002950 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002951 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002952 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002953 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002954 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002955 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002956bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002957{
Tejun Heo36e227d2012-08-03 10:30:46 -07002958 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002959}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002960EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002961
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002962/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002963 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2964 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002965 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002966 * Delayed timer is cancelled and the pending work is queued for
2967 * immediate execution. Like flush_work(), this function only
2968 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002969 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002970 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002971 * %true if flush_work() waited for the work to finish execution,
2972 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002973 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002974bool flush_delayed_work(struct delayed_work *dwork)
2975{
Tejun Heo8930cab2012-08-03 10:30:45 -07002976 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002977 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002978 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002979 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002980 return flush_work(&dwork->work);
2981}
2982EXPORT_SYMBOL(flush_delayed_work);
2983
Jens Axboef72b8792016-08-24 15:51:50 -06002984static bool __cancel_work(struct work_struct *work, bool is_dwork)
2985{
2986 unsigned long flags;
2987 int ret;
2988
2989 do {
2990 ret = try_to_grab_pending(work, is_dwork, &flags);
2991 } while (unlikely(ret == -EAGAIN));
2992
2993 if (unlikely(ret < 0))
2994 return false;
2995
2996 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
2997 local_irq_restore(flags);
2998 return ret;
2999}
3000
3001/*
3002 * See cancel_delayed_work()
3003 */
3004bool cancel_work(struct work_struct *work)
3005{
3006 return __cancel_work(work, false);
3007}
3008
Tejun Heo401a8d02010-09-16 10:36:00 +02003009/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003010 * cancel_delayed_work - cancel a delayed work
3011 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003012 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003013 * Kill off a pending delayed_work.
3014 *
3015 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3016 * pending.
3017 *
3018 * Note:
3019 * The work callback function may still be running on return, unless
3020 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3021 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003022 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003023 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003024 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003025bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003026{
Jens Axboef72b8792016-08-24 15:51:50 -06003027 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003028}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003029EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003030
3031/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003032 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3033 * @dwork: the delayed work cancel
3034 *
3035 * This is cancel_work_sync() for delayed works.
3036 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003037 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003038 * %true if @dwork was pending, %false otherwise.
3039 */
3040bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003041{
Tejun Heo36e227d2012-08-03 10:30:46 -07003042 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003043}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003044EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003046/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003047 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003048 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003049 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003050 * schedule_on_each_cpu() executes @func on each online CPU using the
3051 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003052 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003053 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003054 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003055 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003056 */
David Howells65f27f32006-11-22 14:55:48 +00003057int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003058{
3059 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003060 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003061
Andrew Mortonb6136772006-06-25 05:47:49 -07003062 works = alloc_percpu(struct work_struct);
3063 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003064 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003065
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003066 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003067
Christoph Lameter15316ba2006-01-08 01:00:43 -08003068 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003069 struct work_struct *work = per_cpu_ptr(works, cpu);
3070
3071 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003072 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003073 }
Tejun Heo93981802009-11-17 14:06:20 -08003074
3075 for_each_online_cpu(cpu)
3076 flush_work(per_cpu_ptr(works, cpu));
3077
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003078 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003079 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003080 return 0;
3081}
3082
Alan Sterneef6a7d2010-02-12 17:39:21 +09003083/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003084 * execute_in_process_context - reliably execute the routine with user context
3085 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003086 * @ew: guaranteed storage for the execute work structure (must
3087 * be available when the work executes)
3088 *
3089 * Executes the function immediately if process context is available,
3090 * otherwise schedules the function for delayed execution.
3091 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003092 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003093 * 1 - function was scheduled for execution
3094 */
David Howells65f27f32006-11-22 14:55:48 +00003095int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003096{
3097 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003098 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003099 return 0;
3100 }
3101
David Howells65f27f32006-11-22 14:55:48 +00003102 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003103 schedule_work(&ew->work);
3104
3105 return 1;
3106}
3107EXPORT_SYMBOL_GPL(execute_in_process_context);
3108
Tejun Heo7a4e3442013-03-12 11:30:00 -07003109/**
3110 * free_workqueue_attrs - free a workqueue_attrs
3111 * @attrs: workqueue_attrs to free
3112 *
3113 * Undo alloc_workqueue_attrs().
3114 */
3115void free_workqueue_attrs(struct workqueue_attrs *attrs)
3116{
3117 if (attrs) {
3118 free_cpumask_var(attrs->cpumask);
3119 kfree(attrs);
3120 }
3121}
3122
3123/**
3124 * alloc_workqueue_attrs - allocate a workqueue_attrs
3125 * @gfp_mask: allocation mask to use
3126 *
3127 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003128 * return it.
3129 *
3130 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003131 */
3132struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3133{
3134 struct workqueue_attrs *attrs;
3135
3136 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3137 if (!attrs)
3138 goto fail;
3139 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3140 goto fail;
3141
Tejun Heo13e2e552013-04-01 11:23:31 -07003142 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003143 return attrs;
3144fail:
3145 free_workqueue_attrs(attrs);
3146 return NULL;
3147}
3148
Tejun Heo29c91e92013-03-12 11:30:03 -07003149static void copy_workqueue_attrs(struct workqueue_attrs *to,
3150 const struct workqueue_attrs *from)
3151{
3152 to->nice = from->nice;
3153 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003154 /*
3155 * Unlike hash and equality test, this function doesn't ignore
3156 * ->no_numa as it is used for both pool and wq attrs. Instead,
3157 * get_unbound_pool() explicitly clears ->no_numa after copying.
3158 */
3159 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003160}
3161
Tejun Heo29c91e92013-03-12 11:30:03 -07003162/* hash value of the content of @attr */
3163static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3164{
3165 u32 hash = 0;
3166
3167 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003168 hash = jhash(cpumask_bits(attrs->cpumask),
3169 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003170 return hash;
3171}
3172
3173/* content equality test */
3174static bool wqattrs_equal(const struct workqueue_attrs *a,
3175 const struct workqueue_attrs *b)
3176{
3177 if (a->nice != b->nice)
3178 return false;
3179 if (!cpumask_equal(a->cpumask, b->cpumask))
3180 return false;
3181 return true;
3182}
3183
Tejun Heo7a4e3442013-03-12 11:30:00 -07003184/**
3185 * init_worker_pool - initialize a newly zalloc'd worker_pool
3186 * @pool: worker_pool to initialize
3187 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303188 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003189 *
3190 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003191 * inside @pool proper are initialized and put_unbound_pool() can be called
3192 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003193 */
3194static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003195{
3196 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003197 pool->id = -1;
3198 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003199 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003200 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003201 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003202 INIT_LIST_HEAD(&pool->worklist);
3203 INIT_LIST_HEAD(&pool->idle_list);
3204 hash_init(pool->busy_hash);
3205
3206 init_timer_deferrable(&pool->idle_timer);
3207 pool->idle_timer.function = idle_worker_timeout;
3208 pool->idle_timer.data = (unsigned long)pool;
3209
3210 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3211 (unsigned long)pool);
3212
3213 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003214 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003215 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003216
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003217 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003218 INIT_HLIST_NODE(&pool->hash_node);
3219 pool->refcnt = 1;
3220
3221 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003222 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3223 if (!pool->attrs)
3224 return -ENOMEM;
3225 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003226}
3227
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003228static void rcu_free_wq(struct rcu_head *rcu)
3229{
3230 struct workqueue_struct *wq =
3231 container_of(rcu, struct workqueue_struct, rcu);
3232
3233 if (!(wq->flags & WQ_UNBOUND))
3234 free_percpu(wq->cpu_pwqs);
3235 else
3236 free_workqueue_attrs(wq->unbound_attrs);
3237
3238 kfree(wq->rescuer);
3239 kfree(wq);
3240}
3241
Tejun Heo29c91e92013-03-12 11:30:03 -07003242static void rcu_free_pool(struct rcu_head *rcu)
3243{
3244 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3245
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003246 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003247 free_workqueue_attrs(pool->attrs);
3248 kfree(pool);
3249}
3250
3251/**
3252 * put_unbound_pool - put a worker_pool
3253 * @pool: worker_pool to put
3254 *
3255 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003256 * safe manner. get_unbound_pool() calls this function on its failure path
3257 * and this function should be able to release pools which went through,
3258 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003259 *
3260 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003261 */
3262static void put_unbound_pool(struct worker_pool *pool)
3263{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003264 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003265 struct worker *worker;
3266
Tejun Heoa892cac2013-04-01 11:23:32 -07003267 lockdep_assert_held(&wq_pool_mutex);
3268
3269 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003270 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003271
3272 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003273 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003274 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003275 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003276
3277 /* release id and unhash */
3278 if (pool->id >= 0)
3279 idr_remove(&worker_pool_idr, pool->id);
3280 hash_del(&pool->hash_node);
3281
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003282 /*
3283 * Become the manager and destroy all workers. Grabbing
3284 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003285 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003286 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003288
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003289 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003290 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003291 destroy_worker(worker);
3292 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003293 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003294
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003295 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003296 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003297 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003298 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003299
3300 if (pool->detach_completion)
3301 wait_for_completion(pool->detach_completion);
3302
Tejun Heo29c91e92013-03-12 11:30:03 -07003303 mutex_unlock(&pool->manager_arb);
3304
3305 /* shut down the timers */
3306 del_timer_sync(&pool->idle_timer);
3307 del_timer_sync(&pool->mayday_timer);
3308
3309 /* sched-RCU protected to allow dereferences from get_work_pool() */
3310 call_rcu_sched(&pool->rcu, rcu_free_pool);
3311}
3312
3313/**
3314 * get_unbound_pool - get a worker_pool with the specified attributes
3315 * @attrs: the attributes of the worker_pool to get
3316 *
3317 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3318 * reference count and return it. If there already is a matching
3319 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003320 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003321 *
3322 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003323 *
3324 * Return: On success, a worker_pool with the same attributes as @attrs.
3325 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003326 */
3327static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3328{
Tejun Heo29c91e92013-03-12 11:30:03 -07003329 u32 hash = wqattrs_hash(attrs);
3330 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003331 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003332 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003333
Tejun Heoa892cac2013-04-01 11:23:32 -07003334 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003335
3336 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003337 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3338 if (wqattrs_equal(pool->attrs, attrs)) {
3339 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003340 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003341 }
3342 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003343
Xunlei Pange2273582015-10-09 11:53:12 +08003344 /* if cpumask is contained inside a NUMA node, we belong to that node */
3345 if (wq_numa_enabled) {
3346 for_each_node(node) {
3347 if (cpumask_subset(attrs->cpumask,
3348 wq_numa_possible_cpumask[node])) {
3349 target_node = node;
3350 break;
3351 }
3352 }
3353 }
3354
Tejun Heo29c91e92013-03-12 11:30:03 -07003355 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003356 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003357 if (!pool || init_worker_pool(pool) < 0)
3358 goto fail;
3359
Tejun Heo8864b4e2013-03-12 11:30:04 -07003360 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003361 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003362 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003363
Shaohua Li2865a8f2013-08-01 09:56:36 +08003364 /*
3365 * no_numa isn't a worker_pool attribute, always clear it. See
3366 * 'struct workqueue_attrs' comments for detail.
3367 */
3368 pool->attrs->no_numa = false;
3369
Tejun Heo29c91e92013-03-12 11:30:03 -07003370 if (worker_pool_assign_id(pool) < 0)
3371 goto fail;
3372
3373 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003374 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003375 goto fail;
3376
Tejun Heo29c91e92013-03-12 11:30:03 -07003377 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003378 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003379
Tejun Heo29c91e92013-03-12 11:30:03 -07003380 return pool;
3381fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003382 if (pool)
3383 put_unbound_pool(pool);
3384 return NULL;
3385}
3386
Tejun Heo8864b4e2013-03-12 11:30:04 -07003387static void rcu_free_pwq(struct rcu_head *rcu)
3388{
3389 kmem_cache_free(pwq_cache,
3390 container_of(rcu, struct pool_workqueue, rcu));
3391}
3392
3393/*
3394 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3395 * and needs to be destroyed.
3396 */
3397static void pwq_unbound_release_workfn(struct work_struct *work)
3398{
3399 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3400 unbound_release_work);
3401 struct workqueue_struct *wq = pwq->wq;
3402 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003403 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003404
3405 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3406 return;
3407
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003408 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003409 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003410 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003411 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003412
Tejun Heoa892cac2013-04-01 11:23:32 -07003413 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003414 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003415 mutex_unlock(&wq_pool_mutex);
3416
Tejun Heo8864b4e2013-03-12 11:30:04 -07003417 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3418
3419 /*
3420 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003421 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003422 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003423 if (is_last)
3424 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003425}
3426
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003427/**
Tejun Heo699ce092013-03-13 16:51:35 -07003428 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003429 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003430 *
Tejun Heo699ce092013-03-13 16:51:35 -07003431 * If @pwq isn't freezing, set @pwq->max_active to the associated
3432 * workqueue's saved_max_active and activate delayed work items
3433 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003434 */
Tejun Heo699ce092013-03-13 16:51:35 -07003435static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003436{
Tejun Heo699ce092013-03-13 16:51:35 -07003437 struct workqueue_struct *wq = pwq->wq;
3438 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003439
Tejun Heo699ce092013-03-13 16:51:35 -07003440 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003441 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003442
3443 /* fast exit for non-freezable wqs */
3444 if (!freezable && pwq->max_active == wq->saved_max_active)
3445 return;
3446
Lai Jiangshana357fc02013-03-25 16:57:19 -07003447 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003448
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003449 /*
3450 * During [un]freezing, the caller is responsible for ensuring that
3451 * this function is called at least once after @workqueue_freezing
3452 * is updated and visible.
3453 */
3454 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003455 pwq->max_active = wq->saved_max_active;
3456
3457 while (!list_empty(&pwq->delayed_works) &&
3458 pwq->nr_active < pwq->max_active)
3459 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003460
3461 /*
3462 * Need to kick a worker after thawed or an unbound wq's
3463 * max_active is bumped. It's a slow path. Do it always.
3464 */
3465 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003466 } else {
3467 pwq->max_active = 0;
3468 }
3469
Lai Jiangshana357fc02013-03-25 16:57:19 -07003470 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003471}
3472
Tejun Heoe50aba92013-04-01 11:23:35 -07003473/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003474static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3475 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003476{
3477 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3478
Tejun Heoe50aba92013-04-01 11:23:35 -07003479 memset(pwq, 0, sizeof(*pwq));
3480
Tejun Heod2c1d402013-03-12 11:30:04 -07003481 pwq->pool = pool;
3482 pwq->wq = wq;
3483 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003484 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003485 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003486 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003487 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003488 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003489}
Tejun Heod2c1d402013-03-12 11:30:04 -07003490
Tejun Heof147f292013-04-01 11:23:35 -07003491/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003492static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003493{
3494 struct workqueue_struct *wq = pwq->wq;
3495
3496 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003497
Tejun Heo1befcf32013-04-01 11:23:35 -07003498 /* may be called multiple times, ignore if already linked */
3499 if (!list_empty(&pwq->pwqs_node))
3500 return;
3501
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003502 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003503 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003504
3505 /* sync max_active to the current setting */
3506 pwq_adjust_max_active(pwq);
3507
3508 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003509 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003510}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003511
Tejun Heof147f292013-04-01 11:23:35 -07003512/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3513static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3514 const struct workqueue_attrs *attrs)
3515{
3516 struct worker_pool *pool;
3517 struct pool_workqueue *pwq;
3518
3519 lockdep_assert_held(&wq_pool_mutex);
3520
3521 pool = get_unbound_pool(attrs);
3522 if (!pool)
3523 return NULL;
3524
Tejun Heoe50aba92013-04-01 11:23:35 -07003525 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003526 if (!pwq) {
3527 put_unbound_pool(pool);
3528 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003529 }
Tejun Heo6029a912013-04-01 11:23:34 -07003530
Tejun Heof147f292013-04-01 11:23:35 -07003531 init_pwq(pwq, wq, pool);
3532 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003533}
3534
Tejun Heo4c16bd32013-04-01 11:23:36 -07003535/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003536 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003537 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003538 * @node: the target NUMA node
3539 * @cpu_going_down: if >= 0, the CPU to consider as offline
3540 * @cpumask: outarg, the resulting cpumask
3541 *
3542 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3543 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003544 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003545 *
3546 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3547 * enabled and @node has online CPUs requested by @attrs, the returned
3548 * cpumask is the intersection of the possible CPUs of @node and
3549 * @attrs->cpumask.
3550 *
3551 * The caller is responsible for ensuring that the cpumask of @node stays
3552 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003553 *
3554 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3555 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003556 */
3557static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3558 int cpu_going_down, cpumask_t *cpumask)
3559{
Tejun Heod55262c2013-04-01 11:23:38 -07003560 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003561 goto use_dfl;
3562
3563 /* does @node have any online CPUs @attrs wants? */
3564 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3565 if (cpu_going_down >= 0)
3566 cpumask_clear_cpu(cpu_going_down, cpumask);
3567
3568 if (cpumask_empty(cpumask))
3569 goto use_dfl;
3570
3571 /* yeap, return possible CPUs in @node that @attrs wants */
3572 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3573 return !cpumask_equal(cpumask, attrs->cpumask);
3574
3575use_dfl:
3576 cpumask_copy(cpumask, attrs->cpumask);
3577 return false;
3578}
3579
Tejun Heo1befcf32013-04-01 11:23:35 -07003580/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3581static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3582 int node,
3583 struct pool_workqueue *pwq)
3584{
3585 struct pool_workqueue *old_pwq;
3586
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003587 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003588 lockdep_assert_held(&wq->mutex);
3589
3590 /* link_pwq() can handle duplicate calls */
3591 link_pwq(pwq);
3592
3593 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3594 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3595 return old_pwq;
3596}
3597
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003598/* context to store the prepared attrs & pwqs before applying */
3599struct apply_wqattrs_ctx {
3600 struct workqueue_struct *wq; /* target workqueue */
3601 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003602 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003603 struct pool_workqueue *dfl_pwq;
3604 struct pool_workqueue *pwq_tbl[];
3605};
3606
3607/* free the resources after success or abort */
3608static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3609{
3610 if (ctx) {
3611 int node;
3612
3613 for_each_node(node)
3614 put_pwq_unlocked(ctx->pwq_tbl[node]);
3615 put_pwq_unlocked(ctx->dfl_pwq);
3616
3617 free_workqueue_attrs(ctx->attrs);
3618
3619 kfree(ctx);
3620 }
3621}
3622
3623/* allocate the attrs and pwqs for later installation */
3624static struct apply_wqattrs_ctx *
3625apply_wqattrs_prepare(struct workqueue_struct *wq,
3626 const struct workqueue_attrs *attrs)
3627{
3628 struct apply_wqattrs_ctx *ctx;
3629 struct workqueue_attrs *new_attrs, *tmp_attrs;
3630 int node;
3631
3632 lockdep_assert_held(&wq_pool_mutex);
3633
3634 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3635 GFP_KERNEL);
3636
3637 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3638 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3639 if (!ctx || !new_attrs || !tmp_attrs)
3640 goto out_free;
3641
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003642 /*
3643 * Calculate the attrs of the default pwq.
3644 * If the user configured cpumask doesn't overlap with the
3645 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3646 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003647 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003648 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003649 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3650 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003651
3652 /*
3653 * We may create multiple pwqs with differing cpumasks. Make a
3654 * copy of @new_attrs which will be modified and used to obtain
3655 * pools.
3656 */
3657 copy_workqueue_attrs(tmp_attrs, new_attrs);
3658
3659 /*
3660 * If something goes wrong during CPU up/down, we'll fall back to
3661 * the default pwq covering whole @attrs->cpumask. Always create
3662 * it even if we don't use it immediately.
3663 */
3664 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3665 if (!ctx->dfl_pwq)
3666 goto out_free;
3667
3668 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003669 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003670 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3671 if (!ctx->pwq_tbl[node])
3672 goto out_free;
3673 } else {
3674 ctx->dfl_pwq->refcnt++;
3675 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3676 }
3677 }
3678
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003679 /* save the user configured attrs and sanitize it. */
3680 copy_workqueue_attrs(new_attrs, attrs);
3681 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003682 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003683
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003684 ctx->wq = wq;
3685 free_workqueue_attrs(tmp_attrs);
3686 return ctx;
3687
3688out_free:
3689 free_workqueue_attrs(tmp_attrs);
3690 free_workqueue_attrs(new_attrs);
3691 apply_wqattrs_cleanup(ctx);
3692 return NULL;
3693}
3694
3695/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3696static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3697{
3698 int node;
3699
3700 /* all pwqs have been created successfully, let's install'em */
3701 mutex_lock(&ctx->wq->mutex);
3702
3703 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3704
3705 /* save the previous pwq and install the new one */
3706 for_each_node(node)
3707 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3708 ctx->pwq_tbl[node]);
3709
3710 /* @dfl_pwq might not have been used, ensure it's linked */
3711 link_pwq(ctx->dfl_pwq);
3712 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3713
3714 mutex_unlock(&ctx->wq->mutex);
3715}
3716
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003717static void apply_wqattrs_lock(void)
3718{
3719 /* CPUs should stay stable across pwq creations and installations */
3720 get_online_cpus();
3721 mutex_lock(&wq_pool_mutex);
3722}
3723
3724static void apply_wqattrs_unlock(void)
3725{
3726 mutex_unlock(&wq_pool_mutex);
3727 put_online_cpus();
3728}
3729
3730static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3731 const struct workqueue_attrs *attrs)
3732{
3733 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003734
3735 /* only unbound workqueues can change attributes */
3736 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3737 return -EINVAL;
3738
3739 /* creating multiple pwqs breaks ordering guarantee */
3740 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3741 return -EINVAL;
3742
3743 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003744 if (!ctx)
3745 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003746
3747 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003748 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003749 apply_wqattrs_cleanup(ctx);
3750
wanghaibin62011712016-01-07 20:38:59 +08003751 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003752}
3753
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003754/**
3755 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3756 * @wq: the target workqueue
3757 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3758 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003759 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3760 * machines, this function maps a separate pwq to each NUMA node with
3761 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3762 * NUMA node it was issued on. Older pwqs are released as in-flight work
3763 * items finish. Note that a work item which repeatedly requeues itself
3764 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003765 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003766 * Performs GFP_KERNEL allocations.
3767 *
3768 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003769 */
3770int apply_workqueue_attrs(struct workqueue_struct *wq,
3771 const struct workqueue_attrs *attrs)
3772{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003773 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003774
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003775 apply_wqattrs_lock();
3776 ret = apply_workqueue_attrs_locked(wq, attrs);
3777 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003778
Tejun Heo48621252013-04-01 11:23:31 -07003779 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003780}
3781
Tejun Heo4c16bd32013-04-01 11:23:36 -07003782/**
3783 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3784 * @wq: the target workqueue
3785 * @cpu: the CPU coming up or going down
3786 * @online: whether @cpu is coming up or going down
3787 *
3788 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3789 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3790 * @wq accordingly.
3791 *
3792 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3793 * falls back to @wq->dfl_pwq which may not be optimal but is always
3794 * correct.
3795 *
3796 * Note that when the last allowed CPU of a NUMA node goes offline for a
3797 * workqueue with a cpumask spanning multiple nodes, the workers which were
3798 * already executing the work items for the workqueue will lose their CPU
3799 * affinity and may execute on any CPU. This is similar to how per-cpu
3800 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3801 * affinity, it's the user's responsibility to flush the work item from
3802 * CPU_DOWN_PREPARE.
3803 */
3804static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3805 bool online)
3806{
3807 int node = cpu_to_node(cpu);
3808 int cpu_off = online ? -1 : cpu;
3809 struct pool_workqueue *old_pwq = NULL, *pwq;
3810 struct workqueue_attrs *target_attrs;
3811 cpumask_t *cpumask;
3812
3813 lockdep_assert_held(&wq_pool_mutex);
3814
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003815 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3816 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003817 return;
3818
3819 /*
3820 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3821 * Let's use a preallocated one. The following buf is protected by
3822 * CPU hotplug exclusion.
3823 */
3824 target_attrs = wq_update_unbound_numa_attrs_buf;
3825 cpumask = target_attrs->cpumask;
3826
Tejun Heo4c16bd32013-04-01 11:23:36 -07003827 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3828 pwq = unbound_pwq_by_node(wq, node);
3829
3830 /*
3831 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003832 * different from the default pwq's, we need to compare it to @pwq's
3833 * and create a new one if they don't match. If the target cpumask
3834 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003835 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003836 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003837 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003838 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003839 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003840 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003841 }
3842
Tejun Heo4c16bd32013-04-01 11:23:36 -07003843 /* create a new pwq */
3844 pwq = alloc_unbound_pwq(wq, target_attrs);
3845 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003846 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3847 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003848 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003849 }
3850
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003851 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003852 mutex_lock(&wq->mutex);
3853 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3854 goto out_unlock;
3855
3856use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003857 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003858 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3859 get_pwq(wq->dfl_pwq);
3860 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3861 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3862out_unlock:
3863 mutex_unlock(&wq->mutex);
3864 put_pwq_unlocked(old_pwq);
3865}
3866
Tejun Heo30cdf242013-03-12 11:29:57 -07003867static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003868{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003869 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003870 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003871
Tejun Heo30cdf242013-03-12 11:29:57 -07003872 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003873 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3874 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003875 return -ENOMEM;
3876
3877 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003878 struct pool_workqueue *pwq =
3879 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003880 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003881 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003882
Tejun Heof147f292013-04-01 11:23:35 -07003883 init_pwq(pwq, wq, &cpu_pools[highpri]);
3884
3885 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003886 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003887 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003888 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003889 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003890 } else if (wq->flags & __WQ_ORDERED) {
3891 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3892 /* there should only be single pwq for ordering guarantee */
3893 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3894 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3895 "ordering guarantee broken for workqueue %s\n", wq->name);
3896 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003897 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003898 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003899 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003900}
3901
Tejun Heof3421792010-07-02 10:03:51 +02003902static int wq_clamp_max_active(int max_active, unsigned int flags,
3903 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003904{
Tejun Heof3421792010-07-02 10:03:51 +02003905 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3906
3907 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003908 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3909 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003910
Tejun Heof3421792010-07-02 10:03:51 +02003911 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003912}
3913
Tejun Heob196be82012-01-10 15:11:35 -08003914struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003915 unsigned int flags,
3916 int max_active,
3917 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003918 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003919{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003920 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003921 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003922 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003923 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003924
Viresh Kumarcee22a12013-04-08 16:45:40 +05303925 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3926 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3927 flags |= WQ_UNBOUND;
3928
Tejun Heoecf68812013-04-01 11:23:34 -07003929 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003930 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003931 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003932
3933 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003934 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003935 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003936
Tejun Heo6029a912013-04-01 11:23:34 -07003937 if (flags & WQ_UNBOUND) {
3938 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3939 if (!wq->unbound_attrs)
3940 goto err_free_wq;
3941 }
3942
Tejun Heoecf68812013-04-01 11:23:34 -07003943 va_start(args, lock_name);
3944 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003945 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003946
Tejun Heod320c032010-06-29 10:07:14 +02003947 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003948 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003949
Tejun Heob196be82012-01-10 15:11:35 -08003950 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003951 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003952 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003953 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003954 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003955 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003956 INIT_LIST_HEAD(&wq->flusher_queue);
3957 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003958 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003959
Johannes Bergeb13ba82008-01-16 09:51:58 +01003960 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003961 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003962
Tejun Heo30cdf242013-03-12 11:29:57 -07003963 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003964 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003965
Tejun Heo493008a2013-03-12 11:30:03 -07003966 /*
3967 * Workqueues which may be used during memory reclaim should
3968 * have a rescuer to guarantee forward progress.
3969 */
3970 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003971 struct worker *rescuer;
3972
Lai Jiangshanf7537df2014-07-15 17:24:15 +08003973 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003974 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003975 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003976
Tejun Heo111c2252013-01-17 17:16:24 -08003977 rescuer->rescue_wq = wq;
3978 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003979 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003980 if (IS_ERR(rescuer->task)) {
3981 kfree(rescuer);
3982 goto err_destroy;
3983 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003984
Tejun Heod2c1d402013-03-12 11:30:04 -07003985 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02003986 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003987 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003988 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003989
Tejun Heo226223a2013-03-12 11:30:05 -07003990 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3991 goto err_destroy;
3992
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003993 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003994 * wq_pool_mutex protects global freeze state and workqueues list.
3995 * Grab it, adjust max_active and add the new @wq to workqueues
3996 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003997 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003998 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003999
Lai Jiangshana357fc02013-03-25 16:57:19 -07004000 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004001 for_each_pwq(pwq, wq)
4002 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004003 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004004
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004005 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004006
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004007 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004008
Oleg Nesterov3af244332007-05-09 02:34:09 -07004009 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004010
4011err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004012 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004013 kfree(wq);
4014 return NULL;
4015err_destroy:
4016 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004017 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004018}
Tejun Heod320c032010-06-29 10:07:14 +02004019EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004020
4021/**
4022 * destroy_workqueue - safely terminate a workqueue
4023 * @wq: target workqueue
4024 *
4025 * Safely destroy a workqueue. All work currently pending will be done first.
4026 */
4027void destroy_workqueue(struct workqueue_struct *wq)
4028{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004029 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004030 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004031
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004032 /* drain it before proceeding with destruction */
4033 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004034
Tejun Heo6183c002013-03-12 11:29:57 -07004035 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004036 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004037 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004038 int i;
4039
Tejun Heo76af4d92013-03-12 11:30:00 -07004040 for (i = 0; i < WORK_NR_COLORS; i++) {
4041 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004042 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004043 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004044 }
4045 }
4046
Lai Jiangshan5c529592013-04-04 10:05:38 +08004047 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004048 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004049 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004050 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004051 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004052 }
Tejun Heo6183c002013-03-12 11:29:57 -07004053 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004054 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004055
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004056 /*
4057 * wq list is used to freeze wq, remove from list after
4058 * flushing is complete in case freeze races us.
4059 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004060 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004061 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004062 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004063
Tejun Heo226223a2013-03-12 11:30:05 -07004064 workqueue_sysfs_unregister(wq);
4065
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004066 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004067 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004068
Tejun Heo8864b4e2013-03-12 11:30:04 -07004069 if (!(wq->flags & WQ_UNBOUND)) {
4070 /*
4071 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004072 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004073 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004074 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004075 } else {
4076 /*
4077 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004078 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4079 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004080 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004081 for_each_node(node) {
4082 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4083 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4084 put_pwq_unlocked(pwq);
4085 }
4086
4087 /*
4088 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4089 * put. Don't access it afterwards.
4090 */
4091 pwq = wq->dfl_pwq;
4092 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004093 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004094 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004095}
4096EXPORT_SYMBOL_GPL(destroy_workqueue);
4097
Tejun Heodcd989c2010-06-29 10:07:14 +02004098/**
4099 * workqueue_set_max_active - adjust max_active of a workqueue
4100 * @wq: target workqueue
4101 * @max_active: new max_active value.
4102 *
4103 * Set max_active of @wq to @max_active.
4104 *
4105 * CONTEXT:
4106 * Don't call from IRQ context.
4107 */
4108void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4109{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004110 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004111
Tejun Heo8719dce2013-03-12 11:30:04 -07004112 /* disallow meddling with max_active for ordered workqueues */
4113 if (WARN_ON(wq->flags & __WQ_ORDERED))
4114 return;
4115
Tejun Heof3421792010-07-02 10:03:51 +02004116 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004117
Lai Jiangshana357fc02013-03-25 16:57:19 -07004118 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004119
4120 wq->saved_max_active = max_active;
4121
Tejun Heo699ce092013-03-13 16:51:35 -07004122 for_each_pwq(pwq, wq)
4123 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004124
Lai Jiangshana357fc02013-03-25 16:57:19 -07004125 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004126}
4127EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4128
4129/**
Tejun Heoe62676162013-03-12 17:41:37 -07004130 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4131 *
4132 * Determine whether %current is a workqueue rescuer. Can be used from
4133 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004134 *
4135 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004136 */
4137bool current_is_workqueue_rescuer(void)
4138{
4139 struct worker *worker = current_wq_worker();
4140
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004141 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004142}
4143
4144/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004145 * workqueue_congested - test whether a workqueue is congested
4146 * @cpu: CPU in question
4147 * @wq: target workqueue
4148 *
4149 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4150 * no synchronization around this function and the test result is
4151 * unreliable and only useful as advisory hints or for debugging.
4152 *
Tejun Heod3251852013-05-10 11:10:17 -07004153 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4154 * Note that both per-cpu and unbound workqueues may be associated with
4155 * multiple pool_workqueues which have separate congested states. A
4156 * workqueue being congested on one CPU doesn't mean the workqueue is also
4157 * contested on other CPUs / NUMA nodes.
4158 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004159 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004160 * %true if congested, %false otherwise.
4161 */
Tejun Heod84ff052013-03-12 11:29:59 -07004162bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004163{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004164 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004165 bool ret;
4166
Lai Jiangshan88109452013-03-20 03:28:10 +08004167 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004168
Tejun Heod3251852013-05-10 11:10:17 -07004169 if (cpu == WORK_CPU_UNBOUND)
4170 cpu = smp_processor_id();
4171
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004172 if (!(wq->flags & WQ_UNBOUND))
4173 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4174 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004175 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004176
Tejun Heo76af4d92013-03-12 11:30:00 -07004177 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004178 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004179
4180 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004181}
4182EXPORT_SYMBOL_GPL(workqueue_congested);
4183
4184/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004185 * work_busy - test whether a work is currently pending or running
4186 * @work: the work to be tested
4187 *
4188 * Test whether @work is currently pending or running. There is no
4189 * synchronization around this function and the test result is
4190 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004191 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004192 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004193 * OR'd bitmask of WORK_BUSY_* bits.
4194 */
4195unsigned int work_busy(struct work_struct *work)
4196{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004197 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004198 unsigned long flags;
4199 unsigned int ret = 0;
4200
Tejun Heodcd989c2010-06-29 10:07:14 +02004201 if (work_pending(work))
4202 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004203
Tejun Heofa1b54e2013-03-12 11:30:00 -07004204 local_irq_save(flags);
4205 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004206 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004207 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004208 if (find_worker_executing_work(pool, work))
4209 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004210 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004211 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004212 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004213
4214 return ret;
4215}
4216EXPORT_SYMBOL_GPL(work_busy);
4217
Tejun Heo3d1cb202013-04-30 15:27:22 -07004218/**
4219 * set_worker_desc - set description for the current work item
4220 * @fmt: printf-style format string
4221 * @...: arguments for the format string
4222 *
4223 * This function can be called by a running work function to describe what
4224 * the work item is about. If the worker task gets dumped, this
4225 * information will be printed out together to help debugging. The
4226 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4227 */
4228void set_worker_desc(const char *fmt, ...)
4229{
4230 struct worker *worker = current_wq_worker();
4231 va_list args;
4232
4233 if (worker) {
4234 va_start(args, fmt);
4235 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4236 va_end(args);
4237 worker->desc_valid = true;
4238 }
4239}
4240
4241/**
4242 * print_worker_info - print out worker information and description
4243 * @log_lvl: the log level to use when printing
4244 * @task: target task
4245 *
4246 * If @task is a worker and currently executing a work item, print out the
4247 * name of the workqueue being serviced and worker description set with
4248 * set_worker_desc() by the currently executing work item.
4249 *
4250 * This function can be safely called on any task as long as the
4251 * task_struct itself is accessible. While safe, this function isn't
4252 * synchronized and may print out mixups or garbages of limited length.
4253 */
4254void print_worker_info(const char *log_lvl, struct task_struct *task)
4255{
4256 work_func_t *fn = NULL;
4257 char name[WQ_NAME_LEN] = { };
4258 char desc[WORKER_DESC_LEN] = { };
4259 struct pool_workqueue *pwq = NULL;
4260 struct workqueue_struct *wq = NULL;
4261 bool desc_valid = false;
4262 struct worker *worker;
4263
4264 if (!(task->flags & PF_WQ_WORKER))
4265 return;
4266
4267 /*
4268 * This function is called without any synchronization and @task
4269 * could be in any state. Be careful with dereferences.
4270 */
Petr Mladeke7005912016-10-11 13:55:17 -07004271 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004272
4273 /*
4274 * Carefully copy the associated workqueue's workfn and name. Keep
4275 * the original last '\0' in case the original contains garbage.
4276 */
4277 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4278 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4279 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4280 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4281
4282 /* copy worker description */
4283 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4284 if (desc_valid)
4285 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4286
4287 if (fn || name[0] || desc[0]) {
4288 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4289 if (desc[0])
4290 pr_cont(" (%s)", desc);
4291 pr_cont("\n");
4292 }
4293}
4294
Tejun Heo3494fc32015-03-09 09:22:28 -04004295static void pr_cont_pool_info(struct worker_pool *pool)
4296{
4297 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4298 if (pool->node != NUMA_NO_NODE)
4299 pr_cont(" node=%d", pool->node);
4300 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4301}
4302
4303static void pr_cont_work(bool comma, struct work_struct *work)
4304{
4305 if (work->func == wq_barrier_func) {
4306 struct wq_barrier *barr;
4307
4308 barr = container_of(work, struct wq_barrier, work);
4309
4310 pr_cont("%s BAR(%d)", comma ? "," : "",
4311 task_pid_nr(barr->task));
4312 } else {
4313 pr_cont("%s %pf", comma ? "," : "", work->func);
4314 }
4315}
4316
4317static void show_pwq(struct pool_workqueue *pwq)
4318{
4319 struct worker_pool *pool = pwq->pool;
4320 struct work_struct *work;
4321 struct worker *worker;
4322 bool has_in_flight = false, has_pending = false;
4323 int bkt;
4324
4325 pr_info(" pwq %d:", pool->id);
4326 pr_cont_pool_info(pool);
4327
4328 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4329 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4330
4331 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4332 if (worker->current_pwq == pwq) {
4333 has_in_flight = true;
4334 break;
4335 }
4336 }
4337 if (has_in_flight) {
4338 bool comma = false;
4339
4340 pr_info(" in-flight:");
4341 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4342 if (worker->current_pwq != pwq)
4343 continue;
4344
4345 pr_cont("%s %d%s:%pf", comma ? "," : "",
4346 task_pid_nr(worker->task),
4347 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4348 worker->current_func);
4349 list_for_each_entry(work, &worker->scheduled, entry)
4350 pr_cont_work(false, work);
4351 comma = true;
4352 }
4353 pr_cont("\n");
4354 }
4355
4356 list_for_each_entry(work, &pool->worklist, entry) {
4357 if (get_work_pwq(work) == pwq) {
4358 has_pending = true;
4359 break;
4360 }
4361 }
4362 if (has_pending) {
4363 bool comma = false;
4364
4365 pr_info(" pending:");
4366 list_for_each_entry(work, &pool->worklist, entry) {
4367 if (get_work_pwq(work) != pwq)
4368 continue;
4369
4370 pr_cont_work(comma, work);
4371 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4372 }
4373 pr_cont("\n");
4374 }
4375
4376 if (!list_empty(&pwq->delayed_works)) {
4377 bool comma = false;
4378
4379 pr_info(" delayed:");
4380 list_for_each_entry(work, &pwq->delayed_works, entry) {
4381 pr_cont_work(comma, work);
4382 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4383 }
4384 pr_cont("\n");
4385 }
4386}
4387
4388/**
4389 * show_workqueue_state - dump workqueue state
4390 *
Roger Lu7b776af2016-07-01 11:05:02 +08004391 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4392 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004393 */
4394void show_workqueue_state(void)
4395{
4396 struct workqueue_struct *wq;
4397 struct worker_pool *pool;
4398 unsigned long flags;
4399 int pi;
4400
4401 rcu_read_lock_sched();
4402
4403 pr_info("Showing busy workqueues and worker pools:\n");
4404
4405 list_for_each_entry_rcu(wq, &workqueues, list) {
4406 struct pool_workqueue *pwq;
4407 bool idle = true;
4408
4409 for_each_pwq(pwq, wq) {
4410 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4411 idle = false;
4412 break;
4413 }
4414 }
4415 if (idle)
4416 continue;
4417
4418 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4419
4420 for_each_pwq(pwq, wq) {
4421 spin_lock_irqsave(&pwq->pool->lock, flags);
4422 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4423 show_pwq(pwq);
4424 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4425 }
4426 }
4427
4428 for_each_pool(pool, pi) {
4429 struct worker *worker;
4430 bool first = true;
4431
4432 spin_lock_irqsave(&pool->lock, flags);
4433 if (pool->nr_workers == pool->nr_idle)
4434 goto next_pool;
4435
4436 pr_info("pool %d:", pool->id);
4437 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004438 pr_cont(" hung=%us workers=%d",
4439 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4440 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004441 if (pool->manager)
4442 pr_cont(" manager: %d",
4443 task_pid_nr(pool->manager->task));
4444 list_for_each_entry(worker, &pool->idle_list, entry) {
4445 pr_cont(" %s%d", first ? "idle: " : "",
4446 task_pid_nr(worker->task));
4447 first = false;
4448 }
4449 pr_cont("\n");
4450 next_pool:
4451 spin_unlock_irqrestore(&pool->lock, flags);
4452 }
4453
4454 rcu_read_unlock_sched();
4455}
4456
Tejun Heodb7bccf2010-06-29 10:07:12 +02004457/*
4458 * CPU hotplug.
4459 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004460 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004461 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004462 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004463 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004464 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004465 * blocked draining impractical.
4466 *
Tejun Heo24647572013-01-24 11:01:33 -08004467 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004468 * running as an unbound one and allowing it to be reattached later if the
4469 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004470 */
4471
Tejun Heo706026c2013-01-24 11:01:34 -08004472static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004473{
Tejun Heo38db41d2013-01-24 11:01:34 -08004474 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004475 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004476 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004477
Tejun Heof02ae732013-03-12 11:30:03 -07004478 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004479 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004480 spin_lock_irq(&pool->lock);
4481
4482 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004483 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004484 * unbound and set DISASSOCIATED. Before this, all workers
4485 * except for the ones which are still executing works from
4486 * before the last CPU down must be on the cpu. After
4487 * this, they may become diasporas.
4488 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004489 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004490 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004491
Tejun Heo24647572013-01-24 11:01:33 -08004492 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004493
Tejun Heo94cf58b2013-01-24 11:01:33 -08004494 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004495 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004496
Lai Jiangshaneb283422013-03-08 15:18:28 -08004497 /*
4498 * Call schedule() so that we cross rq->lock and thus can
4499 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4500 * This is necessary as scheduler callbacks may be invoked
4501 * from other cpus.
4502 */
4503 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004504
Lai Jiangshaneb283422013-03-08 15:18:28 -08004505 /*
4506 * Sched callbacks are disabled now. Zap nr_running.
4507 * After this, nr_running stays zero and need_more_worker()
4508 * and keep_working() are always true as long as the
4509 * worklist is not empty. This pool now behaves as an
4510 * unbound (in terms of concurrency management) pool which
4511 * are served by workers tied to the pool.
4512 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004513 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004514
4515 /*
4516 * With concurrency management just turned off, a busy
4517 * worker blocking could lead to lengthy stalls. Kick off
4518 * unbound chain execution of currently pending work items.
4519 */
4520 spin_lock_irq(&pool->lock);
4521 wake_up_worker(pool);
4522 spin_unlock_irq(&pool->lock);
4523 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004524}
4525
Tejun Heobd7c0892013-03-19 13:45:21 -07004526/**
4527 * rebind_workers - rebind all workers of a pool to the associated CPU
4528 * @pool: pool of interest
4529 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004530 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004531 */
4532static void rebind_workers(struct worker_pool *pool)
4533{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004534 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004535
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004536 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004537
Tejun Heoa9ab7752013-03-19 13:45:21 -07004538 /*
4539 * Restore CPU affinity of all workers. As all idle workers should
4540 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304541 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004542 * of all workers first and then clear UNBOUND. As we're called
4543 * from CPU_ONLINE, the following shouldn't fail.
4544 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004545 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004546 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4547 pool->attrs->cpumask) < 0);
4548
4549 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004550
4551 /*
4552 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4553 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4554 * being reworked and this can go away in time.
4555 */
4556 if (!(pool->flags & POOL_DISASSOCIATED)) {
4557 spin_unlock_irq(&pool->lock);
4558 return;
4559 }
4560
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004561 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004562
Lai Jiangshanda028462014-05-20 17:46:31 +08004563 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004564 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004565
4566 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004567 * A bound idle worker should actually be on the runqueue
4568 * of the associated CPU for local wake-ups targeting it to
4569 * work. Kick all idle workers so that they migrate to the
4570 * associated CPU. Doing this in the same loop as
4571 * replacing UNBOUND with REBOUND is safe as no worker will
4572 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004573 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004574 if (worker_flags & WORKER_IDLE)
4575 wake_up_process(worker->task);
4576
4577 /*
4578 * We want to clear UNBOUND but can't directly call
4579 * worker_clr_flags() or adjust nr_running. Atomically
4580 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4581 * @worker will clear REBOUND using worker_clr_flags() when
4582 * it initiates the next execution cycle thus restoring
4583 * concurrency management. Note that when or whether
4584 * @worker clears REBOUND doesn't affect correctness.
4585 *
4586 * ACCESS_ONCE() is necessary because @worker->flags may be
4587 * tested without holding any lock in
4588 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4589 * fail incorrectly leading to premature concurrency
4590 * management operations.
4591 */
4592 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4593 worker_flags |= WORKER_REBOUND;
4594 worker_flags &= ~WORKER_UNBOUND;
4595 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004596 }
4597
Tejun Heoa9ab7752013-03-19 13:45:21 -07004598 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004599}
4600
Tejun Heo7dbc7252013-03-19 13:45:21 -07004601/**
4602 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4603 * @pool: unbound pool of interest
4604 * @cpu: the CPU which is coming up
4605 *
4606 * An unbound pool may end up with a cpumask which doesn't have any online
4607 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4608 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4609 * online CPU before, cpus_allowed of all its workers should be restored.
4610 */
4611static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4612{
4613 static cpumask_t cpumask;
4614 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004615
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004616 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004617
4618 /* is @cpu allowed for @pool? */
4619 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4620 return;
4621
Tejun Heo7dbc7252013-03-19 13:45:21 -07004622 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004623
4624 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004625 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004626 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004627}
4628
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004629int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004630{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004631 struct worker_pool *pool;
4632
4633 for_each_cpu_worker_pool(pool, cpu) {
4634 if (pool->nr_workers)
4635 continue;
4636 if (!create_worker(pool))
4637 return -ENOMEM;
4638 }
4639 return 0;
4640}
4641
4642int workqueue_online_cpu(unsigned int cpu)
4643{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004644 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004645 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004646 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004647
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004648 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004649
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004650 for_each_pool(pool, pi) {
4651 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004652
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004653 if (pool->cpu == cpu)
4654 rebind_workers(pool);
4655 else if (pool->cpu < 0)
4656 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004657
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004658 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004659 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004660
4661 /* update NUMA affinity of unbound workqueues */
4662 list_for_each_entry(wq, &workqueues, list)
4663 wq_update_unbound_numa(wq, cpu, true);
4664
4665 mutex_unlock(&wq_pool_mutex);
4666 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004667}
4668
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004669int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004670{
Tejun Heo8db25e72012-07-17 12:39:28 -07004671 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004672 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004673
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004674 /* unbinding per-cpu workers should happen on the local CPU */
4675 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4676 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004677
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004678 /* update NUMA affinity of unbound workqueues */
4679 mutex_lock(&wq_pool_mutex);
4680 list_for_each_entry(wq, &workqueues, list)
4681 wq_update_unbound_numa(wq, cpu, false);
4682 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004683
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004684 /* wait for per-cpu unbinding to finish */
4685 flush_work(&unbind_work);
4686 destroy_work_on_stack(&unbind_work);
4687 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004688}
4689
Rusty Russell2d3854a2008-11-05 13:39:10 +11004690#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004691
Rusty Russell2d3854a2008-11-05 13:39:10 +11004692struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004693 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004694 long (*fn)(void *);
4695 void *arg;
4696 long ret;
4697};
4698
Tejun Heoed48ece2012-09-18 12:48:43 -07004699static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004700{
Tejun Heoed48ece2012-09-18 12:48:43 -07004701 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4702
Rusty Russell2d3854a2008-11-05 13:39:10 +11004703 wfc->ret = wfc->fn(wfc->arg);
4704}
4705
4706/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004707 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004708 * @cpu: the cpu to run on
4709 * @fn: the function to run
4710 * @arg: the function arg
4711 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004712 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004713 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004714 *
4715 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004716 */
Tejun Heod84ff052013-03-12 11:29:59 -07004717long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004718{
Tejun Heoed48ece2012-09-18 12:48:43 -07004719 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004720
Tejun Heoed48ece2012-09-18 12:48:43 -07004721 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4722 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004723 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004724 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004725 return wfc.ret;
4726}
4727EXPORT_SYMBOL_GPL(work_on_cpu);
4728#endif /* CONFIG_SMP */
4729
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004730#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304731
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004732/**
4733 * freeze_workqueues_begin - begin freezing workqueues
4734 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004735 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004736 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004737 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004738 *
4739 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004740 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004741 */
4742void freeze_workqueues_begin(void)
4743{
Tejun Heo24b8a842013-03-12 11:29:58 -07004744 struct workqueue_struct *wq;
4745 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004746
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004747 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004748
Tejun Heo6183c002013-03-12 11:29:57 -07004749 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004750 workqueue_freezing = true;
4751
Tejun Heo24b8a842013-03-12 11:29:58 -07004752 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004753 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004754 for_each_pwq(pwq, wq)
4755 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004756 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004757 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004758
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004759 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004760}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004761
4762/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004763 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004764 *
4765 * Check whether freezing is complete. This function must be called
4766 * between freeze_workqueues_begin() and thaw_workqueues().
4767 *
4768 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004769 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004770 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004771 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004772 * %true if some freezable workqueues are still busy. %false if freezing
4773 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004774 */
4775bool freeze_workqueues_busy(void)
4776{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004777 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004778 struct workqueue_struct *wq;
4779 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004780
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004781 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004782
Tejun Heo6183c002013-03-12 11:29:57 -07004783 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004784
Tejun Heo24b8a842013-03-12 11:29:58 -07004785 list_for_each_entry(wq, &workqueues, list) {
4786 if (!(wq->flags & WQ_FREEZABLE))
4787 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004788 /*
4789 * nr_active is monotonically decreasing. It's safe
4790 * to peek without lock.
4791 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004792 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004793 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004794 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004795 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004796 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004797 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004798 goto out_unlock;
4799 }
4800 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004801 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004802 }
4803out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004804 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004805 return busy;
4806}
4807
4808/**
4809 * thaw_workqueues - thaw workqueues
4810 *
4811 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004812 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004813 *
4814 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004815 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004816 */
4817void thaw_workqueues(void)
4818{
Tejun Heo24b8a842013-03-12 11:29:58 -07004819 struct workqueue_struct *wq;
4820 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004821
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004822 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004823
4824 if (!workqueue_freezing)
4825 goto out_unlock;
4826
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004827 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004828
Tejun Heo24b8a842013-03-12 11:29:58 -07004829 /* restore max_active and repopulate worklist */
4830 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004831 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004832 for_each_pwq(pwq, wq)
4833 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004834 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004835 }
4836
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004837out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004838 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004839}
4840#endif /* CONFIG_FREEZER */
4841
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004842static int workqueue_apply_unbound_cpumask(void)
4843{
4844 LIST_HEAD(ctxs);
4845 int ret = 0;
4846 struct workqueue_struct *wq;
4847 struct apply_wqattrs_ctx *ctx, *n;
4848
4849 lockdep_assert_held(&wq_pool_mutex);
4850
4851 list_for_each_entry(wq, &workqueues, list) {
4852 if (!(wq->flags & WQ_UNBOUND))
4853 continue;
4854 /* creating multiple pwqs breaks ordering guarantee */
4855 if (wq->flags & __WQ_ORDERED)
4856 continue;
4857
4858 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4859 if (!ctx) {
4860 ret = -ENOMEM;
4861 break;
4862 }
4863
4864 list_add_tail(&ctx->list, &ctxs);
4865 }
4866
4867 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4868 if (!ret)
4869 apply_wqattrs_commit(ctx);
4870 apply_wqattrs_cleanup(ctx);
4871 }
4872
4873 return ret;
4874}
4875
4876/**
4877 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4878 * @cpumask: the cpumask to set
4879 *
4880 * The low-level workqueues cpumask is a global cpumask that limits
4881 * the affinity of all unbound workqueues. This function check the @cpumask
4882 * and apply it to all unbound workqueues and updates all pwqs of them.
4883 *
4884 * Retun: 0 - Success
4885 * -EINVAL - Invalid @cpumask
4886 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4887 */
4888int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4889{
4890 int ret = -EINVAL;
4891 cpumask_var_t saved_cpumask;
4892
4893 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4894 return -ENOMEM;
4895
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004896 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4897 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004898 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004899
4900 /* save the old wq_unbound_cpumask. */
4901 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4902
4903 /* update wq_unbound_cpumask at first and apply it to wqs. */
4904 cpumask_copy(wq_unbound_cpumask, cpumask);
4905 ret = workqueue_apply_unbound_cpumask();
4906
4907 /* restore the wq_unbound_cpumask when failed. */
4908 if (ret < 0)
4909 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4910
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004911 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004912 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004913
4914 free_cpumask_var(saved_cpumask);
4915 return ret;
4916}
4917
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004918#ifdef CONFIG_SYSFS
4919/*
4920 * Workqueues with WQ_SYSFS flag set is visible to userland via
4921 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4922 * following attributes.
4923 *
4924 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4925 * max_active RW int : maximum number of in-flight work items
4926 *
4927 * Unbound workqueues have the following extra attributes.
4928 *
4929 * id RO int : the associated pool ID
4930 * nice RW int : nice value of the workers
4931 * cpumask RW mask : bitmask of allowed CPUs for the workers
4932 */
4933struct wq_device {
4934 struct workqueue_struct *wq;
4935 struct device dev;
4936};
4937
4938static struct workqueue_struct *dev_to_wq(struct device *dev)
4939{
4940 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
4941
4942 return wq_dev->wq;
4943}
4944
4945static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
4946 char *buf)
4947{
4948 struct workqueue_struct *wq = dev_to_wq(dev);
4949
4950 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
4951}
4952static DEVICE_ATTR_RO(per_cpu);
4953
4954static ssize_t max_active_show(struct device *dev,
4955 struct device_attribute *attr, char *buf)
4956{
4957 struct workqueue_struct *wq = dev_to_wq(dev);
4958
4959 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
4960}
4961
4962static ssize_t max_active_store(struct device *dev,
4963 struct device_attribute *attr, const char *buf,
4964 size_t count)
4965{
4966 struct workqueue_struct *wq = dev_to_wq(dev);
4967 int val;
4968
4969 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
4970 return -EINVAL;
4971
4972 workqueue_set_max_active(wq, val);
4973 return count;
4974}
4975static DEVICE_ATTR_RW(max_active);
4976
4977static struct attribute *wq_sysfs_attrs[] = {
4978 &dev_attr_per_cpu.attr,
4979 &dev_attr_max_active.attr,
4980 NULL,
4981};
4982ATTRIBUTE_GROUPS(wq_sysfs);
4983
4984static ssize_t wq_pool_ids_show(struct device *dev,
4985 struct device_attribute *attr, char *buf)
4986{
4987 struct workqueue_struct *wq = dev_to_wq(dev);
4988 const char *delim = "";
4989 int node, written = 0;
4990
4991 rcu_read_lock_sched();
4992 for_each_node(node) {
4993 written += scnprintf(buf + written, PAGE_SIZE - written,
4994 "%s%d:%d", delim, node,
4995 unbound_pwq_by_node(wq, node)->pool->id);
4996 delim = " ";
4997 }
4998 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
4999 rcu_read_unlock_sched();
5000
5001 return written;
5002}
5003
5004static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5005 char *buf)
5006{
5007 struct workqueue_struct *wq = dev_to_wq(dev);
5008 int written;
5009
5010 mutex_lock(&wq->mutex);
5011 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5012 mutex_unlock(&wq->mutex);
5013
5014 return written;
5015}
5016
5017/* prepare workqueue_attrs for sysfs store operations */
5018static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5019{
5020 struct workqueue_attrs *attrs;
5021
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005022 lockdep_assert_held(&wq_pool_mutex);
5023
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005024 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5025 if (!attrs)
5026 return NULL;
5027
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005028 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005029 return attrs;
5030}
5031
5032static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5033 const char *buf, size_t count)
5034{
5035 struct workqueue_struct *wq = dev_to_wq(dev);
5036 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005037 int ret = -ENOMEM;
5038
5039 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005040
5041 attrs = wq_sysfs_prep_attrs(wq);
5042 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005043 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005044
5045 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5046 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005047 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005048 else
5049 ret = -EINVAL;
5050
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005051out_unlock:
5052 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005053 free_workqueue_attrs(attrs);
5054 return ret ?: count;
5055}
5056
5057static ssize_t wq_cpumask_show(struct device *dev,
5058 struct device_attribute *attr, 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, "%*pb\n",
5065 cpumask_pr_args(wq->unbound_attrs->cpumask));
5066 mutex_unlock(&wq->mutex);
5067 return written;
5068}
5069
5070static ssize_t wq_cpumask_store(struct device *dev,
5071 struct device_attribute *attr,
5072 const char *buf, size_t count)
5073{
5074 struct workqueue_struct *wq = dev_to_wq(dev);
5075 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005076 int ret = -ENOMEM;
5077
5078 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005079
5080 attrs = wq_sysfs_prep_attrs(wq);
5081 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005082 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005083
5084 ret = cpumask_parse(buf, attrs->cpumask);
5085 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005086 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005087
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005088out_unlock:
5089 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005090 free_workqueue_attrs(attrs);
5091 return ret ?: count;
5092}
5093
5094static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5095 char *buf)
5096{
5097 struct workqueue_struct *wq = dev_to_wq(dev);
5098 int written;
5099
5100 mutex_lock(&wq->mutex);
5101 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5102 !wq->unbound_attrs->no_numa);
5103 mutex_unlock(&wq->mutex);
5104
5105 return written;
5106}
5107
5108static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5109 const char *buf, size_t count)
5110{
5111 struct workqueue_struct *wq = dev_to_wq(dev);
5112 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005113 int v, ret = -ENOMEM;
5114
5115 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005116
5117 attrs = wq_sysfs_prep_attrs(wq);
5118 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005119 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005120
5121 ret = -EINVAL;
5122 if (sscanf(buf, "%d", &v) == 1) {
5123 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005124 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005125 }
5126
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005127out_unlock:
5128 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005129 free_workqueue_attrs(attrs);
5130 return ret ?: count;
5131}
5132
5133static struct device_attribute wq_sysfs_unbound_attrs[] = {
5134 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5135 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5136 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5137 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5138 __ATTR_NULL,
5139};
5140
5141static struct bus_type wq_subsys = {
5142 .name = "workqueue",
5143 .dev_groups = wq_sysfs_groups,
5144};
5145
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005146static ssize_t wq_unbound_cpumask_show(struct device *dev,
5147 struct device_attribute *attr, char *buf)
5148{
5149 int written;
5150
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005151 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005152 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5153 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005154 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005155
5156 return written;
5157}
5158
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005159static ssize_t wq_unbound_cpumask_store(struct device *dev,
5160 struct device_attribute *attr, const char *buf, size_t count)
5161{
5162 cpumask_var_t cpumask;
5163 int ret;
5164
5165 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5166 return -ENOMEM;
5167
5168 ret = cpumask_parse(buf, cpumask);
5169 if (!ret)
5170 ret = workqueue_set_unbound_cpumask(cpumask);
5171
5172 free_cpumask_var(cpumask);
5173 return ret ? ret : count;
5174}
5175
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005176static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005177 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5178 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005179
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005180static int __init wq_sysfs_init(void)
5181{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005182 int err;
5183
5184 err = subsys_virtual_register(&wq_subsys, NULL);
5185 if (err)
5186 return err;
5187
5188 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005189}
5190core_initcall(wq_sysfs_init);
5191
5192static void wq_device_release(struct device *dev)
5193{
5194 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5195
5196 kfree(wq_dev);
5197}
5198
5199/**
5200 * workqueue_sysfs_register - make a workqueue visible in sysfs
5201 * @wq: the workqueue to register
5202 *
5203 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5204 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5205 * which is the preferred method.
5206 *
5207 * Workqueue user should use this function directly iff it wants to apply
5208 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5209 * apply_workqueue_attrs() may race against userland updating the
5210 * attributes.
5211 *
5212 * Return: 0 on success, -errno on failure.
5213 */
5214int workqueue_sysfs_register(struct workqueue_struct *wq)
5215{
5216 struct wq_device *wq_dev;
5217 int ret;
5218
5219 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305220 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005221 * attributes breaks ordering guarantee. Disallow exposing ordered
5222 * workqueues.
5223 */
5224 if (WARN_ON(wq->flags & __WQ_ORDERED))
5225 return -EINVAL;
5226
5227 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5228 if (!wq_dev)
5229 return -ENOMEM;
5230
5231 wq_dev->wq = wq;
5232 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005233 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005234 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005235
5236 /*
5237 * unbound_attrs are created separately. Suppress uevent until
5238 * everything is ready.
5239 */
5240 dev_set_uevent_suppress(&wq_dev->dev, true);
5241
5242 ret = device_register(&wq_dev->dev);
5243 if (ret) {
5244 kfree(wq_dev);
5245 wq->wq_dev = NULL;
5246 return ret;
5247 }
5248
5249 if (wq->flags & WQ_UNBOUND) {
5250 struct device_attribute *attr;
5251
5252 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5253 ret = device_create_file(&wq_dev->dev, attr);
5254 if (ret) {
5255 device_unregister(&wq_dev->dev);
5256 wq->wq_dev = NULL;
5257 return ret;
5258 }
5259 }
5260 }
5261
5262 dev_set_uevent_suppress(&wq_dev->dev, false);
5263 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5264 return 0;
5265}
5266
5267/**
5268 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5269 * @wq: the workqueue to unregister
5270 *
5271 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5272 */
5273static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5274{
5275 struct wq_device *wq_dev = wq->wq_dev;
5276
5277 if (!wq->wq_dev)
5278 return;
5279
5280 wq->wq_dev = NULL;
5281 device_unregister(&wq_dev->dev);
5282}
5283#else /* CONFIG_SYSFS */
5284static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5285#endif /* CONFIG_SYSFS */
5286
Tejun Heo82607adc2015-12-08 11:28:04 -05005287/*
5288 * Workqueue watchdog.
5289 *
5290 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5291 * flush dependency, a concurrency managed work item which stays RUNNING
5292 * indefinitely. Workqueue stalls can be very difficult to debug as the
5293 * usual warning mechanisms don't trigger and internal workqueue state is
5294 * largely opaque.
5295 *
5296 * Workqueue watchdog monitors all worker pools periodically and dumps
5297 * state if some pools failed to make forward progress for a while where
5298 * forward progress is defined as the first item on ->worklist changing.
5299 *
5300 * This mechanism is controlled through the kernel parameter
5301 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5302 * corresponding sysfs parameter file.
5303 */
5304#ifdef CONFIG_WQ_WATCHDOG
5305
5306static void wq_watchdog_timer_fn(unsigned long data);
5307
5308static unsigned long wq_watchdog_thresh = 30;
5309static struct timer_list wq_watchdog_timer =
5310 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5311
5312static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5313static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5314
5315static void wq_watchdog_reset_touched(void)
5316{
5317 int cpu;
5318
5319 wq_watchdog_touched = jiffies;
5320 for_each_possible_cpu(cpu)
5321 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5322}
5323
5324static void wq_watchdog_timer_fn(unsigned long data)
5325{
5326 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5327 bool lockup_detected = false;
5328 struct worker_pool *pool;
5329 int pi;
5330
5331 if (!thresh)
5332 return;
5333
5334 rcu_read_lock();
5335
5336 for_each_pool(pool, pi) {
5337 unsigned long pool_ts, touched, ts;
5338
5339 if (list_empty(&pool->worklist))
5340 continue;
5341
5342 /* get the latest of pool and touched timestamps */
5343 pool_ts = READ_ONCE(pool->watchdog_ts);
5344 touched = READ_ONCE(wq_watchdog_touched);
5345
5346 if (time_after(pool_ts, touched))
5347 ts = pool_ts;
5348 else
5349 ts = touched;
5350
5351 if (pool->cpu >= 0) {
5352 unsigned long cpu_touched =
5353 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5354 pool->cpu));
5355 if (time_after(cpu_touched, ts))
5356 ts = cpu_touched;
5357 }
5358
5359 /* did we stall? */
5360 if (time_after(jiffies, ts + thresh)) {
5361 lockup_detected = true;
5362 pr_emerg("BUG: workqueue lockup - pool");
5363 pr_cont_pool_info(pool);
5364 pr_cont(" stuck for %us!\n",
5365 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5366 }
5367 }
5368
5369 rcu_read_unlock();
5370
5371 if (lockup_detected)
5372 show_workqueue_state();
5373
5374 wq_watchdog_reset_touched();
5375 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5376}
5377
5378void wq_watchdog_touch(int cpu)
5379{
5380 if (cpu >= 0)
5381 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5382 else
5383 wq_watchdog_touched = jiffies;
5384}
5385
5386static void wq_watchdog_set_thresh(unsigned long thresh)
5387{
5388 wq_watchdog_thresh = 0;
5389 del_timer_sync(&wq_watchdog_timer);
5390
5391 if (thresh) {
5392 wq_watchdog_thresh = thresh;
5393 wq_watchdog_reset_touched();
5394 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5395 }
5396}
5397
5398static int wq_watchdog_param_set_thresh(const char *val,
5399 const struct kernel_param *kp)
5400{
5401 unsigned long thresh;
5402 int ret;
5403
5404 ret = kstrtoul(val, 0, &thresh);
5405 if (ret)
5406 return ret;
5407
5408 if (system_wq)
5409 wq_watchdog_set_thresh(thresh);
5410 else
5411 wq_watchdog_thresh = thresh;
5412
5413 return 0;
5414}
5415
5416static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5417 .set = wq_watchdog_param_set_thresh,
5418 .get = param_get_ulong,
5419};
5420
5421module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5422 0644);
5423
5424static void wq_watchdog_init(void)
5425{
5426 wq_watchdog_set_thresh(wq_watchdog_thresh);
5427}
5428
5429#else /* CONFIG_WQ_WATCHDOG */
5430
5431static inline void wq_watchdog_init(void) { }
5432
5433#endif /* CONFIG_WQ_WATCHDOG */
5434
Tejun Heobce90382013-04-01 11:23:32 -07005435static void __init wq_numa_init(void)
5436{
5437 cpumask_var_t *tbl;
5438 int node, cpu;
5439
Tejun Heobce90382013-04-01 11:23:32 -07005440 if (num_possible_nodes() <= 1)
5441 return;
5442
Tejun Heod55262c2013-04-01 11:23:38 -07005443 if (wq_disable_numa) {
5444 pr_info("workqueue: NUMA affinity support disabled\n");
5445 return;
5446 }
5447
Tejun Heo4c16bd32013-04-01 11:23:36 -07005448 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5449 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5450
Tejun Heobce90382013-04-01 11:23:32 -07005451 /*
5452 * We want masks of possible CPUs of each node which isn't readily
5453 * available. Build one from cpu_to_node() which should have been
5454 * fully initialized by now.
5455 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005456 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005457 BUG_ON(!tbl);
5458
5459 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005460 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005461 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005462
5463 for_each_possible_cpu(cpu) {
5464 node = cpu_to_node(cpu);
5465 if (WARN_ON(node == NUMA_NO_NODE)) {
5466 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5467 /* happens iff arch is bonkers, let's just proceed */
5468 return;
5469 }
5470 cpumask_set_cpu(cpu, tbl[node]);
5471 }
5472
5473 wq_numa_possible_cpumask = tbl;
5474 wq_numa_enabled = true;
5475}
5476
Suresh Siddha6ee05782010-07-30 14:57:37 -07005477static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005478{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005479 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5480 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005481
Tejun Heoe904e6c2013-03-12 11:29:57 -07005482 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5483
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005484 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5485 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5486
Tejun Heoe904e6c2013-03-12 11:29:57 -07005487 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5488
Tejun Heobce90382013-04-01 11:23:32 -07005489 wq_numa_init();
5490
Tejun Heo706026c2013-01-24 11:01:34 -08005491 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005492 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005493 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005494
Tejun Heo7a4e3442013-03-12 11:30:00 -07005495 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005496 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005497 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005498 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005499 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005500 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005501 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005502
Tejun Heo9daf9e62013-01-24 11:01:33 -08005503 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005504 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005505 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005506 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005507 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005508 }
5509
Tejun Heoe22bee72010-06-29 10:07:14 +02005510 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07005511 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005512 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02005513
Tejun Heof02ae732013-03-12 11:30:03 -07005514 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07005515 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08005516 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07005517 }
Tejun Heoe22bee72010-06-29 10:07:14 +02005518 }
5519
Tejun Heo8a2b7532013-09-05 12:30:04 -04005520 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005521 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5522 struct workqueue_attrs *attrs;
5523
5524 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005525 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005526 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005527
5528 /*
5529 * An ordered wq should have only one pwq as ordering is
5530 * guaranteed by max_active which is enforced by pwqs.
5531 * Turn off NUMA so that dfl_pwq is used for all nodes.
5532 */
5533 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5534 attrs->nice = std_nice[i];
5535 attrs->no_numa = true;
5536 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005537 }
5538
Tejun Heod320c032010-06-29 10:07:14 +02005539 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005540 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005541 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005542 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5543 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005544 system_freezable_wq = alloc_workqueue("events_freezable",
5545 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305546 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5547 WQ_POWER_EFFICIENT, 0);
5548 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5549 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5550 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005551 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305552 !system_unbound_wq || !system_freezable_wq ||
5553 !system_power_efficient_wq ||
5554 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005555
5556 wq_watchdog_init();
5557
Suresh Siddha6ee05782010-07-30 14:57:37 -07005558 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005559}
Suresh Siddha6ee05782010-07-30 14:57:37 -07005560early_initcall(init_workqueues);