blob: c77fdf6bf24f45d5c223b2ebdc194dbd3ae38e1f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070024 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800130 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
131 *
132 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
133 * sched-RCU for reads.
134 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700135 * WQ: wq->mutex protected.
136 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700137 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700138 *
139 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200140 */
141
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800142/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200143
Tejun Heobd7bdd42012-07-12 14:46:37 -0700144struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800145 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700146 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700147 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800148 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700149 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150
Tejun Heo82607adc2015-12-08 11:28:04 -0500151 unsigned long watchdog_ts; /* L: watchdog timestamp */
152
Tejun Heobd7bdd42012-07-12 14:46:37 -0700153 struct list_head worklist; /* L: list of pending works */
154 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700155
156 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700157 int nr_idle; /* L: currently idle ones */
158
159 struct list_head idle_list; /* X: list of idle workers */
160 struct timer_list idle_timer; /* L: worker idle timeout */
161 struct timer_list mayday_timer; /* L: SOS timer for workers */
162
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700163 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800164 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
165 /* L: hash of busy workers */
166
Tejun Heobc3a1af2013-03-13 19:47:39 -0700167 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700168 struct mutex manager_arb; /* manager arbitration */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400169 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800170 struct mutex attach_mutex; /* attach/detach exclusion */
171 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800172 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800174 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800175
Tejun Heo7a4e3442013-03-12 11:30:00 -0700176 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700177 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
178 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700179
Tejun Heoe19e3972013-01-24 11:39:44 -0800180 /*
181 * The current concurrency level. As it's likely to be accessed
182 * from other CPUs during try_to_wake_up(), put it in a separate
183 * cacheline.
184 */
185 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700186
187 /*
188 * Destruction of pool is sched-RCU protected to allow dereferences
189 * from get_work_pool().
190 */
191 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200192} ____cacheline_aligned_in_smp;
193
194/*
Tejun Heo112202d2013-02-13 19:29:12 -0800195 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
196 * of work_struct->data are used for flags and the remaining high bits
197 * point to the pwq; thus, pwqs need to be aligned at two's power of the
198 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 */
Tejun Heo112202d2013-02-13 19:29:12 -0800200struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700201 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200202 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200203 int work_color; /* L: current color */
204 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700205 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200206 int nr_in_flight[WORK_NR_COLORS];
207 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200209 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200210 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700211 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700212 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700213
214 /*
215 * Release of unbound pwq is punted to system_wq. See put_pwq()
216 * and pwq_unbound_release_workfn() for details. pool_workqueue
217 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700218 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700219 */
220 struct work_struct unbound_release_work;
221 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700222} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200225 * Structure used to wait for workqueue flush.
226 */
227struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700228 struct list_head list; /* WQ: list of flushers */
229 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200230 struct completion done; /* flush completion */
231};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Tejun Heo226223a2013-03-12 11:30:05 -0700233struct wq_device;
234
Tejun Heo73f53c42010-06-29 10:07:11 +0200235/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700236 * The externally visible workqueue. It relays the issued work items to
237 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 */
239struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700240 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400241 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200242
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700243 struct mutex mutex; /* protects this wq */
244 int work_color; /* WQ: current work color */
245 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800246 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700247 struct wq_flusher *first_flusher; /* WQ: first flusher */
248 struct list_head flusher_queue; /* WQ: flush waiters */
249 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200250
Tejun Heo2e109a22013-03-13 19:47:40 -0700251 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200252 struct worker *rescuer; /* I: rescue worker */
253
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700254 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700255 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700256
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800257 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
258 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700259
Tejun Heo226223a2013-03-12 11:30:05 -0700260#ifdef CONFIG_SYSFS
261 struct wq_device *wq_dev; /* I: for sysfs interface */
262#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700266 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700267
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400268 /*
269 * Destruction of workqueue_struct is sched-RCU protected to allow
270 * walking the workqueues list without grabbing wq_pool_mutex.
271 * This is used to dump all workqueues from sysrq.
272 */
273 struct rcu_head rcu;
274
Tejun Heo2728fd22013-04-01 11:23:35 -0700275 /* hot fields used during command issue, aligned to cacheline */
276 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
277 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800278 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279};
280
Tejun Heoe904e6c2013-03-12 11:29:57 -0700281static struct kmem_cache *pwq_cache;
282
Tejun Heobce90382013-04-01 11:23:32 -0700283static cpumask_var_t *wq_numa_possible_cpumask;
284 /* possible CPUs of each node */
285
Tejun Heod55262c2013-04-01 11:23:38 -0700286static bool wq_disable_numa;
287module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930290static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292
Tejun Heo863b7102016-09-16 15:49:34 -0400293static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400294
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 Heof303fccb2016-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 Heo794b18bc2013-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, Changbinb9fdac7f2016-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, Changbinb9fdac7f2016-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 Heo974271c42012-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 Heo974271c42012-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();
Tejun Heo36e227d2012-08-03 10:30:46 -07001277 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001278}
1279
1280/**
Tejun Heo706026c2013-01-24 11:01:34 -08001281 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001282 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001283 * @work: work to insert
1284 * @head: insertion point
1285 * @extra_flags: extra WORK_STRUCT_* flags to set
1286 *
Tejun Heo112202d2013-02-13 19:29:12 -08001287 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001288 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001289 *
1290 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001291 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001292 */
Tejun Heo112202d2013-02-13 19:29:12 -08001293static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1294 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001295{
Tejun Heo112202d2013-02-13 19:29:12 -08001296 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001297
Tejun Heo4690c4a2010-06-29 10:07:10 +02001298 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001299 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001300 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001301 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001302
1303 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001304 * Ensure either wq_worker_sleeping() sees the above
1305 * list_add_tail() or we see zero nr_running to avoid workers lying
1306 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001307 */
1308 smp_mb();
1309
Tejun Heo63d95a92012-07-12 14:46:37 -07001310 if (__need_more_worker(pool))
1311 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001312}
1313
Tejun Heoc8efcc22010-12-20 19:32:04 +01001314/*
1315 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001316 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001317 */
1318static bool is_chained_work(struct workqueue_struct *wq)
1319{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001320 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001321
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001322 worker = current_wq_worker();
1323 /*
1324 * Return %true iff I'm a worker execuing a work item on @wq. If
1325 * I'm @worker, it's safe to dereference it without locking.
1326 */
Tejun Heo112202d2013-02-13 19:29:12 -08001327 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001328}
1329
Mike Galbraithef5571802016-02-09 17:59:38 -05001330/*
1331 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1332 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1333 * avoid perturbing sensitive tasks.
1334 */
1335static int wq_select_unbound_cpu(int cpu)
1336{
Tejun Heof303fccb2016-02-09 17:59:38 -05001337 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001338 int new_cpu;
1339
Tejun Heof303fccb2016-02-09 17:59:38 -05001340 if (likely(!wq_debug_force_rr_cpu)) {
1341 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1342 return cpu;
1343 } else if (!printed_dbg_warning) {
1344 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1345 printed_dbg_warning = true;
1346 }
1347
Mike Galbraithef5571802016-02-09 17:59:38 -05001348 if (cpumask_empty(wq_unbound_cpumask))
1349 return cpu;
1350
1351 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1352 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1353 if (unlikely(new_cpu >= nr_cpu_ids)) {
1354 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1355 if (unlikely(new_cpu >= nr_cpu_ids))
1356 return cpu;
1357 }
1358 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1359
1360 return new_cpu;
1361}
1362
Tejun Heod84ff052013-03-12 11:29:59 -07001363static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 struct work_struct *work)
1365{
Tejun Heo112202d2013-02-13 19:29:12 -08001366 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001367 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001368 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001369 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001370 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001371
1372 /*
1373 * While a work item is PENDING && off queue, a task trying to
1374 * steal the PENDING will busy-loop waiting for it to either get
1375 * queued or lose PENDING. Grabbing PENDING and queueing should
1376 * happen with IRQ disabled.
1377 */
1378 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001380 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001381
Li Bin9ef28a72013-09-09 13:13:58 +08001382 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001383 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001384 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001385 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001386retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001387 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001388 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001389
Tejun Heoc9178082013-03-12 11:30:04 -07001390 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001391 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001392 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 else
1394 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001395
Tejun Heoc9178082013-03-12 11:30:04 -07001396 /*
1397 * If @work was previously on a different pool, it might still be
1398 * running there, in which case the work needs to be queued on that
1399 * pool to guarantee non-reentrancy.
1400 */
1401 last_pool = get_work_pool(work);
1402 if (last_pool && last_pool != pwq->pool) {
1403 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001404
Tejun Heoc9178082013-03-12 11:30:04 -07001405 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001406
Tejun Heoc9178082013-03-12 11:30:04 -07001407 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001408
Tejun Heoc9178082013-03-12 11:30:04 -07001409 if (worker && worker->current_pwq->wq == wq) {
1410 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001411 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001412 /* meh... not running there, queue here */
1413 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001414 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001415 }
Tejun Heof3421792010-07-02 10:03:51 +02001416 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001417 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001418 }
1419
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001420 /*
1421 * pwq is determined and locked. For unbound pools, we could have
1422 * raced with pwq release and it could already be dead. If its
1423 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001424 * without another pwq replacing it in the numa_pwq_tbl or while
1425 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001426 * make forward-progress.
1427 */
1428 if (unlikely(!pwq->refcnt)) {
1429 if (wq->flags & WQ_UNBOUND) {
1430 spin_unlock(&pwq->pool->lock);
1431 cpu_relax();
1432 goto retry;
1433 }
1434 /* oops */
1435 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1436 wq->name, cpu);
1437 }
1438
Tejun Heo112202d2013-02-13 19:29:12 -08001439 /* pwq determined, queue */
1440 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001441
Dan Carpenterf5b25522012-04-13 22:06:58 +03001442 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001443 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001444 return;
1445 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001446
Tejun Heo112202d2013-02-13 19:29:12 -08001447 pwq->nr_in_flight[pwq->work_color]++;
1448 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001449
Tejun Heo112202d2013-02-13 19:29:12 -08001450 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001451 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001452 pwq->nr_active++;
1453 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001454 if (list_empty(worklist))
1455 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001456 } else {
1457 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001458 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001459 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001460
Tejun Heo112202d2013-02-13 19:29:12 -08001461 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001462
Tejun Heo112202d2013-02-13 19:29:12 -08001463 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001466/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001467 * queue_work_on - queue work on specific cpu
1468 * @cpu: CPU number to execute work on
1469 * @wq: workqueue to use
1470 * @work: work to queue
1471 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001472 * We queue the work to a specific CPU, the caller must ensure it
1473 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001474 *
1475 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001476 */
Tejun Heod4283e92012-08-03 10:30:44 -07001477bool queue_work_on(int cpu, struct workqueue_struct *wq,
1478 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001479{
Tejun Heod4283e92012-08-03 10:30:44 -07001480 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001481 unsigned long flags;
1482
1483 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001484
Tejun Heo22df02b2010-06-29 10:07:10 +02001485 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001486 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001487 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001488 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001489
1490 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001491 return ret;
1492}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001493EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494
Kees Cook8c20feb2017-10-04 16:27:07 -07001495void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
Kees Cook8c20feb2017-10-04 16:27:07 -07001497 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001499 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001500 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001502EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001504static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1505 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001507 struct timer_list *timer = &dwork->timer;
1508 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Tejun Heo637fdba2017-03-06 15:33:42 -05001510 WARN_ON_ONCE(!wq);
Kees Cook8c20feb2017-10-04 16:27:07 -07001511 WARN_ON_ONCE(timer->function != (TIMER_FUNC_TYPE)delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001512 WARN_ON_ONCE(timer_pending(timer));
1513 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001514
Tejun Heo8852aac2012-12-01 16:23:42 -08001515 /*
1516 * If @delay is 0, queue @dwork->work immediately. This is for
1517 * both optimization and correctness. The earliest @timer can
1518 * expire is on the closest next tick and delayed_work users depend
1519 * on that there's no such delay when @delay is 0.
1520 */
1521 if (!delay) {
1522 __queue_work(cpu, wq, &dwork->work);
1523 return;
1524 }
1525
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001526 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001527 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001528 timer->expires = jiffies + delay;
1529
Tejun Heo041bd122016-02-09 16:11:26 -05001530 if (unlikely(cpu != WORK_CPU_UNBOUND))
1531 add_timer_on(timer, cpu);
1532 else
1533 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
1535
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001536/**
1537 * queue_delayed_work_on - queue work on specific CPU after delay
1538 * @cpu: CPU number to execute work on
1539 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001540 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001541 * @delay: number of jiffies to wait before queueing
1542 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001543 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001544 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1545 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001546 */
Tejun Heod4283e92012-08-03 10:30:44 -07001547bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1548 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001549{
David Howells52bad642006-11-22 14:54:01 +00001550 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001551 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001552 unsigned long flags;
1553
1554 /* read the comment in __queue_work() */
1555 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001556
Tejun Heo22df02b2010-06-29 10:07:10 +02001557 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001558 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001559 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001560 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001561
1562 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001563 return ret;
1564}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001565EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Tejun Heoc8e55f32010-06-29 10:07:12 +02001567/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001568 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1569 * @cpu: CPU number to execute work on
1570 * @wq: workqueue to use
1571 * @dwork: work to queue
1572 * @delay: number of jiffies to wait before queueing
1573 *
1574 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1575 * modify @dwork's timer so that it expires after @delay. If @delay is
1576 * zero, @work is guaranteed to be scheduled immediately regardless of its
1577 * current state.
1578 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001579 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001580 * pending and its timer was modified.
1581 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001582 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001583 * See try_to_grab_pending() for details.
1584 */
1585bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1586 struct delayed_work *dwork, unsigned long delay)
1587{
1588 unsigned long flags;
1589 int ret;
1590
1591 do {
1592 ret = try_to_grab_pending(&dwork->work, true, &flags);
1593 } while (unlikely(ret == -EAGAIN));
1594
1595 if (likely(ret >= 0)) {
1596 __queue_delayed_work(cpu, wq, dwork, delay);
1597 local_irq_restore(flags);
1598 }
1599
1600 /* -ENOENT from try_to_grab_pending() becomes %true */
1601 return ret;
1602}
1603EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1604
1605/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001606 * worker_enter_idle - enter idle state
1607 * @worker: worker which is entering idle state
1608 *
1609 * @worker is entering idle state. Update stats and idle timer if
1610 * necessary.
1611 *
1612 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001613 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001614 */
1615static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001617 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Tejun Heo6183c002013-03-12 11:29:57 -07001619 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1620 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1621 (worker->hentry.next || worker->hentry.pprev)))
1622 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623
Lai Jiangshan051e1852014-07-22 13:03:02 +08001624 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001625 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001626 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001627 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001628
Tejun Heoc8e55f32010-06-29 10:07:12 +02001629 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001630 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001631
Tejun Heo628c78e2012-07-17 12:39:27 -07001632 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1633 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001634
Tejun Heo544ecf32012-05-14 15:04:50 -07001635 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001636 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001637 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001638 * nr_running, the warning may trigger spuriously. Check iff
1639 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001640 */
Tejun Heo24647572013-01-24 11:01:33 -08001641 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001642 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001643 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644}
1645
Tejun Heoc8e55f32010-06-29 10:07:12 +02001646/**
1647 * worker_leave_idle - leave idle state
1648 * @worker: worker which is leaving idle state
1649 *
1650 * @worker is leaving idle state. Update stats.
1651 *
1652 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001653 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001654 */
1655static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001657 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Tejun Heo6183c002013-03-12 11:29:57 -07001659 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1660 return;
Tejun Heod302f012010-06-29 10:07:13 +02001661 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001662 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001663 list_del_init(&worker->entry);
1664}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001666static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001667{
1668 struct worker *worker;
1669
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001670 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001671 if (worker) {
1672 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001673 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001674 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001675 /* on creation a worker is in !idle && prep state */
1676 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001677 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001678 return worker;
1679}
1680
1681/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001682 * worker_attach_to_pool() - attach a worker to a pool
1683 * @worker: worker to be attached
1684 * @pool: the target pool
1685 *
1686 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1687 * cpu-binding of @worker are kept coordinated with the pool across
1688 * cpu-[un]hotplugs.
1689 */
1690static void worker_attach_to_pool(struct worker *worker,
1691 struct worker_pool *pool)
1692{
1693 mutex_lock(&pool->attach_mutex);
1694
1695 /*
1696 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1697 * online CPUs. It'll be re-applied when any of the CPUs come up.
1698 */
1699 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1700
1701 /*
1702 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1703 * stable across this function. See the comments above the
1704 * flag definition for details.
1705 */
1706 if (pool->flags & POOL_DISASSOCIATED)
1707 worker->flags |= WORKER_UNBOUND;
1708
1709 list_add_tail(&worker->node, &pool->workers);
1710
1711 mutex_unlock(&pool->attach_mutex);
1712}
1713
1714/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001715 * worker_detach_from_pool() - detach a worker from its pool
1716 * @worker: worker which is attached to its pool
1717 * @pool: the pool @worker is attached to
1718 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001719 * Undo the attaching which had been done in worker_attach_to_pool(). The
1720 * caller worker shouldn't access to the pool after detached except it has
1721 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001722 */
1723static void worker_detach_from_pool(struct worker *worker,
1724 struct worker_pool *pool)
1725{
1726 struct completion *detach_completion = NULL;
1727
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001728 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001729 list_del(&worker->node);
1730 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001731 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001732 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001733
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001734 /* clear leftover flags without pool->lock after it is detached */
1735 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1736
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001737 if (detach_completion)
1738 complete(detach_completion);
1739}
1740
1741/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001742 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001743 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001744 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001745 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001746 *
1747 * CONTEXT:
1748 * Might sleep. Does GFP_KERNEL allocations.
1749 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001750 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001751 * Pointer to the newly created worker.
1752 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001753static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001754{
Tejun Heoc34056a2010-06-29 10:07:11 +02001755 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001756 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001757 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001758
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001759 /* ID is needed to determine kthread name */
1760 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001761 if (id < 0)
1762 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001763
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001764 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001765 if (!worker)
1766 goto fail;
1767
Tejun Heobd7bdd42012-07-12 14:46:37 -07001768 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 worker->id = id;
1770
Tejun Heo29c91e92013-03-12 11:30:03 -07001771 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001772 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1773 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001774 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001775 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1776
Tejun Heof3f90ad2013-04-01 11:23:34 -07001777 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001778 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 if (IS_ERR(worker->task))
1780 goto fail;
1781
Oleg Nesterov91151222013-11-14 12:56:18 +01001782 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001783 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001784
Lai Jiangshanda028462014-05-20 17:46:31 +08001785 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001786 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001787
Lai Jiangshan051e1852014-07-22 13:03:02 +08001788 /* start the newly created worker */
1789 spin_lock_irq(&pool->lock);
1790 worker->pool->nr_workers++;
1791 worker_enter_idle(worker);
1792 wake_up_process(worker->task);
1793 spin_unlock_irq(&pool->lock);
1794
Tejun Heoc34056a2010-06-29 10:07:11 +02001795 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001796
Tejun Heoc34056a2010-06-29 10:07:11 +02001797fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001798 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001799 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001800 kfree(worker);
1801 return NULL;
1802}
1803
1804/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001805 * destroy_worker - destroy a workqueue worker
1806 * @worker: worker to be destroyed
1807 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001808 * Destroy @worker and adjust @pool stats accordingly. The worker should
1809 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001810 *
1811 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001812 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001813 */
1814static void destroy_worker(struct worker *worker)
1815{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001816 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001817
Tejun Heocd549682013-03-13 19:47:39 -07001818 lockdep_assert_held(&pool->lock);
1819
Tejun Heoc34056a2010-06-29 10:07:11 +02001820 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001821 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001822 WARN_ON(!list_empty(&worker->scheduled)) ||
1823 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001824 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001825
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001826 pool->nr_workers--;
1827 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001828
Tejun Heoc8e55f32010-06-29 10:07:12 +02001829 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001830 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001831 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001832}
1833
Tejun Heo63d95a92012-07-12 14:46:37 -07001834static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001835{
Tejun Heo63d95a92012-07-12 14:46:37 -07001836 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001837
Tejun Heod565ed62013-01-24 11:01:33 -08001838 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001839
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001840 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001841 struct worker *worker;
1842 unsigned long expires;
1843
1844 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001845 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001846 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1847
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001848 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001849 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001850 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001851 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001852
1853 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001854 }
1855
Tejun Heod565ed62013-01-24 11:01:33 -08001856 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001857}
1858
Tejun Heo493a1722013-03-12 11:29:59 -07001859static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001860{
Tejun Heo112202d2013-02-13 19:29:12 -08001861 struct pool_workqueue *pwq = get_work_pwq(work);
1862 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001863
Tejun Heo2e109a22013-03-13 19:47:40 -07001864 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001865
Tejun Heo493008a2013-03-12 11:30:03 -07001866 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001867 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001868
1869 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001870 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001871 /*
1872 * If @pwq is for an unbound wq, its base ref may be put at
1873 * any time due to an attribute change. Pin @pwq until the
1874 * rescuer is done with it.
1875 */
1876 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001877 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001878 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001879 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001880}
1881
Tejun Heo706026c2013-01-24 11:01:34 -08001882static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001883{
Tejun Heo63d95a92012-07-12 14:46:37 -07001884 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001885 struct work_struct *work;
1886
Tejun Heob2d82902014-12-08 12:39:16 -05001887 spin_lock_irq(&pool->lock);
1888 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001889
Tejun Heo63d95a92012-07-12 14:46:37 -07001890 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001891 /*
1892 * We've been trying to create a new worker but
1893 * haven't been successful. We might be hitting an
1894 * allocation deadlock. Send distress signals to
1895 * rescuers.
1896 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001897 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001898 send_mayday(work);
1899 }
1900
Tejun Heob2d82902014-12-08 12:39:16 -05001901 spin_unlock(&wq_mayday_lock);
1902 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001903
Tejun Heo63d95a92012-07-12 14:46:37 -07001904 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001905}
1906
1907/**
1908 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 * have at least one idle worker on return from this function. If
1913 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001914 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 * possible allocation deadlock.
1916 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001917 * On return, need_to_create_worker() is guaranteed to be %false and
1918 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001919 *
1920 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001921 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001922 * multiple times. Does GFP_KERNEL allocations. Called only from
1923 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001924 */
Tejun Heo29187a92015-01-16 14:21:16 -05001925static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001926__releases(&pool->lock)
1927__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001928{
Tejun Heoe22bee72010-06-29 10:07:14 +02001929restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001930 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001931
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001933 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001934
1935 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001936 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001937 break;
1938
Lai Jiangshane212f362014-06-03 15:32:17 +08001939 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001940
Tejun Heo63d95a92012-07-12 14:46:37 -07001941 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 break;
1943 }
1944
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001946 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001947 /*
1948 * This is necessary even after a new worker was just successfully
1949 * created as @pool->lock was dropped and the new worker might have
1950 * already become busy.
1951 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001952 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001953 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001954}
1955
1956/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 * manage_workers - manage worker pool
1958 * @worker: self
1959 *
Tejun Heo706026c2013-01-24 11:01:34 -08001960 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001961 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001962 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001963 *
1964 * The caller can safely start processing works on false return. On
1965 * true return, it's guaranteed that need_to_create_worker() is false
1966 * and may_start_working() is true.
1967 *
1968 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001969 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 * multiple times. Does GFP_KERNEL allocations.
1971 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001972 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001973 * %false if the pool doesn't need management and the caller can safely
1974 * start processing works, %true if management function was performed and
1975 * the conditions that the caller verified before calling the function may
1976 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 */
1978static bool manage_workers(struct worker *worker)
1979{
Tejun Heo63d95a92012-07-12 14:46:37 -07001980 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001981
Tejun Heobc3a1af2013-03-13 19:47:39 -07001982 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001983 * Anyone who successfully grabs manager_arb wins the arbitration
1984 * and becomes the manager. mutex_trylock() on pool->manager_arb
1985 * failure while holding pool->lock reliably indicates that someone
1986 * else is managing the pool and the worker which failed trylock
1987 * can proceed to executing work items. This means that anyone
1988 * grabbing manager_arb is responsible for actually performing
1989 * manager duties. If manager_arb is grabbed and released without
1990 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001991 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001992 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001993 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001994 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001995
Tejun Heo29187a92015-01-16 14:21:16 -05001996 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001997
Tejun Heo2607d7a2015-03-09 09:22:28 -04001998 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07001999 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05002000 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002001}
2002
Tejun Heoa62428c2010-06-29 10:07:10 +02002003/**
2004 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002005 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002006 * @work: work to process
2007 *
2008 * Process @work. This function contains all the logics necessary to
2009 * process a single work including synchronization against and
2010 * interaction with other workers on the same cpu, queueing and
2011 * flushing. As long as context requirement is met, any worker can
2012 * call this function to process a work.
2013 *
2014 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002015 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002016 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002017static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002018__releases(&pool->lock)
2019__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002020{
Tejun Heo112202d2013-02-13 19:29:12 -08002021 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002022 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002023 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002024 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002025 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002026#ifdef CONFIG_LOCKDEP
2027 /*
2028 * It is permissible to free the struct work_struct from
2029 * inside the function that is called from it, this we need to
2030 * take into account for lockdep too. To avoid bogus "held
2031 * lock freed" warnings as well as problems when looking into
2032 * work->lockdep_map, make a copy and use that here.
2033 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002034 struct lockdep_map lockdep_map;
2035
2036 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002037#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002038 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002039 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002040 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002041
Tejun Heo7e116292010-06-29 10:07:13 +02002042 /*
2043 * A single work shouldn't be executed concurrently by
2044 * multiple workers on a single cpu. Check whether anyone is
2045 * already processing the work. If so, defer the work to the
2046 * currently executing one.
2047 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002048 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002049 if (unlikely(collision)) {
2050 move_linked_works(work, &collision->scheduled, NULL);
2051 return;
2052 }
2053
Tejun Heo8930cab2012-08-03 10:30:45 -07002054 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002055 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002056 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002057 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002058 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002059 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002060 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002061
Tejun Heoa62428c2010-06-29 10:07:10 +02002062 list_del_init(&work->entry);
2063
Tejun Heo649027d2010-06-29 10:07:14 +02002064 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002065 * CPU intensive works don't participate in concurrency management.
2066 * They're the scheduler's responsibility. This takes @worker out
2067 * of concurrency management and the next code block will chain
2068 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002069 */
2070 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002071 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002072
Tejun Heo974271c42012-07-12 14:46:37 -07002073 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002074 * Wake up another worker if necessary. The condition is always
2075 * false for normal per-cpu workers since nr_running would always
2076 * be >= 1 at this point. This is used to chain execution of the
2077 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002078 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002079 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002080 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002081 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002082
Tejun Heo8930cab2012-08-03 10:30:45 -07002083 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002084 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002085 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002086 * PENDING and queued state changes happen together while IRQ is
2087 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002088 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002089 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002090
Tejun Heod565ed62013-01-24 11:01:33 -08002091 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002092
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002093 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002094 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002095 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002096 * Strictly speaking we should mark the invariant state without holding
2097 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002098 *
2099 * However, that would result in:
2100 *
2101 * A(W1)
2102 * WFC(C)
2103 * A(W1)
2104 * C(C)
2105 *
2106 * Which would create W1->C->W1 dependencies, even though there is no
2107 * actual deadlock possible. There are two solutions, using a
2108 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002109 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002110 * these locks.
2111 *
2112 * AFAICT there is no possible deadlock scenario between the
2113 * flush_work() and complete() primitives (except for single-threaded
2114 * workqueues), so hiding them isn't a problem.
2115 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002116 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002117 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002118 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002119 /*
2120 * While we must be careful to not use "work" after this, the trace
2121 * point will only record its address.
2122 */
2123 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002124 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002125 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002126
2127 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002128 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2129 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002130 current->comm, preempt_count(), task_pid_nr(current),
2131 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002132 debug_show_held_locks(current);
2133 dump_stack();
2134 }
2135
Tejun Heob22ce272013-08-28 17:33:37 -04002136 /*
2137 * The following prevents a kworker from hogging CPU on !PREEMPT
2138 * kernels, where a requeueing work item waiting for something to
2139 * happen could deadlock with stop_machine as such work item could
2140 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002141 * stop_machine. At the same time, report a quiescent RCU state so
2142 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002143 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002144 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002145
Tejun Heod565ed62013-01-24 11:01:33 -08002146 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002147
Tejun Heofb0e7be2010-06-29 10:07:15 +02002148 /* clear cpu intensive status */
2149 if (unlikely(cpu_intensive))
2150 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2151
Tejun Heoa62428c2010-06-29 10:07:10 +02002152 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002153 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002154 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002155 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002156 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002157 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002158 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002159}
2160
Tejun Heoaffee4b2010-06-29 10:07:12 +02002161/**
2162 * process_scheduled_works - process scheduled works
2163 * @worker: self
2164 *
2165 * Process all scheduled works. Please note that the scheduled list
2166 * may change while processing a work, so this function repeatedly
2167 * fetches a work from the top and executes it.
2168 *
2169 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002170 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002171 * multiple times.
2172 */
2173static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002175 while (!list_empty(&worker->scheduled)) {
2176 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002178 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180}
2181
Tejun Heo4690c4a2010-06-29 10:07:10 +02002182/**
2183 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002184 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002185 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002186 * The worker thread function. All workers belong to a worker_pool -
2187 * either a per-cpu one or dynamic unbound one. These workers process all
2188 * work items regardless of their specific target workqueue. The only
2189 * exception is work items which belong to workqueues with a rescuer which
2190 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002191 *
2192 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002193 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002194static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195{
Tejun Heoc34056a2010-06-29 10:07:11 +02002196 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002197 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198
Tejun Heoe22bee72010-06-29 10:07:14 +02002199 /* tell the scheduler that this is a workqueue worker */
2200 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002201woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002202 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002203
Tejun Heoa9ab7752013-03-19 13:45:21 -07002204 /* am I supposed to die? */
2205 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002206 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002207 WARN_ON_ONCE(!list_empty(&worker->entry));
2208 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002209
2210 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002211 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002212 worker_detach_from_pool(worker, pool);
2213 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002214 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002216
Tejun Heoc8e55f32010-06-29 10:07:12 +02002217 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002218recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002219 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002220 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002221 goto sleep;
2222
2223 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002224 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002225 goto recheck;
2226
Tejun Heoc8e55f32010-06-29 10:07:12 +02002227 /*
2228 * ->scheduled list can only be filled while a worker is
2229 * preparing to process a work or actually processing it.
2230 * Make sure nobody diddled with it while I was sleeping.
2231 */
Tejun Heo6183c002013-03-12 11:29:57 -07002232 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002233
Tejun Heoe22bee72010-06-29 10:07:14 +02002234 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002235 * Finish PREP stage. We're guaranteed to have at least one idle
2236 * worker or that someone else has already assumed the manager
2237 * role. This is where @worker starts participating in concurrency
2238 * management if applicable and concurrency management is restored
2239 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002240 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002241 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002242
2243 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002244 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002245 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002246 struct work_struct, entry);
2247
Tejun Heo82607adc2015-12-08 11:28:04 -05002248 pool->watchdog_ts = jiffies;
2249
Tejun Heoc8e55f32010-06-29 10:07:12 +02002250 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2251 /* optimization path, not strictly necessary */
2252 process_one_work(worker, work);
2253 if (unlikely(!list_empty(&worker->scheduled)))
2254 process_scheduled_works(worker);
2255 } else {
2256 move_linked_works(work, &worker->scheduled, NULL);
2257 process_scheduled_works(worker);
2258 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002259 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002260
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002261 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002262sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002263 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002264 * pool->lock is held and there's no work to process and no need to
2265 * manage, sleep. Workers are woken up only while holding
2266 * pool->lock or from local cpu, so setting the current state
2267 * before releasing pool->lock is enough to prevent losing any
2268 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002269 */
2270 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002271 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002272 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002273 schedule();
2274 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275}
2276
Tejun Heoe22bee72010-06-29 10:07:14 +02002277/**
2278 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002279 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002280 *
2281 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002282 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002283 *
Tejun Heo706026c2013-01-24 11:01:34 -08002284 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002285 * worker which uses GFP_KERNEL allocation which has slight chance of
2286 * developing into deadlock if some works currently on the same queue
2287 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2288 * the problem rescuer solves.
2289 *
Tejun Heo706026c2013-01-24 11:01:34 -08002290 * When such condition is possible, the pool summons rescuers of all
2291 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002292 * those works so that forward progress can be guaranteed.
2293 *
2294 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002295 *
2296 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002297 */
Tejun Heo111c2252013-01-17 17:16:24 -08002298static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002299{
Tejun Heo111c2252013-01-17 17:16:24 -08002300 struct worker *rescuer = __rescuer;
2301 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002302 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002303 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002304
2305 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002306
2307 /*
2308 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2309 * doesn't participate in concurrency management.
2310 */
2311 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002312repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002313 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002314
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002315 /*
2316 * By the time the rescuer is requested to stop, the workqueue
2317 * shouldn't have any work pending, but @wq->maydays may still have
2318 * pwq(s) queued. This can happen by non-rescuer workers consuming
2319 * all the work items before the rescuer got to them. Go through
2320 * @wq->maydays processing before acting on should_stop so that the
2321 * list is always empty on exit.
2322 */
2323 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002324
Tejun Heo493a1722013-03-12 11:29:59 -07002325 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002326 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002327
2328 while (!list_empty(&wq->maydays)) {
2329 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2330 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002331 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002332 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002333 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002334
2335 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002336 list_del_init(&pwq->mayday_node);
2337
Tejun Heo2e109a22013-03-13 19:47:40 -07002338 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002339
Lai Jiangshan51697d392014-05-20 17:46:36 +08002340 worker_attach_to_pool(rescuer, pool);
2341
2342 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002343 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002344
2345 /*
2346 * Slurp in all works issued via this workqueue and
2347 * process'em.
2348 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002349 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002350 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2351 if (get_work_pwq(work) == pwq) {
2352 if (first)
2353 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002354 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002355 }
2356 first = false;
2357 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002358
NeilBrown008847f2014-12-08 12:39:16 -05002359 if (!list_empty(scheduled)) {
2360 process_scheduled_works(rescuer);
2361
2362 /*
2363 * The above execution of rescued work items could
2364 * have created more to rescue through
2365 * pwq_activate_first_delayed() or chained
2366 * queueing. Let's put @pwq back on mayday list so
2367 * that such back-to-back work items, which may be
2368 * being used to relieve memory pressure, don't
2369 * incur MAYDAY_INTERVAL delay inbetween.
2370 */
2371 if (need_to_create_worker(pool)) {
2372 spin_lock(&wq_mayday_lock);
2373 get_pwq(pwq);
2374 list_move_tail(&pwq->mayday_node, &wq->maydays);
2375 spin_unlock(&wq_mayday_lock);
2376 }
2377 }
Tejun Heo75769582011-02-14 14:04:46 +01002378
2379 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002380 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002381 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002382 */
2383 put_pwq(pwq);
2384
2385 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002386 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002387 * regular worker; otherwise, we end up with 0 concurrency
2388 * and stalling the execution.
2389 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002390 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002391 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002392
Lai Jiangshanb3104102013-02-19 12:17:02 -08002393 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002394 spin_unlock_irq(&pool->lock);
2395
2396 worker_detach_from_pool(rescuer, pool);
2397
2398 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002399 }
2400
Tejun Heo2e109a22013-03-13 19:47:40 -07002401 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002402
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002403 if (should_stop) {
2404 __set_current_state(TASK_RUNNING);
2405 rescuer->task->flags &= ~PF_WQ_WORKER;
2406 return 0;
2407 }
2408
Tejun Heo111c2252013-01-17 17:16:24 -08002409 /* rescuers should never participate in concurrency management */
2410 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002411 schedule();
2412 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413}
2414
Tejun Heofca839c2015-12-07 10:58:57 -05002415/**
2416 * check_flush_dependency - check for flush dependency sanity
2417 * @target_wq: workqueue being flushed
2418 * @target_work: work item being flushed (NULL for workqueue flushes)
2419 *
2420 * %current is trying to flush the whole @target_wq or @target_work on it.
2421 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2422 * reclaiming memory or running on a workqueue which doesn't have
2423 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2424 * a deadlock.
2425 */
2426static void check_flush_dependency(struct workqueue_struct *target_wq,
2427 struct work_struct *target_work)
2428{
2429 work_func_t target_func = target_work ? target_work->func : NULL;
2430 struct worker *worker;
2431
2432 if (target_wq->flags & WQ_MEM_RECLAIM)
2433 return;
2434
2435 worker = current_wq_worker();
2436
2437 WARN_ONCE(current->flags & PF_MEMALLOC,
2438 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2439 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002440 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2441 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002442 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2443 worker->current_pwq->wq->name, worker->current_func,
2444 target_wq->name, target_func);
2445}
2446
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002447struct wq_barrier {
2448 struct work_struct work;
2449 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002450 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002451};
2452
2453static void wq_barrier_func(struct work_struct *work)
2454{
2455 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2456 complete(&barr->done);
2457}
2458
Tejun Heo4690c4a2010-06-29 10:07:10 +02002459/**
2460 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002461 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002462 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002463 * @target: target work to attach @barr to
2464 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002465 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002466 * @barr is linked to @target such that @barr is completed only after
2467 * @target finishes execution. Please note that the ordering
2468 * guarantee is observed only with respect to @target and on the local
2469 * cpu.
2470 *
2471 * Currently, a queued barrier can't be canceled. This is because
2472 * try_to_grab_pending() can't determine whether the work to be
2473 * grabbed is at the head of the queue and thus can't clear LINKED
2474 * flag of the previous work while there must be a valid next work
2475 * after a work with LINKED flag set.
2476 *
2477 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002478 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002479 *
2480 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002481 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002482 */
Tejun Heo112202d2013-02-13 19:29:12 -08002483static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002484 struct wq_barrier *barr,
2485 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002486{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002487 struct list_head *head;
2488 unsigned int linked = 0;
2489
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002490 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002491 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002492 * as we know for sure that this will not trigger any of the
2493 * checks and call back into the fixup functions where we
2494 * might deadlock.
2495 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002496 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002497 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002498
2499 /*
2500 * Explicitly init the crosslock for wq_barrier::done, make its lock
2501 * key a subkey of the corresponding work. As a result we won't
2502 * build a dependency between wq_barrier::done and unrelated work.
2503 */
2504 lockdep_init_map_crosslock((struct lockdep_map *)&barr->done.map,
2505 "(complete)wq_barr::done",
2506 target->lockdep_map.key, 1);
2507 __init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002508 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002509
Tejun Heoaffee4b2010-06-29 10:07:12 +02002510 /*
2511 * If @target is currently being executed, schedule the
2512 * barrier to the worker; otherwise, put it after @target.
2513 */
2514 if (worker)
2515 head = worker->scheduled.next;
2516 else {
2517 unsigned long *bits = work_data_bits(target);
2518
2519 head = target->entry.next;
2520 /* there can already be other linked works, inherit and set */
2521 linked = *bits & WORK_STRUCT_LINKED;
2522 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2523 }
2524
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002525 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002526 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002527 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002528}
2529
Tejun Heo73f53c42010-06-29 10:07:11 +02002530/**
Tejun Heo112202d2013-02-13 19:29:12 -08002531 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002532 * @wq: workqueue being flushed
2533 * @flush_color: new flush color, < 0 for no-op
2534 * @work_color: new work color, < 0 for no-op
2535 *
Tejun Heo112202d2013-02-13 19:29:12 -08002536 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002537 *
Tejun Heo112202d2013-02-13 19:29:12 -08002538 * If @flush_color is non-negative, flush_color on all pwqs should be
2539 * -1. If no pwq has in-flight commands at the specified color, all
2540 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2541 * has in flight commands, its pwq->flush_color is set to
2542 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002543 * wakeup logic is armed and %true is returned.
2544 *
2545 * The caller should have initialized @wq->first_flusher prior to
2546 * calling this function with non-negative @flush_color. If
2547 * @flush_color is negative, no flush color update is done and %false
2548 * is returned.
2549 *
Tejun Heo112202d2013-02-13 19:29:12 -08002550 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002551 * work_color which is previous to @work_color and all will be
2552 * advanced to @work_color.
2553 *
2554 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002555 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002556 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002557 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002558 * %true if @flush_color >= 0 and there's something to flush. %false
2559 * otherwise.
2560 */
Tejun Heo112202d2013-02-13 19:29:12 -08002561static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002562 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563{
Tejun Heo73f53c42010-06-29 10:07:11 +02002564 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002565 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002566
Tejun Heo73f53c42010-06-29 10:07:11 +02002567 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002568 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002569 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002570 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002571
Tejun Heo49e3cf42013-03-12 11:29:58 -07002572 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002573 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002574
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002575 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002576
2577 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002578 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002579
Tejun Heo112202d2013-02-13 19:29:12 -08002580 if (pwq->nr_in_flight[flush_color]) {
2581 pwq->flush_color = flush_color;
2582 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 wait = true;
2584 }
2585 }
2586
2587 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002588 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002589 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002590 }
2591
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002592 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002593 }
2594
Tejun Heo112202d2013-02-13 19:29:12 -08002595 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002596 complete(&wq->first_flusher->done);
2597
2598 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599}
2600
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002601/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002603 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002605 * This function sleeps until all work items which were queued on entry
2606 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002608void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609{
Tejun Heo73f53c42010-06-29 10:07:11 +02002610 struct wq_flusher this_flusher = {
2611 .list = LIST_HEAD_INIT(this_flusher.list),
2612 .flush_color = -1,
2613 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2614 };
2615 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002616
Tejun Heo3347fa02016-09-16 15:49:32 -04002617 if (WARN_ON(!wq_online))
2618 return;
2619
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002620 lock_map_acquire(&wq->lockdep_map);
2621 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002622
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002623 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002624
2625 /*
2626 * Start-to-wait phase
2627 */
2628 next_color = work_next_color(wq->work_color);
2629
2630 if (next_color != wq->flush_color) {
2631 /*
2632 * Color space is not full. The current work_color
2633 * becomes our flush_color and work_color is advanced
2634 * by one.
2635 */
Tejun Heo6183c002013-03-12 11:29:57 -07002636 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002637 this_flusher.flush_color = wq->work_color;
2638 wq->work_color = next_color;
2639
2640 if (!wq->first_flusher) {
2641 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002642 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002643
2644 wq->first_flusher = &this_flusher;
2645
Tejun Heo112202d2013-02-13 19:29:12 -08002646 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002647 wq->work_color)) {
2648 /* nothing to flush, done */
2649 wq->flush_color = next_color;
2650 wq->first_flusher = NULL;
2651 goto out_unlock;
2652 }
2653 } else {
2654 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002655 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002656 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002657 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002658 }
2659 } else {
2660 /*
2661 * Oops, color space is full, wait on overflow queue.
2662 * The next flush completion will assign us
2663 * flush_color and transfer to flusher_queue.
2664 */
2665 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2666 }
2667
Tejun Heofca839c2015-12-07 10:58:57 -05002668 check_flush_dependency(wq, NULL);
2669
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002670 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002671
2672 wait_for_completion(&this_flusher.done);
2673
2674 /*
2675 * Wake-up-and-cascade phase
2676 *
2677 * First flushers are responsible for cascading flushes and
2678 * handling overflow. Non-first flushers can simply return.
2679 */
2680 if (wq->first_flusher != &this_flusher)
2681 return;
2682
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002683 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002684
Tejun Heo4ce48b32010-07-02 10:03:51 +02002685 /* we might have raced, check again with mutex held */
2686 if (wq->first_flusher != &this_flusher)
2687 goto out_unlock;
2688
Tejun Heo73f53c42010-06-29 10:07:11 +02002689 wq->first_flusher = NULL;
2690
Tejun Heo6183c002013-03-12 11:29:57 -07002691 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2692 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002693
2694 while (true) {
2695 struct wq_flusher *next, *tmp;
2696
2697 /* complete all the flushers sharing the current flush color */
2698 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2699 if (next->flush_color != wq->flush_color)
2700 break;
2701 list_del_init(&next->list);
2702 complete(&next->done);
2703 }
2704
Tejun Heo6183c002013-03-12 11:29:57 -07002705 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2706 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002707
2708 /* this flush_color is finished, advance by one */
2709 wq->flush_color = work_next_color(wq->flush_color);
2710
2711 /* one color has been freed, handle overflow queue */
2712 if (!list_empty(&wq->flusher_overflow)) {
2713 /*
2714 * Assign the same color to all overflowed
2715 * flushers, advance work_color and append to
2716 * flusher_queue. This is the start-to-wait
2717 * phase for these overflowed flushers.
2718 */
2719 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2720 tmp->flush_color = wq->work_color;
2721
2722 wq->work_color = work_next_color(wq->work_color);
2723
2724 list_splice_tail_init(&wq->flusher_overflow,
2725 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002726 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002727 }
2728
2729 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002730 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002731 break;
2732 }
2733
2734 /*
2735 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002736 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002737 */
Tejun Heo6183c002013-03-12 11:29:57 -07002738 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2739 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002740
2741 list_del_init(&next->list);
2742 wq->first_flusher = next;
2743
Tejun Heo112202d2013-02-13 19:29:12 -08002744 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002745 break;
2746
2747 /*
2748 * Meh... this color is already done, clear first
2749 * flusher and repeat cascading.
2750 */
2751 wq->first_flusher = NULL;
2752 }
2753
2754out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002755 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002757EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002759/**
2760 * drain_workqueue - drain a workqueue
2761 * @wq: workqueue to drain
2762 *
2763 * Wait until the workqueue becomes empty. While draining is in progress,
2764 * only chain queueing is allowed. IOW, only currently pending or running
2765 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002766 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767 * by the depth of chaining and should be relatively short. Whine if it
2768 * takes too long.
2769 */
2770void drain_workqueue(struct workqueue_struct *wq)
2771{
2772 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002773 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002774
2775 /*
2776 * __queue_work() needs to test whether there are drainers, is much
2777 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002778 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002779 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002780 mutex_lock(&wq->mutex);
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 +02002784reflush:
2785 flush_workqueue(wq);
2786
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002787 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002788
Tejun Heo49e3cf42013-03-12 11:29:58 -07002789 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002790 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002791
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002792 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002793 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002794 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002795
2796 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002797 continue;
2798
2799 if (++flush_cnt == 10 ||
2800 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002801 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002802 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002803
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002804 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002805 goto reflush;
2806 }
2807
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002808 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002809 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002810 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002811}
2812EXPORT_SYMBOL_GPL(drain_workqueue);
2813
Tejun Heo606a5022012-08-20 14:51:23 -07002814static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002815{
2816 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002817 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002818 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002819
2820 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002821
Tejun Heofa1b54e2013-03-12 11:30:00 -07002822 local_irq_disable();
2823 pool = get_work_pool(work);
2824 if (!pool) {
2825 local_irq_enable();
2826 return false;
2827 }
2828
2829 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002830 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002831 pwq = get_work_pwq(work);
2832 if (pwq) {
2833 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002834 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002835 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002836 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002837 if (!worker)
2838 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002839 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002840 }
Tejun Heobaf59022010-09-16 10:42:16 +02002841
Tejun Heofca839c2015-12-07 10:58:57 -05002842 check_flush_dependency(pwq->wq, work);
2843
Tejun Heo112202d2013-02-13 19:29:12 -08002844 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002845 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002846
Tejun Heoe159489b2011-01-09 23:32:15 +01002847 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002848 * Force a lock recursion deadlock when using flush_work() inside a
2849 * single-threaded or rescuer equipped workqueue.
2850 *
2851 * For single threaded workqueues the deadlock happens when the work
2852 * is after the work issuing the flush_work(). For rescuer equipped
2853 * workqueues the deadlock happens when the rescuer stalls, blocking
2854 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002855 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002856 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002857 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002858 lock_map_release(&pwq->wq->lockdep_map);
2859 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002860
Tejun Heobaf59022010-09-16 10:42:16 +02002861 return true;
2862already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002863 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002864 return false;
2865}
2866
Oleg Nesterovdb700892008-07-25 01:47:49 -07002867/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002868 * flush_work - wait for a work to finish executing the last queueing instance
2869 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002870 *
Tejun Heo606a5022012-08-20 14:51:23 -07002871 * Wait until @work has finished execution. @work is guaranteed to be idle
2872 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002873 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002874 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002875 * %true if flush_work() waited for the work to finish execution,
2876 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002877 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002878bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002879{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002880 struct wq_barrier barr;
2881
Tejun Heo3347fa02016-09-16 15:49:32 -04002882 if (WARN_ON(!wq_online))
2883 return false;
2884
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002885 lock_map_acquire(&work->lockdep_map);
2886 lock_map_release(&work->lockdep_map);
2887
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002888 if (start_flush_work(work, &barr)) {
2889 wait_for_completion(&barr.done);
2890 destroy_work_on_stack(&barr.work);
2891 return true;
2892 } else {
2893 return false;
2894 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002895}
2896EXPORT_SYMBOL_GPL(flush_work);
2897
Tejun Heo8603e1b32015-03-05 08:04:13 -05002898struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002899 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002900 struct work_struct *work;
2901};
2902
Ingo Molnarac6424b2017-06-20 12:06:13 +02002903static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002904{
2905 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2906
2907 if (cwait->work != key)
2908 return 0;
2909 return autoremove_wake_function(wait, mode, sync, key);
2910}
2911
Tejun Heo36e227d2012-08-03 10:30:46 -07002912static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002913{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002914 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002915 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002916 int ret;
2917
2918 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002919 ret = try_to_grab_pending(work, is_dwork, &flags);
2920 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002921 * If someone else is already canceling, wait for it to
2922 * finish. flush_work() doesn't work for PREEMPT_NONE
2923 * because we may get scheduled between @work's completion
2924 * and the other canceling task resuming and clearing
2925 * CANCELING - flush_work() will return false immediately
2926 * as @work is no longer busy, try_to_grab_pending() will
2927 * return -ENOENT as @work is still being canceled and the
2928 * other canceling task won't be able to clear CANCELING as
2929 * we're hogging the CPU.
2930 *
2931 * Let's wait for completion using a waitqueue. As this
2932 * may lead to the thundering herd problem, use a custom
2933 * wake function which matches @work along with exclusive
2934 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002935 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002936 if (unlikely(ret == -ENOENT)) {
2937 struct cwt_wait cwait;
2938
2939 init_wait(&cwait.wait);
2940 cwait.wait.func = cwt_wakefn;
2941 cwait.work = work;
2942
2943 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2944 TASK_UNINTERRUPTIBLE);
2945 if (work_is_canceling(work))
2946 schedule();
2947 finish_wait(&cancel_waitq, &cwait.wait);
2948 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002949 } while (unlikely(ret < 0));
2950
Tejun Heobbb68df2012-08-03 10:30:46 -07002951 /* tell other tasks trying to grab @work to back off */
2952 mark_work_canceling(work);
2953 local_irq_restore(flags);
2954
Tejun Heo3347fa02016-09-16 15:49:32 -04002955 /*
2956 * This allows canceling during early boot. We know that @work
2957 * isn't executing.
2958 */
2959 if (wq_online)
2960 flush_work(work);
2961
Tejun Heo7a22ad72010-06-29 10:07:13 +02002962 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002963
2964 /*
2965 * Paired with prepare_to_wait() above so that either
2966 * waitqueue_active() is visible here or !work_is_canceling() is
2967 * visible there.
2968 */
2969 smp_mb();
2970 if (waitqueue_active(&cancel_waitq))
2971 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2972
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002973 return ret;
2974}
2975
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002976/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002977 * cancel_work_sync - cancel a work and wait for it to finish
2978 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002979 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002980 * Cancel @work and wait for its execution to finish. This function
2981 * can be used even if the work re-queues itself or migrates to
2982 * another workqueue. On return from this function, @work is
2983 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002984 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002985 * cancel_work_sync(&delayed_work->work) must not be used for
2986 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002987 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002988 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002989 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002990 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002991 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002993 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002994bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002995{
Tejun Heo36e227d2012-08-03 10:30:46 -07002996 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002997}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002998EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002999
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003000/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003001 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3002 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003003 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003004 * Delayed timer is cancelled and the pending work is queued for
3005 * immediate execution. Like flush_work(), this function only
3006 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003007 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003008 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003009 * %true if flush_work() waited for the work to finish execution,
3010 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003011 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003012bool flush_delayed_work(struct delayed_work *dwork)
3013{
Tejun Heo8930cab2012-08-03 10:30:45 -07003014 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003015 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003016 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003017 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003018 return flush_work(&dwork->work);
3019}
3020EXPORT_SYMBOL(flush_delayed_work);
3021
Jens Axboef72b8792016-08-24 15:51:50 -06003022static bool __cancel_work(struct work_struct *work, bool is_dwork)
3023{
3024 unsigned long flags;
3025 int ret;
3026
3027 do {
3028 ret = try_to_grab_pending(work, is_dwork, &flags);
3029 } while (unlikely(ret == -EAGAIN));
3030
3031 if (unlikely(ret < 0))
3032 return false;
3033
3034 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3035 local_irq_restore(flags);
3036 return ret;
3037}
3038
3039/*
3040 * See cancel_delayed_work()
3041 */
3042bool cancel_work(struct work_struct *work)
3043{
3044 return __cancel_work(work, false);
3045}
3046
Tejun Heo401a8d02010-09-16 10:36:00 +02003047/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003048 * cancel_delayed_work - cancel a delayed work
3049 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003050 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003051 * Kill off a pending delayed_work.
3052 *
3053 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3054 * pending.
3055 *
3056 * Note:
3057 * The work callback function may still be running on return, unless
3058 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3059 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003060 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003061 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003062 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003063bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003064{
Jens Axboef72b8792016-08-24 15:51:50 -06003065 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003066}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003067EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003068
3069/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003070 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3071 * @dwork: the delayed work cancel
3072 *
3073 * This is cancel_work_sync() for delayed works.
3074 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003075 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003076 * %true if @dwork was pending, %false otherwise.
3077 */
3078bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003079{
Tejun Heo36e227d2012-08-03 10:30:46 -07003080 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003081}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003082EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003083
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003084/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003085 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003086 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003087 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003088 * schedule_on_each_cpu() executes @func on each online CPU using the
3089 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003090 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003091 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003092 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003093 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003094 */
David Howells65f27f32006-11-22 14:55:48 +00003095int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003096{
3097 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003098 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003099
Andrew Mortonb6136772006-06-25 05:47:49 -07003100 works = alloc_percpu(struct work_struct);
3101 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003102 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003103
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003104 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003105
Christoph Lameter15316ba82006-01-08 01:00:43 -08003106 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003107 struct work_struct *work = per_cpu_ptr(works, cpu);
3108
3109 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003110 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003111 }
Tejun Heo93981802009-11-17 14:06:20 -08003112
3113 for_each_online_cpu(cpu)
3114 flush_work(per_cpu_ptr(works, cpu));
3115
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003116 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003117 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003118 return 0;
3119}
3120
Alan Sterneef6a7d2010-02-12 17:39:21 +09003121/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003122 * execute_in_process_context - reliably execute the routine with user context
3123 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003124 * @ew: guaranteed storage for the execute work structure (must
3125 * be available when the work executes)
3126 *
3127 * Executes the function immediately if process context is available,
3128 * otherwise schedules the function for delayed execution.
3129 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003130 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003131 * 1 - function was scheduled for execution
3132 */
David Howells65f27f32006-11-22 14:55:48 +00003133int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003134{
3135 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003136 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003137 return 0;
3138 }
3139
David Howells65f27f32006-11-22 14:55:48 +00003140 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003141 schedule_work(&ew->work);
3142
3143 return 1;
3144}
3145EXPORT_SYMBOL_GPL(execute_in_process_context);
3146
Tejun Heo7a4e3442013-03-12 11:30:00 -07003147/**
3148 * free_workqueue_attrs - free a workqueue_attrs
3149 * @attrs: workqueue_attrs to free
3150 *
3151 * Undo alloc_workqueue_attrs().
3152 */
3153void free_workqueue_attrs(struct workqueue_attrs *attrs)
3154{
3155 if (attrs) {
3156 free_cpumask_var(attrs->cpumask);
3157 kfree(attrs);
3158 }
3159}
3160
3161/**
3162 * alloc_workqueue_attrs - allocate a workqueue_attrs
3163 * @gfp_mask: allocation mask to use
3164 *
3165 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003166 * return it.
3167 *
3168 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003169 */
3170struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3171{
3172 struct workqueue_attrs *attrs;
3173
3174 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3175 if (!attrs)
3176 goto fail;
3177 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3178 goto fail;
3179
Tejun Heo13e2e552013-04-01 11:23:31 -07003180 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003181 return attrs;
3182fail:
3183 free_workqueue_attrs(attrs);
3184 return NULL;
3185}
3186
Tejun Heo29c91e92013-03-12 11:30:03 -07003187static void copy_workqueue_attrs(struct workqueue_attrs *to,
3188 const struct workqueue_attrs *from)
3189{
3190 to->nice = from->nice;
3191 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003192 /*
3193 * Unlike hash and equality test, this function doesn't ignore
3194 * ->no_numa as it is used for both pool and wq attrs. Instead,
3195 * get_unbound_pool() explicitly clears ->no_numa after copying.
3196 */
3197 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003198}
3199
Tejun Heo29c91e92013-03-12 11:30:03 -07003200/* hash value of the content of @attr */
3201static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3202{
3203 u32 hash = 0;
3204
3205 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003206 hash = jhash(cpumask_bits(attrs->cpumask),
3207 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003208 return hash;
3209}
3210
3211/* content equality test */
3212static bool wqattrs_equal(const struct workqueue_attrs *a,
3213 const struct workqueue_attrs *b)
3214{
3215 if (a->nice != b->nice)
3216 return false;
3217 if (!cpumask_equal(a->cpumask, b->cpumask))
3218 return false;
3219 return true;
3220}
3221
Tejun Heo7a4e3442013-03-12 11:30:00 -07003222/**
3223 * init_worker_pool - initialize a newly zalloc'd worker_pool
3224 * @pool: worker_pool to initialize
3225 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303226 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003227 *
3228 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003229 * inside @pool proper are initialized and put_unbound_pool() can be called
3230 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003231 */
3232static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003233{
3234 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003235 pool->id = -1;
3236 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003237 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003238 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003239 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003240 INIT_LIST_HEAD(&pool->worklist);
3241 INIT_LIST_HEAD(&pool->idle_list);
3242 hash_init(pool->busy_hash);
3243
Geliang Tangc30fb262017-02-26 08:58:21 +08003244 setup_deferrable_timer(&pool->idle_timer, idle_worker_timeout,
3245 (unsigned long)pool);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003246
3247 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3248 (unsigned long)pool);
3249
3250 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003251 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003252 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003253
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003254 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003255 INIT_HLIST_NODE(&pool->hash_node);
3256 pool->refcnt = 1;
3257
3258 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003259 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3260 if (!pool->attrs)
3261 return -ENOMEM;
3262 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003263}
3264
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003265static void rcu_free_wq(struct rcu_head *rcu)
3266{
3267 struct workqueue_struct *wq =
3268 container_of(rcu, struct workqueue_struct, rcu);
3269
3270 if (!(wq->flags & WQ_UNBOUND))
3271 free_percpu(wq->cpu_pwqs);
3272 else
3273 free_workqueue_attrs(wq->unbound_attrs);
3274
3275 kfree(wq->rescuer);
3276 kfree(wq);
3277}
3278
Tejun Heo29c91e92013-03-12 11:30:03 -07003279static void rcu_free_pool(struct rcu_head *rcu)
3280{
3281 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3282
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003283 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003284 free_workqueue_attrs(pool->attrs);
3285 kfree(pool);
3286}
3287
3288/**
3289 * put_unbound_pool - put a worker_pool
3290 * @pool: worker_pool to put
3291 *
3292 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003293 * safe manner. get_unbound_pool() calls this function on its failure path
3294 * and this function should be able to release pools which went through,
3295 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003296 *
3297 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003298 */
3299static void put_unbound_pool(struct worker_pool *pool)
3300{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003301 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003302 struct worker *worker;
3303
Tejun Heoa892cac2013-04-01 11:23:32 -07003304 lockdep_assert_held(&wq_pool_mutex);
3305
3306 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003307 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003308
3309 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003310 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003311 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003312 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003313
3314 /* release id and unhash */
3315 if (pool->id >= 0)
3316 idr_remove(&worker_pool_idr, pool->id);
3317 hash_del(&pool->hash_node);
3318
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003319 /*
3320 * Become the manager and destroy all workers. Grabbing
3321 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003322 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003323 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003324 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003325
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003326 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003327 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003328 destroy_worker(worker);
3329 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003330 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003331
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003332 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003333 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003334 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003335 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003336
3337 if (pool->detach_completion)
3338 wait_for_completion(pool->detach_completion);
3339
Tejun Heo29c91e92013-03-12 11:30:03 -07003340 mutex_unlock(&pool->manager_arb);
3341
3342 /* shut down the timers */
3343 del_timer_sync(&pool->idle_timer);
3344 del_timer_sync(&pool->mayday_timer);
3345
3346 /* sched-RCU protected to allow dereferences from get_work_pool() */
3347 call_rcu_sched(&pool->rcu, rcu_free_pool);
3348}
3349
3350/**
3351 * get_unbound_pool - get a worker_pool with the specified attributes
3352 * @attrs: the attributes of the worker_pool to get
3353 *
3354 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3355 * reference count and return it. If there already is a matching
3356 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003357 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003358 *
3359 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003360 *
3361 * Return: On success, a worker_pool with the same attributes as @attrs.
3362 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003363 */
3364static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3365{
Tejun Heo29c91e92013-03-12 11:30:03 -07003366 u32 hash = wqattrs_hash(attrs);
3367 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003368 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003369 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003370
Tejun Heoa892cac2013-04-01 11:23:32 -07003371 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003372
3373 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003374 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3375 if (wqattrs_equal(pool->attrs, attrs)) {
3376 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003377 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003378 }
3379 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003380
Xunlei Pange22735842015-10-09 11:53:12 +08003381 /* if cpumask is contained inside a NUMA node, we belong to that node */
3382 if (wq_numa_enabled) {
3383 for_each_node(node) {
3384 if (cpumask_subset(attrs->cpumask,
3385 wq_numa_possible_cpumask[node])) {
3386 target_node = node;
3387 break;
3388 }
3389 }
3390 }
3391
Tejun Heo29c91e92013-03-12 11:30:03 -07003392 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003393 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003394 if (!pool || init_worker_pool(pool) < 0)
3395 goto fail;
3396
Tejun Heo8864b4e2013-03-12 11:30:04 -07003397 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003398 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003399 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003400
Shaohua Li2865a8f2013-08-01 09:56:36 +08003401 /*
3402 * no_numa isn't a worker_pool attribute, always clear it. See
3403 * 'struct workqueue_attrs' comments for detail.
3404 */
3405 pool->attrs->no_numa = false;
3406
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 if (worker_pool_assign_id(pool) < 0)
3408 goto fail;
3409
3410 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003411 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003412 goto fail;
3413
Tejun Heo29c91e92013-03-12 11:30:03 -07003414 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003415 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003416
Tejun Heo29c91e92013-03-12 11:30:03 -07003417 return pool;
3418fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003419 if (pool)
3420 put_unbound_pool(pool);
3421 return NULL;
3422}
3423
Tejun Heo8864b4e2013-03-12 11:30:04 -07003424static void rcu_free_pwq(struct rcu_head *rcu)
3425{
3426 kmem_cache_free(pwq_cache,
3427 container_of(rcu, struct pool_workqueue, rcu));
3428}
3429
3430/*
3431 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3432 * and needs to be destroyed.
3433 */
3434static void pwq_unbound_release_workfn(struct work_struct *work)
3435{
3436 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3437 unbound_release_work);
3438 struct workqueue_struct *wq = pwq->wq;
3439 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003440 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003441
3442 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3443 return;
3444
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003445 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003446 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003447 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003448 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003449
Tejun Heoa892cac2013-04-01 11:23:32 -07003450 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003451 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003452 mutex_unlock(&wq_pool_mutex);
3453
Tejun Heo8864b4e2013-03-12 11:30:04 -07003454 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3455
3456 /*
3457 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003458 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003459 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003460 if (is_last)
3461 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003462}
3463
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003464/**
Tejun Heo699ce092013-03-13 16:51:35 -07003465 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003466 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003467 *
Tejun Heo699ce092013-03-13 16:51:35 -07003468 * If @pwq isn't freezing, set @pwq->max_active to the associated
3469 * workqueue's saved_max_active and activate delayed work items
3470 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003471 */
Tejun Heo699ce092013-03-13 16:51:35 -07003472static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003473{
Tejun Heo699ce092013-03-13 16:51:35 -07003474 struct workqueue_struct *wq = pwq->wq;
3475 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003476 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003477
Tejun Heo699ce092013-03-13 16:51:35 -07003478 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003479 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003480
3481 /* fast exit for non-freezable wqs */
3482 if (!freezable && pwq->max_active == wq->saved_max_active)
3483 return;
3484
Tejun Heo3347fa02016-09-16 15:49:32 -04003485 /* this function can be called during early boot w/ irq disabled */
3486 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003487
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003488 /*
3489 * During [un]freezing, the caller is responsible for ensuring that
3490 * this function is called at least once after @workqueue_freezing
3491 * is updated and visible.
3492 */
3493 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003494 pwq->max_active = wq->saved_max_active;
3495
3496 while (!list_empty(&pwq->delayed_works) &&
3497 pwq->nr_active < pwq->max_active)
3498 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003499
3500 /*
3501 * Need to kick a worker after thawed or an unbound wq's
3502 * max_active is bumped. It's a slow path. Do it always.
3503 */
3504 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003505 } else {
3506 pwq->max_active = 0;
3507 }
3508
Tejun Heo3347fa02016-09-16 15:49:32 -04003509 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003510}
3511
Tejun Heoe50aba92013-04-01 11:23:35 -07003512/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003513static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3514 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003515{
3516 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3517
Tejun Heoe50aba92013-04-01 11:23:35 -07003518 memset(pwq, 0, sizeof(*pwq));
3519
Tejun Heod2c1d402013-03-12 11:30:04 -07003520 pwq->pool = pool;
3521 pwq->wq = wq;
3522 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003523 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003524 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003525 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003526 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003527 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003528}
Tejun Heod2c1d402013-03-12 11:30:04 -07003529
Tejun Heof147f292013-04-01 11:23:35 -07003530/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003531static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003532{
3533 struct workqueue_struct *wq = pwq->wq;
3534
3535 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003536
Tejun Heo1befcf32013-04-01 11:23:35 -07003537 /* may be called multiple times, ignore if already linked */
3538 if (!list_empty(&pwq->pwqs_node))
3539 return;
3540
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003541 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003542 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003543
3544 /* sync max_active to the current setting */
3545 pwq_adjust_max_active(pwq);
3546
3547 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003548 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003549}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003550
Tejun Heof147f292013-04-01 11:23:35 -07003551/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3552static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3553 const struct workqueue_attrs *attrs)
3554{
3555 struct worker_pool *pool;
3556 struct pool_workqueue *pwq;
3557
3558 lockdep_assert_held(&wq_pool_mutex);
3559
3560 pool = get_unbound_pool(attrs);
3561 if (!pool)
3562 return NULL;
3563
Tejun Heoe50aba92013-04-01 11:23:35 -07003564 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003565 if (!pwq) {
3566 put_unbound_pool(pool);
3567 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003568 }
Tejun Heo6029a912013-04-01 11:23:34 -07003569
Tejun Heof147f292013-04-01 11:23:35 -07003570 init_pwq(pwq, wq, pool);
3571 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003572}
3573
Tejun Heo4c16bd32013-04-01 11:23:36 -07003574/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003575 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003576 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003577 * @node: the target NUMA node
3578 * @cpu_going_down: if >= 0, the CPU to consider as offline
3579 * @cpumask: outarg, the resulting cpumask
3580 *
3581 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3582 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003583 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003584 *
3585 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3586 * enabled and @node has online CPUs requested by @attrs, the returned
3587 * cpumask is the intersection of the possible CPUs of @node and
3588 * @attrs->cpumask.
3589 *
3590 * The caller is responsible for ensuring that the cpumask of @node stays
3591 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003592 *
3593 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3594 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003595 */
3596static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3597 int cpu_going_down, cpumask_t *cpumask)
3598{
Tejun Heod55262c2013-04-01 11:23:38 -07003599 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003600 goto use_dfl;
3601
3602 /* does @node have any online CPUs @attrs wants? */
3603 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3604 if (cpu_going_down >= 0)
3605 cpumask_clear_cpu(cpu_going_down, cpumask);
3606
3607 if (cpumask_empty(cpumask))
3608 goto use_dfl;
3609
3610 /* yeap, return possible CPUs in @node that @attrs wants */
3611 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003612
3613 if (cpumask_empty(cpumask)) {
3614 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3615 "possible intersect\n");
3616 return false;
3617 }
3618
Tejun Heo4c16bd32013-04-01 11:23:36 -07003619 return !cpumask_equal(cpumask, attrs->cpumask);
3620
3621use_dfl:
3622 cpumask_copy(cpumask, attrs->cpumask);
3623 return false;
3624}
3625
Tejun Heo1befcf32013-04-01 11:23:35 -07003626/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3627static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3628 int node,
3629 struct pool_workqueue *pwq)
3630{
3631 struct pool_workqueue *old_pwq;
3632
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003633 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003634 lockdep_assert_held(&wq->mutex);
3635
3636 /* link_pwq() can handle duplicate calls */
3637 link_pwq(pwq);
3638
3639 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3640 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3641 return old_pwq;
3642}
3643
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003644/* context to store the prepared attrs & pwqs before applying */
3645struct apply_wqattrs_ctx {
3646 struct workqueue_struct *wq; /* target workqueue */
3647 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003648 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003649 struct pool_workqueue *dfl_pwq;
3650 struct pool_workqueue *pwq_tbl[];
3651};
3652
3653/* free the resources after success or abort */
3654static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3655{
3656 if (ctx) {
3657 int node;
3658
3659 for_each_node(node)
3660 put_pwq_unlocked(ctx->pwq_tbl[node]);
3661 put_pwq_unlocked(ctx->dfl_pwq);
3662
3663 free_workqueue_attrs(ctx->attrs);
3664
3665 kfree(ctx);
3666 }
3667}
3668
3669/* allocate the attrs and pwqs for later installation */
3670static struct apply_wqattrs_ctx *
3671apply_wqattrs_prepare(struct workqueue_struct *wq,
3672 const struct workqueue_attrs *attrs)
3673{
3674 struct apply_wqattrs_ctx *ctx;
3675 struct workqueue_attrs *new_attrs, *tmp_attrs;
3676 int node;
3677
3678 lockdep_assert_held(&wq_pool_mutex);
3679
3680 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3681 GFP_KERNEL);
3682
3683 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3684 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3685 if (!ctx || !new_attrs || !tmp_attrs)
3686 goto out_free;
3687
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003688 /*
3689 * Calculate the attrs of the default pwq.
3690 * If the user configured cpumask doesn't overlap with the
3691 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3692 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003693 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003694 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003695 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3696 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003697
3698 /*
3699 * We may create multiple pwqs with differing cpumasks. Make a
3700 * copy of @new_attrs which will be modified and used to obtain
3701 * pools.
3702 */
3703 copy_workqueue_attrs(tmp_attrs, new_attrs);
3704
3705 /*
3706 * If something goes wrong during CPU up/down, we'll fall back to
3707 * the default pwq covering whole @attrs->cpumask. Always create
3708 * it even if we don't use it immediately.
3709 */
3710 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3711 if (!ctx->dfl_pwq)
3712 goto out_free;
3713
3714 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003715 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003716 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3717 if (!ctx->pwq_tbl[node])
3718 goto out_free;
3719 } else {
3720 ctx->dfl_pwq->refcnt++;
3721 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3722 }
3723 }
3724
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003725 /* save the user configured attrs and sanitize it. */
3726 copy_workqueue_attrs(new_attrs, attrs);
3727 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003728 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003729
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003730 ctx->wq = wq;
3731 free_workqueue_attrs(tmp_attrs);
3732 return ctx;
3733
3734out_free:
3735 free_workqueue_attrs(tmp_attrs);
3736 free_workqueue_attrs(new_attrs);
3737 apply_wqattrs_cleanup(ctx);
3738 return NULL;
3739}
3740
3741/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3742static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3743{
3744 int node;
3745
3746 /* all pwqs have been created successfully, let's install'em */
3747 mutex_lock(&ctx->wq->mutex);
3748
3749 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3750
3751 /* save the previous pwq and install the new one */
3752 for_each_node(node)
3753 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3754 ctx->pwq_tbl[node]);
3755
3756 /* @dfl_pwq might not have been used, ensure it's linked */
3757 link_pwq(ctx->dfl_pwq);
3758 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3759
3760 mutex_unlock(&ctx->wq->mutex);
3761}
3762
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003763static void apply_wqattrs_lock(void)
3764{
3765 /* CPUs should stay stable across pwq creations and installations */
3766 get_online_cpus();
3767 mutex_lock(&wq_pool_mutex);
3768}
3769
3770static void apply_wqattrs_unlock(void)
3771{
3772 mutex_unlock(&wq_pool_mutex);
3773 put_online_cpus();
3774}
3775
3776static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3777 const struct workqueue_attrs *attrs)
3778{
3779 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003780
3781 /* only unbound workqueues can change attributes */
3782 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3783 return -EINVAL;
3784
3785 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003786 if (!list_empty(&wq->pwqs)) {
3787 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3788 return -EINVAL;
3789
3790 wq->flags &= ~__WQ_ORDERED;
3791 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003792
3793 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003794 if (!ctx)
3795 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003796
3797 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003798 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003799 apply_wqattrs_cleanup(ctx);
3800
wanghaibin62011712016-01-07 20:38:59 +08003801 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003802}
3803
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003804/**
3805 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3806 * @wq: the target workqueue
3807 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3808 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003809 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3810 * machines, this function maps a separate pwq to each NUMA node with
3811 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3812 * NUMA node it was issued on. Older pwqs are released as in-flight work
3813 * items finish. Note that a work item which repeatedly requeues itself
3814 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003815 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003816 * Performs GFP_KERNEL allocations.
3817 *
3818 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003819 */
3820int apply_workqueue_attrs(struct workqueue_struct *wq,
3821 const struct workqueue_attrs *attrs)
3822{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003823 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003824
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003825 apply_wqattrs_lock();
3826 ret = apply_workqueue_attrs_locked(wq, attrs);
3827 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003828
Tejun Heo48621252013-04-01 11:23:31 -07003829 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003830}
3831
Tejun Heo4c16bd32013-04-01 11:23:36 -07003832/**
3833 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3834 * @wq: the target workqueue
3835 * @cpu: the CPU coming up or going down
3836 * @online: whether @cpu is coming up or going down
3837 *
3838 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3839 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3840 * @wq accordingly.
3841 *
3842 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3843 * falls back to @wq->dfl_pwq which may not be optimal but is always
3844 * correct.
3845 *
3846 * Note that when the last allowed CPU of a NUMA node goes offline for a
3847 * workqueue with a cpumask spanning multiple nodes, the workers which were
3848 * already executing the work items for the workqueue will lose their CPU
3849 * affinity and may execute on any CPU. This is similar to how per-cpu
3850 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3851 * affinity, it's the user's responsibility to flush the work item from
3852 * CPU_DOWN_PREPARE.
3853 */
3854static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3855 bool online)
3856{
3857 int node = cpu_to_node(cpu);
3858 int cpu_off = online ? -1 : cpu;
3859 struct pool_workqueue *old_pwq = NULL, *pwq;
3860 struct workqueue_attrs *target_attrs;
3861 cpumask_t *cpumask;
3862
3863 lockdep_assert_held(&wq_pool_mutex);
3864
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003865 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3866 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003867 return;
3868
3869 /*
3870 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3871 * Let's use a preallocated one. The following buf is protected by
3872 * CPU hotplug exclusion.
3873 */
3874 target_attrs = wq_update_unbound_numa_attrs_buf;
3875 cpumask = target_attrs->cpumask;
3876
Tejun Heo4c16bd32013-04-01 11:23:36 -07003877 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3878 pwq = unbound_pwq_by_node(wq, node);
3879
3880 /*
3881 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003882 * different from the default pwq's, we need to compare it to @pwq's
3883 * and create a new one if they don't match. If the target cpumask
3884 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003885 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003886 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003887 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003888 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003889 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003890 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003891 }
3892
Tejun Heo4c16bd32013-04-01 11:23:36 -07003893 /* create a new pwq */
3894 pwq = alloc_unbound_pwq(wq, target_attrs);
3895 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003896 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3897 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003898 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003899 }
3900
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003901 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003902 mutex_lock(&wq->mutex);
3903 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3904 goto out_unlock;
3905
3906use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003907 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003908 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3909 get_pwq(wq->dfl_pwq);
3910 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3911 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3912out_unlock:
3913 mutex_unlock(&wq->mutex);
3914 put_pwq_unlocked(old_pwq);
3915}
3916
Tejun Heo30cdf2492013-03-12 11:29:57 -07003917static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003918{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003919 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003920 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003921
Tejun Heo30cdf2492013-03-12 11:29:57 -07003922 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003923 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3924 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003925 return -ENOMEM;
3926
3927 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003928 struct pool_workqueue *pwq =
3929 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003930 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003931 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003932
Tejun Heof147f292013-04-01 11:23:35 -07003933 init_pwq(pwq, wq, &cpu_pools[highpri]);
3934
3935 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003936 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003937 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003938 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003939 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003940 } else if (wq->flags & __WQ_ORDERED) {
3941 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3942 /* there should only be single pwq for ordering guarantee */
3943 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3944 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3945 "ordering guarantee broken for workqueue %s\n", wq->name);
3946 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003947 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003948 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003949 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003950}
3951
Tejun Heof3421792010-07-02 10:03:51 +02003952static int wq_clamp_max_active(int max_active, unsigned int flags,
3953 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003954{
Tejun Heof3421792010-07-02 10:03:51 +02003955 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3956
3957 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003958 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3959 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003960
Tejun Heof3421792010-07-02 10:03:51 +02003961 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003962}
3963
Tejun Heob196be82012-01-10 15:11:35 -08003964struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003965 unsigned int flags,
3966 int max_active,
3967 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003968 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003969{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003970 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003971 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003972 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003973 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003974
Tejun Heo5c0338c2017-07-18 18:41:52 -04003975 /*
3976 * Unbound && max_active == 1 used to imply ordered, which is no
3977 * longer the case on NUMA machines due to per-node pools. While
3978 * alloc_ordered_workqueue() is the right way to create an ordered
3979 * workqueue, keep the previous behavior to avoid subtle breakages
3980 * on NUMA.
3981 */
3982 if ((flags & WQ_UNBOUND) && max_active == 1)
3983 flags |= __WQ_ORDERED;
3984
Viresh Kumarcee22a12013-04-08 16:45:40 +05303985 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3986 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3987 flags |= WQ_UNBOUND;
3988
Tejun Heoecf68812013-04-01 11:23:34 -07003989 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003990 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003991 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003992
3993 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003994 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003995 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003996
Tejun Heo6029a912013-04-01 11:23:34 -07003997 if (flags & WQ_UNBOUND) {
3998 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3999 if (!wq->unbound_attrs)
4000 goto err_free_wq;
4001 }
4002
Tejun Heoecf68812013-04-01 11:23:34 -07004003 va_start(args, lock_name);
4004 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004005 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004006
Tejun Heod320c032010-06-29 10:07:14 +02004007 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004008 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004009
Tejun Heob196be82012-01-10 15:11:35 -08004010 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004011 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004012 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004013 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004014 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004015 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004016 INIT_LIST_HEAD(&wq->flusher_queue);
4017 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004018 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004019
Johannes Bergeb13ba82008-01-16 09:51:58 +01004020 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004021 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004022
Tejun Heo30cdf2492013-03-12 11:29:57 -07004023 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004024 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004025
Tejun Heo493008a2013-03-12 11:30:03 -07004026 /*
4027 * Workqueues which may be used during memory reclaim should
4028 * have a rescuer to guarantee forward progress.
4029 */
4030 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004031 struct worker *rescuer;
4032
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004033 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004034 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004035 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004036
Tejun Heo111c2252013-01-17 17:16:24 -08004037 rescuer->rescue_wq = wq;
4038 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004039 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004040 if (IS_ERR(rescuer->task)) {
4041 kfree(rescuer);
4042 goto err_destroy;
4043 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004044
Tejun Heod2c1d402013-03-12 11:30:04 -07004045 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004046 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004047 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004048 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004049
Tejun Heo226223a2013-03-12 11:30:05 -07004050 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4051 goto err_destroy;
4052
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004053 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004054 * wq_pool_mutex protects global freeze state and workqueues list.
4055 * Grab it, adjust max_active and add the new @wq to workqueues
4056 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004057 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004058 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004059
Lai Jiangshana357fc02013-03-25 16:57:19 -07004060 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004061 for_each_pwq(pwq, wq)
4062 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004063 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004064
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004065 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004066
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004067 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004068
Oleg Nesterov3af244332007-05-09 02:34:09 -07004069 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004070
4071err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004072 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004073 kfree(wq);
4074 return NULL;
4075err_destroy:
4076 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004077 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004078}
Tejun Heod320c032010-06-29 10:07:14 +02004079EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004080
4081/**
4082 * destroy_workqueue - safely terminate a workqueue
4083 * @wq: target workqueue
4084 *
4085 * Safely destroy a workqueue. All work currently pending will be done first.
4086 */
4087void destroy_workqueue(struct workqueue_struct *wq)
4088{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004089 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004090 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004091
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004092 /* drain it before proceeding with destruction */
4093 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004094
Tejun Heo6183c002013-03-12 11:29:57 -07004095 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004096 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004097 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004098 int i;
4099
Tejun Heo76af4d92013-03-12 11:30:00 -07004100 for (i = 0; i < WORK_NR_COLORS; i++) {
4101 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004102 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004103 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004104 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004105 }
4106 }
4107
Lai Jiangshan5c529592013-04-04 10:05:38 +08004108 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004109 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004110 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004111 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004112 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004113 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004114 }
Tejun Heo6183c002013-03-12 11:29:57 -07004115 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004116 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004117
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004118 /*
4119 * wq list is used to freeze wq, remove from list after
4120 * flushing is complete in case freeze races us.
4121 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004122 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004123 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004124 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004125
Tejun Heo226223a2013-03-12 11:30:05 -07004126 workqueue_sysfs_unregister(wq);
4127
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004128 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004129 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004130
Tejun Heo8864b4e2013-03-12 11:30:04 -07004131 if (!(wq->flags & WQ_UNBOUND)) {
4132 /*
4133 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004134 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004135 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004136 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004137 } else {
4138 /*
4139 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004140 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4141 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004142 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004143 for_each_node(node) {
4144 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4145 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4146 put_pwq_unlocked(pwq);
4147 }
4148
4149 /*
4150 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4151 * put. Don't access it afterwards.
4152 */
4153 pwq = wq->dfl_pwq;
4154 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004155 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004156 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004157}
4158EXPORT_SYMBOL_GPL(destroy_workqueue);
4159
Tejun Heodcd989c2010-06-29 10:07:14 +02004160/**
4161 * workqueue_set_max_active - adjust max_active of a workqueue
4162 * @wq: target workqueue
4163 * @max_active: new max_active value.
4164 *
4165 * Set max_active of @wq to @max_active.
4166 *
4167 * CONTEXT:
4168 * Don't call from IRQ context.
4169 */
4170void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4171{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004172 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004173
Tejun Heo8719dce2013-03-12 11:30:04 -07004174 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004175 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004176 return;
4177
Tejun Heof3421792010-07-02 10:03:51 +02004178 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004179
Lai Jiangshana357fc02013-03-25 16:57:19 -07004180 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004181
Tejun Heo0a94efb2017-07-23 08:36:15 -04004182 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004183 wq->saved_max_active = max_active;
4184
Tejun Heo699ce092013-03-13 16:51:35 -07004185 for_each_pwq(pwq, wq)
4186 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004187
Lai Jiangshana357fc02013-03-25 16:57:19 -07004188 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004189}
4190EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4191
4192/**
Tejun Heoe62676162013-03-12 17:41:37 -07004193 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4194 *
4195 * Determine whether %current is a workqueue rescuer. Can be used from
4196 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004197 *
4198 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004199 */
4200bool current_is_workqueue_rescuer(void)
4201{
4202 struct worker *worker = current_wq_worker();
4203
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004204 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004205}
4206
4207/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004208 * workqueue_congested - test whether a workqueue is congested
4209 * @cpu: CPU in question
4210 * @wq: target workqueue
4211 *
4212 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4213 * no synchronization around this function and the test result is
4214 * unreliable and only useful as advisory hints or for debugging.
4215 *
Tejun Heod3251852013-05-10 11:10:17 -07004216 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4217 * Note that both per-cpu and unbound workqueues may be associated with
4218 * multiple pool_workqueues which have separate congested states. A
4219 * workqueue being congested on one CPU doesn't mean the workqueue is also
4220 * contested on other CPUs / NUMA nodes.
4221 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004222 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004223 * %true if congested, %false otherwise.
4224 */
Tejun Heod84ff052013-03-12 11:29:59 -07004225bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004226{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004227 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004228 bool ret;
4229
Lai Jiangshan88109452013-03-20 03:28:10 +08004230 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004231
Tejun Heod3251852013-05-10 11:10:17 -07004232 if (cpu == WORK_CPU_UNBOUND)
4233 cpu = smp_processor_id();
4234
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004235 if (!(wq->flags & WQ_UNBOUND))
4236 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4237 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004238 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004239
Tejun Heo76af4d92013-03-12 11:30:00 -07004240 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004241 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004242
4243 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004244}
4245EXPORT_SYMBOL_GPL(workqueue_congested);
4246
4247/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004248 * work_busy - test whether a work is currently pending or running
4249 * @work: the work to be tested
4250 *
4251 * Test whether @work is currently pending or running. There is no
4252 * synchronization around this function and the test result is
4253 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004254 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004255 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004256 * OR'd bitmask of WORK_BUSY_* bits.
4257 */
4258unsigned int work_busy(struct work_struct *work)
4259{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004260 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004261 unsigned long flags;
4262 unsigned int ret = 0;
4263
Tejun Heodcd989c2010-06-29 10:07:14 +02004264 if (work_pending(work))
4265 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004266
Tejun Heofa1b54e2013-03-12 11:30:00 -07004267 local_irq_save(flags);
4268 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004269 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004270 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004271 if (find_worker_executing_work(pool, work))
4272 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004273 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004274 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004275 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004276
4277 return ret;
4278}
4279EXPORT_SYMBOL_GPL(work_busy);
4280
Tejun Heo3d1cb202013-04-30 15:27:22 -07004281/**
4282 * set_worker_desc - set description for the current work item
4283 * @fmt: printf-style format string
4284 * @...: arguments for the format string
4285 *
4286 * This function can be called by a running work function to describe what
4287 * the work item is about. If the worker task gets dumped, this
4288 * information will be printed out together to help debugging. The
4289 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4290 */
4291void set_worker_desc(const char *fmt, ...)
4292{
4293 struct worker *worker = current_wq_worker();
4294 va_list args;
4295
4296 if (worker) {
4297 va_start(args, fmt);
4298 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4299 va_end(args);
4300 worker->desc_valid = true;
4301 }
4302}
4303
4304/**
4305 * print_worker_info - print out worker information and description
4306 * @log_lvl: the log level to use when printing
4307 * @task: target task
4308 *
4309 * If @task is a worker and currently executing a work item, print out the
4310 * name of the workqueue being serviced and worker description set with
4311 * set_worker_desc() by the currently executing work item.
4312 *
4313 * This function can be safely called on any task as long as the
4314 * task_struct itself is accessible. While safe, this function isn't
4315 * synchronized and may print out mixups or garbages of limited length.
4316 */
4317void print_worker_info(const char *log_lvl, struct task_struct *task)
4318{
4319 work_func_t *fn = NULL;
4320 char name[WQ_NAME_LEN] = { };
4321 char desc[WORKER_DESC_LEN] = { };
4322 struct pool_workqueue *pwq = NULL;
4323 struct workqueue_struct *wq = NULL;
4324 bool desc_valid = false;
4325 struct worker *worker;
4326
4327 if (!(task->flags & PF_WQ_WORKER))
4328 return;
4329
4330 /*
4331 * This function is called without any synchronization and @task
4332 * could be in any state. Be careful with dereferences.
4333 */
Petr Mladeke7005912016-10-11 13:55:17 -07004334 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004335
4336 /*
4337 * Carefully copy the associated workqueue's workfn and name. Keep
4338 * the original last '\0' in case the original contains garbage.
4339 */
4340 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4341 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4342 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4343 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4344
4345 /* copy worker description */
4346 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4347 if (desc_valid)
4348 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4349
4350 if (fn || name[0] || desc[0]) {
4351 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4352 if (desc[0])
4353 pr_cont(" (%s)", desc);
4354 pr_cont("\n");
4355 }
4356}
4357
Tejun Heo3494fc32015-03-09 09:22:28 -04004358static void pr_cont_pool_info(struct worker_pool *pool)
4359{
4360 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4361 if (pool->node != NUMA_NO_NODE)
4362 pr_cont(" node=%d", pool->node);
4363 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4364}
4365
4366static void pr_cont_work(bool comma, struct work_struct *work)
4367{
4368 if (work->func == wq_barrier_func) {
4369 struct wq_barrier *barr;
4370
4371 barr = container_of(work, struct wq_barrier, work);
4372
4373 pr_cont("%s BAR(%d)", comma ? "," : "",
4374 task_pid_nr(barr->task));
4375 } else {
4376 pr_cont("%s %pf", comma ? "," : "", work->func);
4377 }
4378}
4379
4380static void show_pwq(struct pool_workqueue *pwq)
4381{
4382 struct worker_pool *pool = pwq->pool;
4383 struct work_struct *work;
4384 struct worker *worker;
4385 bool has_in_flight = false, has_pending = false;
4386 int bkt;
4387
4388 pr_info(" pwq %d:", pool->id);
4389 pr_cont_pool_info(pool);
4390
4391 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4392 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4393
4394 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4395 if (worker->current_pwq == pwq) {
4396 has_in_flight = true;
4397 break;
4398 }
4399 }
4400 if (has_in_flight) {
4401 bool comma = false;
4402
4403 pr_info(" in-flight:");
4404 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4405 if (worker->current_pwq != pwq)
4406 continue;
4407
4408 pr_cont("%s %d%s:%pf", comma ? "," : "",
4409 task_pid_nr(worker->task),
4410 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4411 worker->current_func);
4412 list_for_each_entry(work, &worker->scheduled, entry)
4413 pr_cont_work(false, work);
4414 comma = true;
4415 }
4416 pr_cont("\n");
4417 }
4418
4419 list_for_each_entry(work, &pool->worklist, entry) {
4420 if (get_work_pwq(work) == pwq) {
4421 has_pending = true;
4422 break;
4423 }
4424 }
4425 if (has_pending) {
4426 bool comma = false;
4427
4428 pr_info(" pending:");
4429 list_for_each_entry(work, &pool->worklist, entry) {
4430 if (get_work_pwq(work) != pwq)
4431 continue;
4432
4433 pr_cont_work(comma, work);
4434 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4435 }
4436 pr_cont("\n");
4437 }
4438
4439 if (!list_empty(&pwq->delayed_works)) {
4440 bool comma = false;
4441
4442 pr_info(" delayed:");
4443 list_for_each_entry(work, &pwq->delayed_works, entry) {
4444 pr_cont_work(comma, work);
4445 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4446 }
4447 pr_cont("\n");
4448 }
4449}
4450
4451/**
4452 * show_workqueue_state - dump workqueue state
4453 *
Roger Lu7b776af2016-07-01 11:05:02 +08004454 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4455 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004456 */
4457void show_workqueue_state(void)
4458{
4459 struct workqueue_struct *wq;
4460 struct worker_pool *pool;
4461 unsigned long flags;
4462 int pi;
4463
4464 rcu_read_lock_sched();
4465
4466 pr_info("Showing busy workqueues and worker pools:\n");
4467
4468 list_for_each_entry_rcu(wq, &workqueues, list) {
4469 struct pool_workqueue *pwq;
4470 bool idle = true;
4471
4472 for_each_pwq(pwq, wq) {
4473 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4474 idle = false;
4475 break;
4476 }
4477 }
4478 if (idle)
4479 continue;
4480
4481 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4482
4483 for_each_pwq(pwq, wq) {
4484 spin_lock_irqsave(&pwq->pool->lock, flags);
4485 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4486 show_pwq(pwq);
4487 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4488 }
4489 }
4490
4491 for_each_pool(pool, pi) {
4492 struct worker *worker;
4493 bool first = true;
4494
4495 spin_lock_irqsave(&pool->lock, flags);
4496 if (pool->nr_workers == pool->nr_idle)
4497 goto next_pool;
4498
4499 pr_info("pool %d:", pool->id);
4500 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004501 pr_cont(" hung=%us workers=%d",
4502 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4503 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004504 if (pool->manager)
4505 pr_cont(" manager: %d",
4506 task_pid_nr(pool->manager->task));
4507 list_for_each_entry(worker, &pool->idle_list, entry) {
4508 pr_cont(" %s%d", first ? "idle: " : "",
4509 task_pid_nr(worker->task));
4510 first = false;
4511 }
4512 pr_cont("\n");
4513 next_pool:
4514 spin_unlock_irqrestore(&pool->lock, flags);
4515 }
4516
4517 rcu_read_unlock_sched();
4518}
4519
Tejun Heodb7bccf2010-06-29 10:07:12 +02004520/*
4521 * CPU hotplug.
4522 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004523 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004524 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004525 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004526 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004527 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004528 * blocked draining impractical.
4529 *
Tejun Heo24647572013-01-24 11:01:33 -08004530 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004531 * running as an unbound one and allowing it to be reattached later if the
4532 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004533 */
4534
Tejun Heo706026c2013-01-24 11:01:34 -08004535static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004536{
Tejun Heo38db41d2013-01-24 11:01:34 -08004537 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004538 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004539 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004540
Tejun Heof02ae732013-03-12 11:30:03 -07004541 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004542 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004543 spin_lock_irq(&pool->lock);
4544
4545 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004546 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004547 * unbound and set DISASSOCIATED. Before this, all workers
4548 * except for the ones which are still executing works from
4549 * before the last CPU down must be on the cpu. After
4550 * this, they may become diasporas.
4551 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004552 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004553 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004554
Tejun Heo24647572013-01-24 11:01:33 -08004555 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004556
Tejun Heo94cf58b2013-01-24 11:01:33 -08004557 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004558 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004559
Lai Jiangshaneb283422013-03-08 15:18:28 -08004560 /*
4561 * Call schedule() so that we cross rq->lock and thus can
4562 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4563 * This is necessary as scheduler callbacks may be invoked
4564 * from other cpus.
4565 */
4566 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004567
Lai Jiangshaneb283422013-03-08 15:18:28 -08004568 /*
4569 * Sched callbacks are disabled now. Zap nr_running.
4570 * After this, nr_running stays zero and need_more_worker()
4571 * and keep_working() are always true as long as the
4572 * worklist is not empty. This pool now behaves as an
4573 * unbound (in terms of concurrency management) pool which
4574 * are served by workers tied to the pool.
4575 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004576 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004577
4578 /*
4579 * With concurrency management just turned off, a busy
4580 * worker blocking could lead to lengthy stalls. Kick off
4581 * unbound chain execution of currently pending work items.
4582 */
4583 spin_lock_irq(&pool->lock);
4584 wake_up_worker(pool);
4585 spin_unlock_irq(&pool->lock);
4586 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004587}
4588
Tejun Heobd7c0892013-03-19 13:45:21 -07004589/**
4590 * rebind_workers - rebind all workers of a pool to the associated CPU
4591 * @pool: pool of interest
4592 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004593 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004594 */
4595static void rebind_workers(struct worker_pool *pool)
4596{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004597 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004598
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004599 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004600
Tejun Heoa9ab7752013-03-19 13:45:21 -07004601 /*
4602 * Restore CPU affinity of all workers. As all idle workers should
4603 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304604 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004605 * of all workers first and then clear UNBOUND. As we're called
4606 * from CPU_ONLINE, the following shouldn't fail.
4607 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004608 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004609 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4610 pool->attrs->cpumask) < 0);
4611
4612 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004613
4614 /*
4615 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4616 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4617 * being reworked and this can go away in time.
4618 */
4619 if (!(pool->flags & POOL_DISASSOCIATED)) {
4620 spin_unlock_irq(&pool->lock);
4621 return;
4622 }
4623
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004624 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004625
Lai Jiangshanda028462014-05-20 17:46:31 +08004626 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004627 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004628
4629 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004630 * A bound idle worker should actually be on the runqueue
4631 * of the associated CPU for local wake-ups targeting it to
4632 * work. Kick all idle workers so that they migrate to the
4633 * associated CPU. Doing this in the same loop as
4634 * replacing UNBOUND with REBOUND is safe as no worker will
4635 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004636 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004637 if (worker_flags & WORKER_IDLE)
4638 wake_up_process(worker->task);
4639
4640 /*
4641 * We want to clear UNBOUND but can't directly call
4642 * worker_clr_flags() or adjust nr_running. Atomically
4643 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4644 * @worker will clear REBOUND using worker_clr_flags() when
4645 * it initiates the next execution cycle thus restoring
4646 * concurrency management. Note that when or whether
4647 * @worker clears REBOUND doesn't affect correctness.
4648 *
4649 * ACCESS_ONCE() is necessary because @worker->flags may be
4650 * tested without holding any lock in
4651 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4652 * fail incorrectly leading to premature concurrency
4653 * management operations.
4654 */
4655 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4656 worker_flags |= WORKER_REBOUND;
4657 worker_flags &= ~WORKER_UNBOUND;
4658 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004659 }
4660
Tejun Heoa9ab7752013-03-19 13:45:21 -07004661 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004662}
4663
Tejun Heo7dbc7252013-03-19 13:45:21 -07004664/**
4665 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4666 * @pool: unbound pool of interest
4667 * @cpu: the CPU which is coming up
4668 *
4669 * An unbound pool may end up with a cpumask which doesn't have any online
4670 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4671 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4672 * online CPU before, cpus_allowed of all its workers should be restored.
4673 */
4674static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4675{
4676 static cpumask_t cpumask;
4677 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004678
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004679 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004680
4681 /* is @cpu allowed for @pool? */
4682 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4683 return;
4684
Tejun Heo7dbc7252013-03-19 13:45:21 -07004685 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004686
4687 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004688 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004689 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004690}
4691
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004692int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004693{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004694 struct worker_pool *pool;
4695
4696 for_each_cpu_worker_pool(pool, cpu) {
4697 if (pool->nr_workers)
4698 continue;
4699 if (!create_worker(pool))
4700 return -ENOMEM;
4701 }
4702 return 0;
4703}
4704
4705int workqueue_online_cpu(unsigned int cpu)
4706{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004707 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004708 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004709 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004710
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004711 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004712
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004713 for_each_pool(pool, pi) {
4714 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004715
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004716 if (pool->cpu == cpu)
4717 rebind_workers(pool);
4718 else if (pool->cpu < 0)
4719 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004720
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004721 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004722 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004723
4724 /* update NUMA affinity of unbound workqueues */
4725 list_for_each_entry(wq, &workqueues, list)
4726 wq_update_unbound_numa(wq, cpu, true);
4727
4728 mutex_unlock(&wq_pool_mutex);
4729 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004730}
4731
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004732int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004733{
Tejun Heo8db25e72012-07-17 12:39:28 -07004734 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004735 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004736
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004737 /* unbinding per-cpu workers should happen on the local CPU */
4738 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4739 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004740
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004741 /* update NUMA affinity of unbound workqueues */
4742 mutex_lock(&wq_pool_mutex);
4743 list_for_each_entry(wq, &workqueues, list)
4744 wq_update_unbound_numa(wq, cpu, false);
4745 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004746
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004747 /* wait for per-cpu unbinding to finish */
4748 flush_work(&unbind_work);
4749 destroy_work_on_stack(&unbind_work);
4750 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004751}
4752
Rusty Russell2d3854a2008-11-05 13:39:10 +11004753#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004754
Rusty Russell2d3854a2008-11-05 13:39:10 +11004755struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004756 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004757 long (*fn)(void *);
4758 void *arg;
4759 long ret;
4760};
4761
Tejun Heoed48ece2012-09-18 12:48:43 -07004762static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004763{
Tejun Heoed48ece2012-09-18 12:48:43 -07004764 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4765
Rusty Russell2d3854a2008-11-05 13:39:10 +11004766 wfc->ret = wfc->fn(wfc->arg);
4767}
4768
4769/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004770 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004771 * @cpu: the cpu to run on
4772 * @fn: the function to run
4773 * @arg: the function arg
4774 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004775 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004776 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004777 *
4778 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004779 */
Tejun Heod84ff052013-03-12 11:29:59 -07004780long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004781{
Tejun Heoed48ece2012-09-18 12:48:43 -07004782 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004783
Tejun Heoed48ece2012-09-18 12:48:43 -07004784 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4785 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004786 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004787 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004788 return wfc.ret;
4789}
4790EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004791
4792/**
4793 * work_on_cpu_safe - run a function in thread context on a particular cpu
4794 * @cpu: the cpu to run on
4795 * @fn: the function to run
4796 * @arg: the function argument
4797 *
4798 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4799 * any locks which would prevent @fn from completing.
4800 *
4801 * Return: The value @fn returns.
4802 */
4803long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4804{
4805 long ret = -ENODEV;
4806
4807 get_online_cpus();
4808 if (cpu_online(cpu))
4809 ret = work_on_cpu(cpu, fn, arg);
4810 put_online_cpus();
4811 return ret;
4812}
4813EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004814#endif /* CONFIG_SMP */
4815
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004816#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304817
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004818/**
4819 * freeze_workqueues_begin - begin freezing workqueues
4820 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004821 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004822 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004823 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004824 *
4825 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004826 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004827 */
4828void freeze_workqueues_begin(void)
4829{
Tejun Heo24b8a842013-03-12 11:29:58 -07004830 struct workqueue_struct *wq;
4831 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004832
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004833 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004834
Tejun Heo6183c002013-03-12 11:29:57 -07004835 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004836 workqueue_freezing = true;
4837
Tejun Heo24b8a842013-03-12 11:29:58 -07004838 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004839 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004840 for_each_pwq(pwq, wq)
4841 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004842 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004843 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004844
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004845 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004846}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004847
4848/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004849 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004850 *
4851 * Check whether freezing is complete. This function must be called
4852 * between freeze_workqueues_begin() and thaw_workqueues().
4853 *
4854 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004855 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004856 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004857 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004858 * %true if some freezable workqueues are still busy. %false if freezing
4859 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004860 */
4861bool freeze_workqueues_busy(void)
4862{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004863 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004864 struct workqueue_struct *wq;
4865 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004866
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004867 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868
Tejun Heo6183c002013-03-12 11:29:57 -07004869 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004870
Tejun Heo24b8a842013-03-12 11:29:58 -07004871 list_for_each_entry(wq, &workqueues, list) {
4872 if (!(wq->flags & WQ_FREEZABLE))
4873 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004874 /*
4875 * nr_active is monotonically decreasing. It's safe
4876 * to peek without lock.
4877 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004878 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004879 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004880 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004881 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004882 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004883 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004884 goto out_unlock;
4885 }
4886 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004887 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004888 }
4889out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004890 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004891 return busy;
4892}
4893
4894/**
4895 * thaw_workqueues - thaw workqueues
4896 *
4897 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004898 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004899 *
4900 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004901 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004902 */
4903void thaw_workqueues(void)
4904{
Tejun Heo24b8a842013-03-12 11:29:58 -07004905 struct workqueue_struct *wq;
4906 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004907
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004908 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004909
4910 if (!workqueue_freezing)
4911 goto out_unlock;
4912
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004913 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004914
Tejun Heo24b8a842013-03-12 11:29:58 -07004915 /* restore max_active and repopulate worklist */
4916 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004917 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004918 for_each_pwq(pwq, wq)
4919 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004920 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004921 }
4922
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004923out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004924 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004925}
4926#endif /* CONFIG_FREEZER */
4927
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004928static int workqueue_apply_unbound_cpumask(void)
4929{
4930 LIST_HEAD(ctxs);
4931 int ret = 0;
4932 struct workqueue_struct *wq;
4933 struct apply_wqattrs_ctx *ctx, *n;
4934
4935 lockdep_assert_held(&wq_pool_mutex);
4936
4937 list_for_each_entry(wq, &workqueues, list) {
4938 if (!(wq->flags & WQ_UNBOUND))
4939 continue;
4940 /* creating multiple pwqs breaks ordering guarantee */
4941 if (wq->flags & __WQ_ORDERED)
4942 continue;
4943
4944 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4945 if (!ctx) {
4946 ret = -ENOMEM;
4947 break;
4948 }
4949
4950 list_add_tail(&ctx->list, &ctxs);
4951 }
4952
4953 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4954 if (!ret)
4955 apply_wqattrs_commit(ctx);
4956 apply_wqattrs_cleanup(ctx);
4957 }
4958
4959 return ret;
4960}
4961
4962/**
4963 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4964 * @cpumask: the cpumask to set
4965 *
4966 * The low-level workqueues cpumask is a global cpumask that limits
4967 * the affinity of all unbound workqueues. This function check the @cpumask
4968 * and apply it to all unbound workqueues and updates all pwqs of them.
4969 *
4970 * Retun: 0 - Success
4971 * -EINVAL - Invalid @cpumask
4972 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4973 */
4974int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4975{
4976 int ret = -EINVAL;
4977 cpumask_var_t saved_cpumask;
4978
4979 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4980 return -ENOMEM;
4981
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004982 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4983 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004984 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004985
4986 /* save the old wq_unbound_cpumask. */
4987 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4988
4989 /* update wq_unbound_cpumask at first and apply it to wqs. */
4990 cpumask_copy(wq_unbound_cpumask, cpumask);
4991 ret = workqueue_apply_unbound_cpumask();
4992
4993 /* restore the wq_unbound_cpumask when failed. */
4994 if (ret < 0)
4995 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4996
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004997 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004998 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004999
5000 free_cpumask_var(saved_cpumask);
5001 return ret;
5002}
5003
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005004#ifdef CONFIG_SYSFS
5005/*
5006 * Workqueues with WQ_SYSFS flag set is visible to userland via
5007 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5008 * following attributes.
5009 *
5010 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5011 * max_active RW int : maximum number of in-flight work items
5012 *
5013 * Unbound workqueues have the following extra attributes.
5014 *
5015 * id RO int : the associated pool ID
5016 * nice RW int : nice value of the workers
5017 * cpumask RW mask : bitmask of allowed CPUs for the workers
5018 */
5019struct wq_device {
5020 struct workqueue_struct *wq;
5021 struct device dev;
5022};
5023
5024static struct workqueue_struct *dev_to_wq(struct device *dev)
5025{
5026 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5027
5028 return wq_dev->wq;
5029}
5030
5031static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5032 char *buf)
5033{
5034 struct workqueue_struct *wq = dev_to_wq(dev);
5035
5036 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5037}
5038static DEVICE_ATTR_RO(per_cpu);
5039
5040static ssize_t max_active_show(struct device *dev,
5041 struct device_attribute *attr, char *buf)
5042{
5043 struct workqueue_struct *wq = dev_to_wq(dev);
5044
5045 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5046}
5047
5048static ssize_t max_active_store(struct device *dev,
5049 struct device_attribute *attr, const char *buf,
5050 size_t count)
5051{
5052 struct workqueue_struct *wq = dev_to_wq(dev);
5053 int val;
5054
5055 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5056 return -EINVAL;
5057
5058 workqueue_set_max_active(wq, val);
5059 return count;
5060}
5061static DEVICE_ATTR_RW(max_active);
5062
5063static struct attribute *wq_sysfs_attrs[] = {
5064 &dev_attr_per_cpu.attr,
5065 &dev_attr_max_active.attr,
5066 NULL,
5067};
5068ATTRIBUTE_GROUPS(wq_sysfs);
5069
5070static ssize_t wq_pool_ids_show(struct device *dev,
5071 struct device_attribute *attr, char *buf)
5072{
5073 struct workqueue_struct *wq = dev_to_wq(dev);
5074 const char *delim = "";
5075 int node, written = 0;
5076
5077 rcu_read_lock_sched();
5078 for_each_node(node) {
5079 written += scnprintf(buf + written, PAGE_SIZE - written,
5080 "%s%d:%d", delim, node,
5081 unbound_pwq_by_node(wq, node)->pool->id);
5082 delim = " ";
5083 }
5084 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5085 rcu_read_unlock_sched();
5086
5087 return written;
5088}
5089
5090static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5091 char *buf)
5092{
5093 struct workqueue_struct *wq = dev_to_wq(dev);
5094 int written;
5095
5096 mutex_lock(&wq->mutex);
5097 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5098 mutex_unlock(&wq->mutex);
5099
5100 return written;
5101}
5102
5103/* prepare workqueue_attrs for sysfs store operations */
5104static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5105{
5106 struct workqueue_attrs *attrs;
5107
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005108 lockdep_assert_held(&wq_pool_mutex);
5109
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005110 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5111 if (!attrs)
5112 return NULL;
5113
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005114 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005115 return attrs;
5116}
5117
5118static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5119 const char *buf, size_t count)
5120{
5121 struct workqueue_struct *wq = dev_to_wq(dev);
5122 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005123 int ret = -ENOMEM;
5124
5125 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005126
5127 attrs = wq_sysfs_prep_attrs(wq);
5128 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005129 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005130
5131 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5132 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005133 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005134 else
5135 ret = -EINVAL;
5136
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005137out_unlock:
5138 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005139 free_workqueue_attrs(attrs);
5140 return ret ?: count;
5141}
5142
5143static ssize_t wq_cpumask_show(struct device *dev,
5144 struct device_attribute *attr, char *buf)
5145{
5146 struct workqueue_struct *wq = dev_to_wq(dev);
5147 int written;
5148
5149 mutex_lock(&wq->mutex);
5150 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5151 cpumask_pr_args(wq->unbound_attrs->cpumask));
5152 mutex_unlock(&wq->mutex);
5153 return written;
5154}
5155
5156static ssize_t wq_cpumask_store(struct device *dev,
5157 struct device_attribute *attr,
5158 const char *buf, size_t count)
5159{
5160 struct workqueue_struct *wq = dev_to_wq(dev);
5161 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005162 int ret = -ENOMEM;
5163
5164 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005165
5166 attrs = wq_sysfs_prep_attrs(wq);
5167 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005168 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005169
5170 ret = cpumask_parse(buf, attrs->cpumask);
5171 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005172 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005173
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005174out_unlock:
5175 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005176 free_workqueue_attrs(attrs);
5177 return ret ?: count;
5178}
5179
5180static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5181 char *buf)
5182{
5183 struct workqueue_struct *wq = dev_to_wq(dev);
5184 int written;
5185
5186 mutex_lock(&wq->mutex);
5187 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5188 !wq->unbound_attrs->no_numa);
5189 mutex_unlock(&wq->mutex);
5190
5191 return written;
5192}
5193
5194static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5195 const char *buf, size_t count)
5196{
5197 struct workqueue_struct *wq = dev_to_wq(dev);
5198 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005199 int v, ret = -ENOMEM;
5200
5201 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005202
5203 attrs = wq_sysfs_prep_attrs(wq);
5204 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005205 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005206
5207 ret = -EINVAL;
5208 if (sscanf(buf, "%d", &v) == 1) {
5209 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005210 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005211 }
5212
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005213out_unlock:
5214 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005215 free_workqueue_attrs(attrs);
5216 return ret ?: count;
5217}
5218
5219static struct device_attribute wq_sysfs_unbound_attrs[] = {
5220 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5221 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5222 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5223 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5224 __ATTR_NULL,
5225};
5226
5227static struct bus_type wq_subsys = {
5228 .name = "workqueue",
5229 .dev_groups = wq_sysfs_groups,
5230};
5231
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005232static ssize_t wq_unbound_cpumask_show(struct device *dev,
5233 struct device_attribute *attr, char *buf)
5234{
5235 int written;
5236
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005237 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005238 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5239 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005240 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005241
5242 return written;
5243}
5244
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005245static ssize_t wq_unbound_cpumask_store(struct device *dev,
5246 struct device_attribute *attr, const char *buf, size_t count)
5247{
5248 cpumask_var_t cpumask;
5249 int ret;
5250
5251 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5252 return -ENOMEM;
5253
5254 ret = cpumask_parse(buf, cpumask);
5255 if (!ret)
5256 ret = workqueue_set_unbound_cpumask(cpumask);
5257
5258 free_cpumask_var(cpumask);
5259 return ret ? ret : count;
5260}
5261
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005262static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005263 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5264 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005265
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005266static int __init wq_sysfs_init(void)
5267{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005268 int err;
5269
5270 err = subsys_virtual_register(&wq_subsys, NULL);
5271 if (err)
5272 return err;
5273
5274 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005275}
5276core_initcall(wq_sysfs_init);
5277
5278static void wq_device_release(struct device *dev)
5279{
5280 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5281
5282 kfree(wq_dev);
5283}
5284
5285/**
5286 * workqueue_sysfs_register - make a workqueue visible in sysfs
5287 * @wq: the workqueue to register
5288 *
5289 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5290 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5291 * which is the preferred method.
5292 *
5293 * Workqueue user should use this function directly iff it wants to apply
5294 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5295 * apply_workqueue_attrs() may race against userland updating the
5296 * attributes.
5297 *
5298 * Return: 0 on success, -errno on failure.
5299 */
5300int workqueue_sysfs_register(struct workqueue_struct *wq)
5301{
5302 struct wq_device *wq_dev;
5303 int ret;
5304
5305 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305306 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005307 * attributes breaks ordering guarantee. Disallow exposing ordered
5308 * workqueues.
5309 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005310 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005311 return -EINVAL;
5312
5313 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5314 if (!wq_dev)
5315 return -ENOMEM;
5316
5317 wq_dev->wq = wq;
5318 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005319 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005320 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005321
5322 /*
5323 * unbound_attrs are created separately. Suppress uevent until
5324 * everything is ready.
5325 */
5326 dev_set_uevent_suppress(&wq_dev->dev, true);
5327
5328 ret = device_register(&wq_dev->dev);
5329 if (ret) {
5330 kfree(wq_dev);
5331 wq->wq_dev = NULL;
5332 return ret;
5333 }
5334
5335 if (wq->flags & WQ_UNBOUND) {
5336 struct device_attribute *attr;
5337
5338 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5339 ret = device_create_file(&wq_dev->dev, attr);
5340 if (ret) {
5341 device_unregister(&wq_dev->dev);
5342 wq->wq_dev = NULL;
5343 return ret;
5344 }
5345 }
5346 }
5347
5348 dev_set_uevent_suppress(&wq_dev->dev, false);
5349 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5350 return 0;
5351}
5352
5353/**
5354 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5355 * @wq: the workqueue to unregister
5356 *
5357 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5358 */
5359static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5360{
5361 struct wq_device *wq_dev = wq->wq_dev;
5362
5363 if (!wq->wq_dev)
5364 return;
5365
5366 wq->wq_dev = NULL;
5367 device_unregister(&wq_dev->dev);
5368}
5369#else /* CONFIG_SYSFS */
5370static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5371#endif /* CONFIG_SYSFS */
5372
Tejun Heo82607adc2015-12-08 11:28:04 -05005373/*
5374 * Workqueue watchdog.
5375 *
5376 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5377 * flush dependency, a concurrency managed work item which stays RUNNING
5378 * indefinitely. Workqueue stalls can be very difficult to debug as the
5379 * usual warning mechanisms don't trigger and internal workqueue state is
5380 * largely opaque.
5381 *
5382 * Workqueue watchdog monitors all worker pools periodically and dumps
5383 * state if some pools failed to make forward progress for a while where
5384 * forward progress is defined as the first item on ->worklist changing.
5385 *
5386 * This mechanism is controlled through the kernel parameter
5387 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5388 * corresponding sysfs parameter file.
5389 */
5390#ifdef CONFIG_WQ_WATCHDOG
5391
Tejun Heo82607adc2015-12-08 11:28:04 -05005392static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005393static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005394
5395static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5396static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5397
5398static void wq_watchdog_reset_touched(void)
5399{
5400 int cpu;
5401
5402 wq_watchdog_touched = jiffies;
5403 for_each_possible_cpu(cpu)
5404 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5405}
5406
Kees Cook5cd79d62017-10-04 16:27:00 -07005407static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005408{
5409 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5410 bool lockup_detected = false;
5411 struct worker_pool *pool;
5412 int pi;
5413
5414 if (!thresh)
5415 return;
5416
5417 rcu_read_lock();
5418
5419 for_each_pool(pool, pi) {
5420 unsigned long pool_ts, touched, ts;
5421
5422 if (list_empty(&pool->worklist))
5423 continue;
5424
5425 /* get the latest of pool and touched timestamps */
5426 pool_ts = READ_ONCE(pool->watchdog_ts);
5427 touched = READ_ONCE(wq_watchdog_touched);
5428
5429 if (time_after(pool_ts, touched))
5430 ts = pool_ts;
5431 else
5432 ts = touched;
5433
5434 if (pool->cpu >= 0) {
5435 unsigned long cpu_touched =
5436 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5437 pool->cpu));
5438 if (time_after(cpu_touched, ts))
5439 ts = cpu_touched;
5440 }
5441
5442 /* did we stall? */
5443 if (time_after(jiffies, ts + thresh)) {
5444 lockup_detected = true;
5445 pr_emerg("BUG: workqueue lockup - pool");
5446 pr_cont_pool_info(pool);
5447 pr_cont(" stuck for %us!\n",
5448 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5449 }
5450 }
5451
5452 rcu_read_unlock();
5453
5454 if (lockup_detected)
5455 show_workqueue_state();
5456
5457 wq_watchdog_reset_touched();
5458 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5459}
5460
5461void wq_watchdog_touch(int cpu)
5462{
5463 if (cpu >= 0)
5464 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5465 else
5466 wq_watchdog_touched = jiffies;
5467}
5468
5469static void wq_watchdog_set_thresh(unsigned long thresh)
5470{
5471 wq_watchdog_thresh = 0;
5472 del_timer_sync(&wq_watchdog_timer);
5473
5474 if (thresh) {
5475 wq_watchdog_thresh = thresh;
5476 wq_watchdog_reset_touched();
5477 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5478 }
5479}
5480
5481static int wq_watchdog_param_set_thresh(const char *val,
5482 const struct kernel_param *kp)
5483{
5484 unsigned long thresh;
5485 int ret;
5486
5487 ret = kstrtoul(val, 0, &thresh);
5488 if (ret)
5489 return ret;
5490
5491 if (system_wq)
5492 wq_watchdog_set_thresh(thresh);
5493 else
5494 wq_watchdog_thresh = thresh;
5495
5496 return 0;
5497}
5498
5499static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5500 .set = wq_watchdog_param_set_thresh,
5501 .get = param_get_ulong,
5502};
5503
5504module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5505 0644);
5506
5507static void wq_watchdog_init(void)
5508{
Kees Cook5cd79d62017-10-04 16:27:00 -07005509 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005510 wq_watchdog_set_thresh(wq_watchdog_thresh);
5511}
5512
5513#else /* CONFIG_WQ_WATCHDOG */
5514
5515static inline void wq_watchdog_init(void) { }
5516
5517#endif /* CONFIG_WQ_WATCHDOG */
5518
Tejun Heobce90382013-04-01 11:23:32 -07005519static void __init wq_numa_init(void)
5520{
5521 cpumask_var_t *tbl;
5522 int node, cpu;
5523
Tejun Heobce90382013-04-01 11:23:32 -07005524 if (num_possible_nodes() <= 1)
5525 return;
5526
Tejun Heod55262c2013-04-01 11:23:38 -07005527 if (wq_disable_numa) {
5528 pr_info("workqueue: NUMA affinity support disabled\n");
5529 return;
5530 }
5531
Tejun Heo4c16bd32013-04-01 11:23:36 -07005532 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5533 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5534
Tejun Heobce90382013-04-01 11:23:32 -07005535 /*
5536 * We want masks of possible CPUs of each node which isn't readily
5537 * available. Build one from cpu_to_node() which should have been
5538 * fully initialized by now.
5539 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005540 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005541 BUG_ON(!tbl);
5542
5543 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005544 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005545 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005546
5547 for_each_possible_cpu(cpu) {
5548 node = cpu_to_node(cpu);
5549 if (WARN_ON(node == NUMA_NO_NODE)) {
5550 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5551 /* happens iff arch is bonkers, let's just proceed */
5552 return;
5553 }
5554 cpumask_set_cpu(cpu, tbl[node]);
5555 }
5556
5557 wq_numa_possible_cpumask = tbl;
5558 wq_numa_enabled = true;
5559}
5560
Tejun Heo3347fa02016-09-16 15:49:32 -04005561/**
5562 * workqueue_init_early - early init for workqueue subsystem
5563 *
5564 * This is the first half of two-staged workqueue subsystem initialization
5565 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5566 * idr are up. It sets up all the data structures and system workqueues
5567 * and allows early boot code to create workqueues and queue/cancel work
5568 * items. Actual work item execution starts only after kthreads can be
5569 * created and scheduled right before early initcalls.
5570 */
5571int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005572{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005573 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5574 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005575
Tejun Heoe904e6c2013-03-12 11:29:57 -07005576 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5577
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005578 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5579 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5580
Tejun Heoe904e6c2013-03-12 11:29:57 -07005581 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5582
Tejun Heo706026c2013-01-24 11:01:34 -08005583 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005584 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005585 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005586
Tejun Heo7a4e3442013-03-12 11:30:00 -07005587 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005588 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005589 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005590 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005591 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005592 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005593 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005594
Tejun Heo9daf9e62013-01-24 11:01:33 -08005595 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005596 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005597 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005598 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005599 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005600 }
5601
Tejun Heo8a2b7532013-09-05 12:30:04 -04005602 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005603 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5604 struct workqueue_attrs *attrs;
5605
5606 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005607 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005608 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005609
5610 /*
5611 * An ordered wq should have only one pwq as ordering is
5612 * guaranteed by max_active which is enforced by pwqs.
5613 * Turn off NUMA so that dfl_pwq is used for all nodes.
5614 */
5615 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5616 attrs->nice = std_nice[i];
5617 attrs->no_numa = true;
5618 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005619 }
5620
Tejun Heod320c032010-06-29 10:07:14 +02005621 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005622 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005623 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005624 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5625 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005626 system_freezable_wq = alloc_workqueue("events_freezable",
5627 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305628 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5629 WQ_POWER_EFFICIENT, 0);
5630 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5631 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5632 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005633 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305634 !system_unbound_wq || !system_freezable_wq ||
5635 !system_power_efficient_wq ||
5636 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005637
Tejun Heo3347fa02016-09-16 15:49:32 -04005638 return 0;
5639}
5640
5641/**
5642 * workqueue_init - bring workqueue subsystem fully online
5643 *
5644 * This is the latter half of two-staged workqueue subsystem initialization
5645 * and invoked as soon as kthreads can be created and scheduled.
5646 * Workqueues have been created and work items queued on them, but there
5647 * are no kworkers executing the work items yet. Populate the worker pools
5648 * with the initial workers and enable future kworker creations.
5649 */
5650int __init workqueue_init(void)
5651{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005652 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005653 struct worker_pool *pool;
5654 int cpu, bkt;
5655
Tejun Heo2186d9f2016-10-19 12:01:27 -04005656 /*
5657 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5658 * CPU to node mapping may not be available that early on some
5659 * archs such as power and arm64. As per-cpu pools created
5660 * previously could be missing node hint and unbound pools NUMA
5661 * affinity, fix them up.
5662 */
5663 wq_numa_init();
5664
5665 mutex_lock(&wq_pool_mutex);
5666
5667 for_each_possible_cpu(cpu) {
5668 for_each_cpu_worker_pool(pool, cpu) {
5669 pool->node = cpu_to_node(cpu);
5670 }
5671 }
5672
5673 list_for_each_entry(wq, &workqueues, list)
5674 wq_update_unbound_numa(wq, smp_processor_id(), true);
5675
5676 mutex_unlock(&wq_pool_mutex);
5677
Tejun Heo3347fa02016-09-16 15:49:32 -04005678 /* create the initial workers */
5679 for_each_online_cpu(cpu) {
5680 for_each_cpu_worker_pool(pool, cpu) {
5681 pool->flags &= ~POOL_DISASSOCIATED;
5682 BUG_ON(!create_worker(pool));
5683 }
5684 }
5685
5686 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5687 BUG_ON(!create_worker(pool));
5688
5689 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005690 wq_watchdog_init();
5691
Suresh Siddha6ee05782010-07-30 14:57:37 -07005692 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005693}