blob: 160fdc6e839a05421a4517ce55e674e22f6c033a [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
Tejun Heod8e794d2012-08-03 10:30:45 -07001495void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
David Howells52bad642006-11-22 14:54:01 +00001497 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001499 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001500 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001502EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001504static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1505 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001507 struct timer_list *timer = &dwork->timer;
1508 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Tejun Heo637fdba2017-03-06 15:33:42 -05001510 WARN_ON_ONCE(!wq);
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001511 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1512 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001513 WARN_ON_ONCE(timer_pending(timer));
1514 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001515
Tejun Heo8852aac2012-12-01 16:23:42 -08001516 /*
1517 * If @delay is 0, queue @dwork->work immediately. This is for
1518 * both optimization and correctness. The earliest @timer can
1519 * expire is on the closest next tick and delayed_work users depend
1520 * on that there's no such delay when @delay is 0.
1521 */
1522 if (!delay) {
1523 __queue_work(cpu, wq, &dwork->work);
1524 return;
1525 }
1526
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001527 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001528 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001529 timer->expires = jiffies + delay;
1530
Tejun Heo041bd122016-02-09 16:11:26 -05001531 if (unlikely(cpu != WORK_CPU_UNBOUND))
1532 add_timer_on(timer, cpu);
1533 else
1534 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535}
1536
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001537/**
1538 * queue_delayed_work_on - queue work on specific CPU after delay
1539 * @cpu: CPU number to execute work on
1540 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001541 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001542 * @delay: number of jiffies to wait before queueing
1543 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001544 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001545 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1546 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001547 */
Tejun Heod4283e92012-08-03 10:30:44 -07001548bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1549 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001550{
David Howells52bad642006-11-22 14:54:01 +00001551 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001552 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001553 unsigned long flags;
1554
1555 /* read the comment in __queue_work() */
1556 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001557
Tejun Heo22df02b2010-06-29 10:07:10 +02001558 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001559 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001560 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001561 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001562
1563 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001564 return ret;
1565}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001566EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Tejun Heoc8e55f32010-06-29 10:07:12 +02001568/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001569 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1570 * @cpu: CPU number to execute work on
1571 * @wq: workqueue to use
1572 * @dwork: work to queue
1573 * @delay: number of jiffies to wait before queueing
1574 *
1575 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1576 * modify @dwork's timer so that it expires after @delay. If @delay is
1577 * zero, @work is guaranteed to be scheduled immediately regardless of its
1578 * current state.
1579 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001580 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001581 * pending and its timer was modified.
1582 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001583 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001584 * See try_to_grab_pending() for details.
1585 */
1586bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1587 struct delayed_work *dwork, unsigned long delay)
1588{
1589 unsigned long flags;
1590 int ret;
1591
1592 do {
1593 ret = try_to_grab_pending(&dwork->work, true, &flags);
1594 } while (unlikely(ret == -EAGAIN));
1595
1596 if (likely(ret >= 0)) {
1597 __queue_delayed_work(cpu, wq, dwork, delay);
1598 local_irq_restore(flags);
1599 }
1600
1601 /* -ENOENT from try_to_grab_pending() becomes %true */
1602 return ret;
1603}
1604EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1605
1606/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001607 * worker_enter_idle - enter idle state
1608 * @worker: worker which is entering idle state
1609 *
1610 * @worker is entering idle state. Update stats and idle timer if
1611 * necessary.
1612 *
1613 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001614 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001615 */
1616static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001618 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Tejun Heo6183c002013-03-12 11:29:57 -07001620 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1621 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1622 (worker->hentry.next || worker->hentry.pprev)))
1623 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Lai Jiangshan051e1852014-07-22 13:03:02 +08001625 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001626 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001627 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001628 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001629
Tejun Heoc8e55f32010-06-29 10:07:12 +02001630 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001631 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001632
Tejun Heo628c78e2012-07-17 12:39:27 -07001633 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1634 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001635
Tejun Heo544ecf32012-05-14 15:04:50 -07001636 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001637 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001638 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001639 * nr_running, the warning may trigger spuriously. Check iff
1640 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001641 */
Tejun Heo24647572013-01-24 11:01:33 -08001642 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001643 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001644 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645}
1646
Tejun Heoc8e55f32010-06-29 10:07:12 +02001647/**
1648 * worker_leave_idle - leave idle state
1649 * @worker: worker which is leaving idle state
1650 *
1651 * @worker is leaving idle state. Update stats.
1652 *
1653 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001654 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001655 */
1656static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001658 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
Tejun Heo6183c002013-03-12 11:29:57 -07001660 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1661 return;
Tejun Heod302f012010-06-29 10:07:13 +02001662 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001663 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001664 list_del_init(&worker->entry);
1665}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001667static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001668{
1669 struct worker *worker;
1670
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001671 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001672 if (worker) {
1673 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001674 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001675 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001676 /* on creation a worker is in !idle && prep state */
1677 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001678 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001679 return worker;
1680}
1681
1682/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001683 * worker_attach_to_pool() - attach a worker to a pool
1684 * @worker: worker to be attached
1685 * @pool: the target pool
1686 *
1687 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1688 * cpu-binding of @worker are kept coordinated with the pool across
1689 * cpu-[un]hotplugs.
1690 */
1691static void worker_attach_to_pool(struct worker *worker,
1692 struct worker_pool *pool)
1693{
1694 mutex_lock(&pool->attach_mutex);
1695
1696 /*
1697 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1698 * online CPUs. It'll be re-applied when any of the CPUs come up.
1699 */
1700 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1701
1702 /*
1703 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1704 * stable across this function. See the comments above the
1705 * flag definition for details.
1706 */
1707 if (pool->flags & POOL_DISASSOCIATED)
1708 worker->flags |= WORKER_UNBOUND;
1709
1710 list_add_tail(&worker->node, &pool->workers);
1711
1712 mutex_unlock(&pool->attach_mutex);
1713}
1714
1715/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001716 * worker_detach_from_pool() - detach a worker from its pool
1717 * @worker: worker which is attached to its pool
1718 * @pool: the pool @worker is attached to
1719 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001720 * Undo the attaching which had been done in worker_attach_to_pool(). The
1721 * caller worker shouldn't access to the pool after detached except it has
1722 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001723 */
1724static void worker_detach_from_pool(struct worker *worker,
1725 struct worker_pool *pool)
1726{
1727 struct completion *detach_completion = NULL;
1728
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001729 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001730 list_del(&worker->node);
1731 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001732 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001733 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001734
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001735 /* clear leftover flags without pool->lock after it is detached */
1736 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1737
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001738 if (detach_completion)
1739 complete(detach_completion);
1740}
1741
1742/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001743 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001744 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001745 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001746 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001747 *
1748 * CONTEXT:
1749 * Might sleep. Does GFP_KERNEL allocations.
1750 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001751 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001752 * Pointer to the newly created worker.
1753 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001754static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001755{
Tejun Heoc34056a2010-06-29 10:07:11 +02001756 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001757 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001758 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001759
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001760 /* ID is needed to determine kthread name */
1761 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001762 if (id < 0)
1763 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001764
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001765 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001766 if (!worker)
1767 goto fail;
1768
Tejun Heobd7bdd42012-07-12 14:46:37 -07001769 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001770 worker->id = id;
1771
Tejun Heo29c91e92013-03-12 11:30:03 -07001772 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001773 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1774 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001775 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001776 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1777
Tejun Heof3f90ad2013-04-01 11:23:34 -07001778 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001779 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 if (IS_ERR(worker->task))
1781 goto fail;
1782
Oleg Nesterov91151222013-11-14 12:56:18 +01001783 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001784 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001785
Lai Jiangshanda028462014-05-20 17:46:31 +08001786 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001787 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001788
Lai Jiangshan051e1852014-07-22 13:03:02 +08001789 /* start the newly created worker */
1790 spin_lock_irq(&pool->lock);
1791 worker->pool->nr_workers++;
1792 worker_enter_idle(worker);
1793 wake_up_process(worker->task);
1794 spin_unlock_irq(&pool->lock);
1795
Tejun Heoc34056a2010-06-29 10:07:11 +02001796 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001797
Tejun Heoc34056a2010-06-29 10:07:11 +02001798fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001799 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001800 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 kfree(worker);
1802 return NULL;
1803}
1804
1805/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001806 * destroy_worker - destroy a workqueue worker
1807 * @worker: worker to be destroyed
1808 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001809 * Destroy @worker and adjust @pool stats accordingly. The worker should
1810 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001811 *
1812 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001813 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001814 */
1815static void destroy_worker(struct worker *worker)
1816{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001817 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001818
Tejun Heocd549682013-03-13 19:47:39 -07001819 lockdep_assert_held(&pool->lock);
1820
Tejun Heoc34056a2010-06-29 10:07:11 +02001821 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001822 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001823 WARN_ON(!list_empty(&worker->scheduled)) ||
1824 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001825 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001826
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001827 pool->nr_workers--;
1828 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001829
Tejun Heoc8e55f32010-06-29 10:07:12 +02001830 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001831 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001832 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001833}
1834
Tejun Heo63d95a92012-07-12 14:46:37 -07001835static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001836{
Tejun Heo63d95a92012-07-12 14:46:37 -07001837 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001838
Tejun Heod565ed62013-01-24 11:01:33 -08001839 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001840
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001841 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001842 struct worker *worker;
1843 unsigned long expires;
1844
1845 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001846 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001847 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1848
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001849 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001850 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001851 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001852 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001853
1854 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001855 }
1856
Tejun Heod565ed62013-01-24 11:01:33 -08001857 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001858}
1859
Tejun Heo493a1722013-03-12 11:29:59 -07001860static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001861{
Tejun Heo112202d2013-02-13 19:29:12 -08001862 struct pool_workqueue *pwq = get_work_pwq(work);
1863 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001864
Tejun Heo2e109a22013-03-13 19:47:40 -07001865 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001866
Tejun Heo493008a2013-03-12 11:30:03 -07001867 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001868 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001869
1870 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001871 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001872 /*
1873 * If @pwq is for an unbound wq, its base ref may be put at
1874 * any time due to an attribute change. Pin @pwq until the
1875 * rescuer is done with it.
1876 */
1877 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001878 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001879 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001880 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001881}
1882
Tejun Heo706026c2013-01-24 11:01:34 -08001883static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001884{
Tejun Heo63d95a92012-07-12 14:46:37 -07001885 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 struct work_struct *work;
1887
Tejun Heob2d82902014-12-08 12:39:16 -05001888 spin_lock_irq(&pool->lock);
1889 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001890
Tejun Heo63d95a92012-07-12 14:46:37 -07001891 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001892 /*
1893 * We've been trying to create a new worker but
1894 * haven't been successful. We might be hitting an
1895 * allocation deadlock. Send distress signals to
1896 * rescuers.
1897 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001898 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 send_mayday(work);
1900 }
1901
Tejun Heob2d82902014-12-08 12:39:16 -05001902 spin_unlock(&wq_mayday_lock);
1903 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001904
Tejun Heo63d95a92012-07-12 14:46:37 -07001905 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001906}
1907
1908/**
1909 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001910 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001912 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 * have at least one idle worker on return from this function. If
1914 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001915 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001916 * possible allocation deadlock.
1917 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001918 * On return, need_to_create_worker() is guaranteed to be %false and
1919 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 *
1921 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001922 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 * multiple times. Does GFP_KERNEL allocations. Called only from
1924 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 */
Tejun Heo29187a92015-01-16 14:21:16 -05001926static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001927__releases(&pool->lock)
1928__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001929{
Tejun Heoe22bee72010-06-29 10:07:14 +02001930restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001931 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001932
Tejun Heoe22bee72010-06-29 10:07:14 +02001933 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001935
1936 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001937 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001938 break;
1939
Lai Jiangshane212f362014-06-03 15:32:17 +08001940 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001941
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 break;
1944 }
1945
Tejun Heo63d95a92012-07-12 14:46:37 -07001946 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001947 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001948 /*
1949 * This is necessary even after a new worker was just successfully
1950 * created as @pool->lock was dropped and the new worker might have
1951 * already become busy.
1952 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001953 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001955}
1956
1957/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 * manage_workers - manage worker pool
1959 * @worker: self
1960 *
Tejun Heo706026c2013-01-24 11:01:34 -08001961 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001962 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001963 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 *
1965 * The caller can safely start processing works on false return. On
1966 * true return, it's guaranteed that need_to_create_worker() is false
1967 * and may_start_working() is true.
1968 *
1969 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001970 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 * multiple times. Does GFP_KERNEL allocations.
1972 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001973 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001974 * %false if the pool doesn't need management and the caller can safely
1975 * start processing works, %true if management function was performed and
1976 * the conditions that the caller verified before calling the function may
1977 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 */
1979static bool manage_workers(struct worker *worker)
1980{
Tejun Heo63d95a92012-07-12 14:46:37 -07001981 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001982
Tejun Heobc3a1af2013-03-13 19:47:39 -07001983 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001984 * Anyone who successfully grabs manager_arb wins the arbitration
1985 * and becomes the manager. mutex_trylock() on pool->manager_arb
1986 * failure while holding pool->lock reliably indicates that someone
1987 * else is managing the pool and the worker which failed trylock
1988 * can proceed to executing work items. This means that anyone
1989 * grabbing manager_arb is responsible for actually performing
1990 * manager duties. If manager_arb is grabbed and released without
1991 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001992 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001993 if (!mutex_trylock(&pool->manager_arb))
Tejun Heo29187a92015-01-16 14:21:16 -05001994 return false;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001995 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001996
Tejun Heo29187a92015-01-16 14:21:16 -05001997 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001998
Tejun Heo2607d7a2015-03-09 09:22:28 -04001999 pool->manager = NULL;
Tejun Heo34a06bd2013-03-12 11:30:00 -07002000 mutex_unlock(&pool->manager_arb);
Tejun Heo29187a92015-01-16 14:21:16 -05002001 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002002}
2003
Tejun Heoa62428c2010-06-29 10:07:10 +02002004/**
2005 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002006 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002007 * @work: work to process
2008 *
2009 * Process @work. This function contains all the logics necessary to
2010 * process a single work including synchronization against and
2011 * interaction with other workers on the same cpu, queueing and
2012 * flushing. As long as context requirement is met, any worker can
2013 * call this function to process a work.
2014 *
2015 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002016 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002017 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002018static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002019__releases(&pool->lock)
2020__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002021{
Tejun Heo112202d2013-02-13 19:29:12 -08002022 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002023 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002024 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002025 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002026 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002027#ifdef CONFIG_LOCKDEP
2028 /*
2029 * It is permissible to free the struct work_struct from
2030 * inside the function that is called from it, this we need to
2031 * take into account for lockdep too. To avoid bogus "held
2032 * lock freed" warnings as well as problems when looking into
2033 * work->lockdep_map, make a copy and use that here.
2034 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002035 struct lockdep_map lockdep_map;
2036
2037 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002038#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002039 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002040 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002041 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002042
Tejun Heo7e116292010-06-29 10:07:13 +02002043 /*
2044 * A single work shouldn't be executed concurrently by
2045 * multiple workers on a single cpu. Check whether anyone is
2046 * already processing the work. If so, defer the work to the
2047 * currently executing one.
2048 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002049 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002050 if (unlikely(collision)) {
2051 move_linked_works(work, &collision->scheduled, NULL);
2052 return;
2053 }
2054
Tejun Heo8930cab2012-08-03 10:30:45 -07002055 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002056 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002057 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002058 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002059 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002060 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002061 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002062
Tejun Heoa62428c2010-06-29 10:07:10 +02002063 list_del_init(&work->entry);
2064
Tejun Heo649027d2010-06-29 10:07:14 +02002065 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002066 * CPU intensive works don't participate in concurrency management.
2067 * They're the scheduler's responsibility. This takes @worker out
2068 * of concurrency management and the next code block will chain
2069 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002070 */
2071 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002072 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002073
Tejun Heo974271c42012-07-12 14:46:37 -07002074 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002075 * Wake up another worker if necessary. The condition is always
2076 * false for normal per-cpu workers since nr_running would always
2077 * be >= 1 at this point. This is used to chain execution of the
2078 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002079 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c42012-07-12 14:46:37 -07002080 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002081 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002082 wake_up_worker(pool);
Tejun Heo974271c42012-07-12 14:46:37 -07002083
Tejun Heo8930cab2012-08-03 10:30:45 -07002084 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002085 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002086 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002087 * PENDING and queued state changes happen together while IRQ is
2088 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002089 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002090 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002091
Tejun Heod565ed62013-01-24 11:01:33 -08002092 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002093
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002094 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002095 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002096 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002097 * Strictly speaking we should mark the invariant state without holding
2098 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002099 *
2100 * However, that would result in:
2101 *
2102 * A(W1)
2103 * WFC(C)
2104 * A(W1)
2105 * C(C)
2106 *
2107 * Which would create W1->C->W1 dependencies, even though there is no
2108 * actual deadlock possible. There are two solutions, using a
2109 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002110 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002111 * these locks.
2112 *
2113 * AFAICT there is no possible deadlock scenario between the
2114 * flush_work() and complete() primitives (except for single-threaded
2115 * workqueues), so hiding them isn't a problem.
2116 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002117 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002118 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002119 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002120 /*
2121 * While we must be careful to not use "work" after this, the trace
2122 * point will only record its address.
2123 */
2124 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002125 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002126 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002127
2128 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002129 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2130 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002131 current->comm, preempt_count(), task_pid_nr(current),
2132 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002133 debug_show_held_locks(current);
2134 dump_stack();
2135 }
2136
Tejun Heob22ce272013-08-28 17:33:37 -04002137 /*
2138 * The following prevents a kworker from hogging CPU on !PREEMPT
2139 * kernels, where a requeueing work item waiting for something to
2140 * happen could deadlock with stop_machine as such work item could
2141 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002142 * stop_machine. At the same time, report a quiescent RCU state so
2143 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002144 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002145 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002146
Tejun Heod565ed62013-01-24 11:01:33 -08002147 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002148
Tejun Heofb0e7be2010-06-29 10:07:15 +02002149 /* clear cpu intensive status */
2150 if (unlikely(cpu_intensive))
2151 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2152
Tejun Heoa62428c2010-06-29 10:07:10 +02002153 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002154 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002155 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002156 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002157 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002158 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002159 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002160}
2161
Tejun Heoaffee4b2010-06-29 10:07:12 +02002162/**
2163 * process_scheduled_works - process scheduled works
2164 * @worker: self
2165 *
2166 * Process all scheduled works. Please note that the scheduled list
2167 * may change while processing a work, so this function repeatedly
2168 * fetches a work from the top and executes it.
2169 *
2170 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002171 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002172 * multiple times.
2173 */
2174static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002176 while (!list_empty(&worker->scheduled)) {
2177 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002179 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181}
2182
Tejun Heo4690c4a2010-06-29 10:07:10 +02002183/**
2184 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002185 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002186 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002187 * The worker thread function. All workers belong to a worker_pool -
2188 * either a per-cpu one or dynamic unbound one. These workers process all
2189 * work items regardless of their specific target workqueue. The only
2190 * exception is work items which belong to workqueues with a rescuer which
2191 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002192 *
2193 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002194 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002195static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196{
Tejun Heoc34056a2010-06-29 10:07:11 +02002197 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002198 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199
Tejun Heoe22bee72010-06-29 10:07:14 +02002200 /* tell the scheduler that this is a workqueue worker */
2201 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002202woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002203 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002204
Tejun Heoa9ab7752013-03-19 13:45:21 -07002205 /* am I supposed to die? */
2206 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002207 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002208 WARN_ON_ONCE(!list_empty(&worker->entry));
2209 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002210
2211 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002212 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002213 worker_detach_from_pool(worker, pool);
2214 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002215 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002217
Tejun Heoc8e55f32010-06-29 10:07:12 +02002218 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002219recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002220 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002221 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002222 goto sleep;
2223
2224 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002225 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002226 goto recheck;
2227
Tejun Heoc8e55f32010-06-29 10:07:12 +02002228 /*
2229 * ->scheduled list can only be filled while a worker is
2230 * preparing to process a work or actually processing it.
2231 * Make sure nobody diddled with it while I was sleeping.
2232 */
Tejun Heo6183c002013-03-12 11:29:57 -07002233 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002234
Tejun Heoe22bee72010-06-29 10:07:14 +02002235 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002236 * Finish PREP stage. We're guaranteed to have at least one idle
2237 * worker or that someone else has already assumed the manager
2238 * role. This is where @worker starts participating in concurrency
2239 * management if applicable and concurrency management is restored
2240 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002241 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002242 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002243
2244 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002246 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002247 struct work_struct, entry);
2248
Tejun Heo82607adc2015-12-08 11:28:04 -05002249 pool->watchdog_ts = jiffies;
2250
Tejun Heoc8e55f32010-06-29 10:07:12 +02002251 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2252 /* optimization path, not strictly necessary */
2253 process_one_work(worker, work);
2254 if (unlikely(!list_empty(&worker->scheduled)))
2255 process_scheduled_works(worker);
2256 } else {
2257 move_linked_works(work, &worker->scheduled, NULL);
2258 process_scheduled_works(worker);
2259 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002260 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002261
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002262 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002263sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002264 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002265 * pool->lock is held and there's no work to process and no need to
2266 * manage, sleep. Workers are woken up only while holding
2267 * pool->lock or from local cpu, so setting the current state
2268 * before releasing pool->lock is enough to prevent losing any
2269 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002270 */
2271 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002272 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002273 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002274 schedule();
2275 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276}
2277
Tejun Heoe22bee72010-06-29 10:07:14 +02002278/**
2279 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002280 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002281 *
2282 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002283 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002284 *
Tejun Heo706026c2013-01-24 11:01:34 -08002285 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002286 * worker which uses GFP_KERNEL allocation which has slight chance of
2287 * developing into deadlock if some works currently on the same queue
2288 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2289 * the problem rescuer solves.
2290 *
Tejun Heo706026c2013-01-24 11:01:34 -08002291 * When such condition is possible, the pool summons rescuers of all
2292 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002293 * those works so that forward progress can be guaranteed.
2294 *
2295 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002296 *
2297 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002298 */
Tejun Heo111c2252013-01-17 17:16:24 -08002299static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002300{
Tejun Heo111c2252013-01-17 17:16:24 -08002301 struct worker *rescuer = __rescuer;
2302 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002303 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002304 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002305
2306 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002307
2308 /*
2309 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2310 * doesn't participate in concurrency management.
2311 */
2312 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002313repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002314 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002315
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002316 /*
2317 * By the time the rescuer is requested to stop, the workqueue
2318 * shouldn't have any work pending, but @wq->maydays may still have
2319 * pwq(s) queued. This can happen by non-rescuer workers consuming
2320 * all the work items before the rescuer got to them. Go through
2321 * @wq->maydays processing before acting on should_stop so that the
2322 * list is always empty on exit.
2323 */
2324 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002325
Tejun Heo493a1722013-03-12 11:29:59 -07002326 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002327 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002328
2329 while (!list_empty(&wq->maydays)) {
2330 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2331 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002332 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002333 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002334 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002335
2336 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002337 list_del_init(&pwq->mayday_node);
2338
Tejun Heo2e109a22013-03-13 19:47:40 -07002339 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002340
Lai Jiangshan51697d392014-05-20 17:46:36 +08002341 worker_attach_to_pool(rescuer, pool);
2342
2343 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002344 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002345
2346 /*
2347 * Slurp in all works issued via this workqueue and
2348 * process'em.
2349 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002350 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002351 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2352 if (get_work_pwq(work) == pwq) {
2353 if (first)
2354 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002355 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002356 }
2357 first = false;
2358 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002359
NeilBrown008847f2014-12-08 12:39:16 -05002360 if (!list_empty(scheduled)) {
2361 process_scheduled_works(rescuer);
2362
2363 /*
2364 * The above execution of rescued work items could
2365 * have created more to rescue through
2366 * pwq_activate_first_delayed() or chained
2367 * queueing. Let's put @pwq back on mayday list so
2368 * that such back-to-back work items, which may be
2369 * being used to relieve memory pressure, don't
2370 * incur MAYDAY_INTERVAL delay inbetween.
2371 */
2372 if (need_to_create_worker(pool)) {
2373 spin_lock(&wq_mayday_lock);
2374 get_pwq(pwq);
2375 list_move_tail(&pwq->mayday_node, &wq->maydays);
2376 spin_unlock(&wq_mayday_lock);
2377 }
2378 }
Tejun Heo75769582011-02-14 14:04:46 +01002379
2380 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002381 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002382 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002383 */
2384 put_pwq(pwq);
2385
2386 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002387 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002388 * regular worker; otherwise, we end up with 0 concurrency
2389 * and stalling the execution.
2390 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002391 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002392 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002393
Lai Jiangshanb3104102013-02-19 12:17:02 -08002394 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002395 spin_unlock_irq(&pool->lock);
2396
2397 worker_detach_from_pool(rescuer, pool);
2398
2399 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002400 }
2401
Tejun Heo2e109a22013-03-13 19:47:40 -07002402 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002403
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002404 if (should_stop) {
2405 __set_current_state(TASK_RUNNING);
2406 rescuer->task->flags &= ~PF_WQ_WORKER;
2407 return 0;
2408 }
2409
Tejun Heo111c2252013-01-17 17:16:24 -08002410 /* rescuers should never participate in concurrency management */
2411 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002412 schedule();
2413 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414}
2415
Tejun Heofca839c2015-12-07 10:58:57 -05002416/**
2417 * check_flush_dependency - check for flush dependency sanity
2418 * @target_wq: workqueue being flushed
2419 * @target_work: work item being flushed (NULL for workqueue flushes)
2420 *
2421 * %current is trying to flush the whole @target_wq or @target_work on it.
2422 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2423 * reclaiming memory or running on a workqueue which doesn't have
2424 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2425 * a deadlock.
2426 */
2427static void check_flush_dependency(struct workqueue_struct *target_wq,
2428 struct work_struct *target_work)
2429{
2430 work_func_t target_func = target_work ? target_work->func : NULL;
2431 struct worker *worker;
2432
2433 if (target_wq->flags & WQ_MEM_RECLAIM)
2434 return;
2435
2436 worker = current_wq_worker();
2437
2438 WARN_ONCE(current->flags & PF_MEMALLOC,
2439 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2440 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002441 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2442 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002443 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2444 worker->current_pwq->wq->name, worker->current_func,
2445 target_wq->name, target_func);
2446}
2447
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002448struct wq_barrier {
2449 struct work_struct work;
2450 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002451 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002452};
2453
2454static void wq_barrier_func(struct work_struct *work)
2455{
2456 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2457 complete(&barr->done);
2458}
2459
Tejun Heo4690c4a2010-06-29 10:07:10 +02002460/**
2461 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002462 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002463 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002464 * @target: target work to attach @barr to
2465 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002466 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002467 * @barr is linked to @target such that @barr is completed only after
2468 * @target finishes execution. Please note that the ordering
2469 * guarantee is observed only with respect to @target and on the local
2470 * cpu.
2471 *
2472 * Currently, a queued barrier can't be canceled. This is because
2473 * try_to_grab_pending() can't determine whether the work to be
2474 * grabbed is at the head of the queue and thus can't clear LINKED
2475 * flag of the previous work while there must be a valid next work
2476 * after a work with LINKED flag set.
2477 *
2478 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002479 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002480 *
2481 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002482 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002483 */
Tejun Heo112202d2013-02-13 19:29:12 -08002484static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002485 struct wq_barrier *barr,
2486 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002487{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002488 struct list_head *head;
2489 unsigned int linked = 0;
2490
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002491 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002492 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002493 * as we know for sure that this will not trigger any of the
2494 * checks and call back into the fixup functions where we
2495 * might deadlock.
2496 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002497 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002498 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002499
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002500 init_completion_map(&barr->done, &target->lockdep_map);
2501
Tejun Heo2607d7a2015-03-09 09:22:28 -04002502 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002503
Tejun Heoaffee4b2010-06-29 10:07:12 +02002504 /*
2505 * If @target is currently being executed, schedule the
2506 * barrier to the worker; otherwise, put it after @target.
2507 */
2508 if (worker)
2509 head = worker->scheduled.next;
2510 else {
2511 unsigned long *bits = work_data_bits(target);
2512
2513 head = target->entry.next;
2514 /* there can already be other linked works, inherit and set */
2515 linked = *bits & WORK_STRUCT_LINKED;
2516 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2517 }
2518
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002519 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002520 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002521 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002522}
2523
Tejun Heo73f53c42010-06-29 10:07:11 +02002524/**
Tejun Heo112202d2013-02-13 19:29:12 -08002525 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002526 * @wq: workqueue being flushed
2527 * @flush_color: new flush color, < 0 for no-op
2528 * @work_color: new work color, < 0 for no-op
2529 *
Tejun Heo112202d2013-02-13 19:29:12 -08002530 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002531 *
Tejun Heo112202d2013-02-13 19:29:12 -08002532 * If @flush_color is non-negative, flush_color on all pwqs should be
2533 * -1. If no pwq has in-flight commands at the specified color, all
2534 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2535 * has in flight commands, its pwq->flush_color is set to
2536 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002537 * wakeup logic is armed and %true is returned.
2538 *
2539 * The caller should have initialized @wq->first_flusher prior to
2540 * calling this function with non-negative @flush_color. If
2541 * @flush_color is negative, no flush color update is done and %false
2542 * is returned.
2543 *
Tejun Heo112202d2013-02-13 19:29:12 -08002544 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002545 * work_color which is previous to @work_color and all will be
2546 * advanced to @work_color.
2547 *
2548 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002549 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002550 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002551 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002552 * %true if @flush_color >= 0 and there's something to flush. %false
2553 * otherwise.
2554 */
Tejun Heo112202d2013-02-13 19:29:12 -08002555static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002556 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557{
Tejun Heo73f53c42010-06-29 10:07:11 +02002558 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002559 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002560
Tejun Heo73f53c42010-06-29 10:07:11 +02002561 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002562 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002563 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002564 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002565
Tejun Heo49e3cf42013-03-12 11:29:58 -07002566 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002567 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002568
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002569 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002570
2571 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002572 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002573
Tejun Heo112202d2013-02-13 19:29:12 -08002574 if (pwq->nr_in_flight[flush_color]) {
2575 pwq->flush_color = flush_color;
2576 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002577 wait = true;
2578 }
2579 }
2580
2581 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002582 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002583 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002584 }
2585
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002586 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002587 }
2588
Tejun Heo112202d2013-02-13 19:29:12 -08002589 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002590 complete(&wq->first_flusher->done);
2591
2592 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593}
2594
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002595/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002597 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002599 * This function sleeps until all work items which were queued on entry
2600 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002602void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603{
Tejun Heo73f53c42010-06-29 10:07:11 +02002604 struct wq_flusher this_flusher = {
2605 .list = LIST_HEAD_INIT(this_flusher.list),
2606 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002607 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002608 };
2609 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002610
Tejun Heo3347fa02016-09-16 15:49:32 -04002611 if (WARN_ON(!wq_online))
2612 return;
2613
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002614 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002615
2616 /*
2617 * Start-to-wait phase
2618 */
2619 next_color = work_next_color(wq->work_color);
2620
2621 if (next_color != wq->flush_color) {
2622 /*
2623 * Color space is not full. The current work_color
2624 * becomes our flush_color and work_color is advanced
2625 * by one.
2626 */
Tejun Heo6183c002013-03-12 11:29:57 -07002627 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002628 this_flusher.flush_color = wq->work_color;
2629 wq->work_color = next_color;
2630
2631 if (!wq->first_flusher) {
2632 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002633 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002634
2635 wq->first_flusher = &this_flusher;
2636
Tejun Heo112202d2013-02-13 19:29:12 -08002637 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002638 wq->work_color)) {
2639 /* nothing to flush, done */
2640 wq->flush_color = next_color;
2641 wq->first_flusher = NULL;
2642 goto out_unlock;
2643 }
2644 } else {
2645 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002646 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002647 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002648 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002649 }
2650 } else {
2651 /*
2652 * Oops, color space is full, wait on overflow queue.
2653 * The next flush completion will assign us
2654 * flush_color and transfer to flusher_queue.
2655 */
2656 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2657 }
2658
Tejun Heofca839c2015-12-07 10:58:57 -05002659 check_flush_dependency(wq, NULL);
2660
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002661 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002662
2663 wait_for_completion(&this_flusher.done);
2664
2665 /*
2666 * Wake-up-and-cascade phase
2667 *
2668 * First flushers are responsible for cascading flushes and
2669 * handling overflow. Non-first flushers can simply return.
2670 */
2671 if (wq->first_flusher != &this_flusher)
2672 return;
2673
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002674 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002675
Tejun Heo4ce48b32010-07-02 10:03:51 +02002676 /* we might have raced, check again with mutex held */
2677 if (wq->first_flusher != &this_flusher)
2678 goto out_unlock;
2679
Tejun Heo73f53c42010-06-29 10:07:11 +02002680 wq->first_flusher = NULL;
2681
Tejun Heo6183c002013-03-12 11:29:57 -07002682 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2683 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002684
2685 while (true) {
2686 struct wq_flusher *next, *tmp;
2687
2688 /* complete all the flushers sharing the current flush color */
2689 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2690 if (next->flush_color != wq->flush_color)
2691 break;
2692 list_del_init(&next->list);
2693 complete(&next->done);
2694 }
2695
Tejun Heo6183c002013-03-12 11:29:57 -07002696 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2697 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002698
2699 /* this flush_color is finished, advance by one */
2700 wq->flush_color = work_next_color(wq->flush_color);
2701
2702 /* one color has been freed, handle overflow queue */
2703 if (!list_empty(&wq->flusher_overflow)) {
2704 /*
2705 * Assign the same color to all overflowed
2706 * flushers, advance work_color and append to
2707 * flusher_queue. This is the start-to-wait
2708 * phase for these overflowed flushers.
2709 */
2710 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2711 tmp->flush_color = wq->work_color;
2712
2713 wq->work_color = work_next_color(wq->work_color);
2714
2715 list_splice_tail_init(&wq->flusher_overflow,
2716 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002717 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002718 }
2719
2720 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002721 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002722 break;
2723 }
2724
2725 /*
2726 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002727 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002728 */
Tejun Heo6183c002013-03-12 11:29:57 -07002729 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2730 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002731
2732 list_del_init(&next->list);
2733 wq->first_flusher = next;
2734
Tejun Heo112202d2013-02-13 19:29:12 -08002735 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002736 break;
2737
2738 /*
2739 * Meh... this color is already done, clear first
2740 * flusher and repeat cascading.
2741 */
2742 wq->first_flusher = NULL;
2743 }
2744
2745out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002746 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002748EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002750/**
2751 * drain_workqueue - drain a workqueue
2752 * @wq: workqueue to drain
2753 *
2754 * Wait until the workqueue becomes empty. While draining is in progress,
2755 * only chain queueing is allowed. IOW, only currently pending or running
2756 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002757 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002758 * by the depth of chaining and should be relatively short. Whine if it
2759 * takes too long.
2760 */
2761void drain_workqueue(struct workqueue_struct *wq)
2762{
2763 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002764 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002765
2766 /*
2767 * __queue_work() needs to test whether there are drainers, is much
2768 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002769 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002770 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002771 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002772 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002773 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002774 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002775reflush:
2776 flush_workqueue(wq);
2777
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002778 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002779
Tejun Heo49e3cf42013-03-12 11:29:58 -07002780 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002781 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002782
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002783 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002784 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002785 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002786
2787 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002788 continue;
2789
2790 if (++flush_cnt == 10 ||
2791 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002792 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002793 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002794
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002795 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002796 goto reflush;
2797 }
2798
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002799 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002800 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002801 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002802}
2803EXPORT_SYMBOL_GPL(drain_workqueue);
2804
Tejun Heo606a5022012-08-20 14:51:23 -07002805static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002806{
2807 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002808 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002809 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002810
2811 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002812
Tejun Heofa1b54e2013-03-12 11:30:00 -07002813 local_irq_disable();
2814 pool = get_work_pool(work);
2815 if (!pool) {
2816 local_irq_enable();
2817 return false;
2818 }
2819
2820 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002821 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002822 pwq = get_work_pwq(work);
2823 if (pwq) {
2824 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002825 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002826 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002827 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002828 if (!worker)
2829 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002830 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002831 }
Tejun Heobaf59022010-09-16 10:42:16 +02002832
Tejun Heofca839c2015-12-07 10:58:57 -05002833 check_flush_dependency(pwq->wq, work);
2834
Tejun Heo112202d2013-02-13 19:29:12 -08002835 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002836 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002837
Tejun Heoe159489b2011-01-09 23:32:15 +01002838 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002839 * Force a lock recursion deadlock when using flush_work() inside a
2840 * single-threaded or rescuer equipped workqueue.
2841 *
2842 * For single threaded workqueues the deadlock happens when the work
2843 * is after the work issuing the flush_work(). For rescuer equipped
2844 * workqueues the deadlock happens when the rescuer stalls, blocking
2845 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002846 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002847 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002848 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002849 lock_map_release(&pwq->wq->lockdep_map);
2850 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002851
Tejun Heobaf59022010-09-16 10:42:16 +02002852 return true;
2853already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002854 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002855 return false;
2856}
2857
Oleg Nesterovdb700892008-07-25 01:47:49 -07002858/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002859 * flush_work - wait for a work to finish executing the last queueing instance
2860 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002861 *
Tejun Heo606a5022012-08-20 14:51:23 -07002862 * Wait until @work has finished execution. @work is guaranteed to be idle
2863 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002864 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002865 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002866 * %true if flush_work() waited for the work to finish execution,
2867 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002868 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002869bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002870{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002871 struct wq_barrier barr;
2872
Tejun Heo3347fa02016-09-16 15:49:32 -04002873 if (WARN_ON(!wq_online))
2874 return false;
2875
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002876 if (start_flush_work(work, &barr)) {
2877 wait_for_completion(&barr.done);
2878 destroy_work_on_stack(&barr.work);
2879 return true;
2880 } else {
2881 return false;
2882 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002883}
2884EXPORT_SYMBOL_GPL(flush_work);
2885
Tejun Heo8603e1b32015-03-05 08:04:13 -05002886struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002887 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002888 struct work_struct *work;
2889};
2890
Ingo Molnarac6424b2017-06-20 12:06:13 +02002891static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002892{
2893 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2894
2895 if (cwait->work != key)
2896 return 0;
2897 return autoremove_wake_function(wait, mode, sync, key);
2898}
2899
Tejun Heo36e227d2012-08-03 10:30:46 -07002900static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002901{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002902 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002903 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002904 int ret;
2905
2906 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002907 ret = try_to_grab_pending(work, is_dwork, &flags);
2908 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002909 * If someone else is already canceling, wait for it to
2910 * finish. flush_work() doesn't work for PREEMPT_NONE
2911 * because we may get scheduled between @work's completion
2912 * and the other canceling task resuming and clearing
2913 * CANCELING - flush_work() will return false immediately
2914 * as @work is no longer busy, try_to_grab_pending() will
2915 * return -ENOENT as @work is still being canceled and the
2916 * other canceling task won't be able to clear CANCELING as
2917 * we're hogging the CPU.
2918 *
2919 * Let's wait for completion using a waitqueue. As this
2920 * may lead to the thundering herd problem, use a custom
2921 * wake function which matches @work along with exclusive
2922 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002923 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002924 if (unlikely(ret == -ENOENT)) {
2925 struct cwt_wait cwait;
2926
2927 init_wait(&cwait.wait);
2928 cwait.wait.func = cwt_wakefn;
2929 cwait.work = work;
2930
2931 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2932 TASK_UNINTERRUPTIBLE);
2933 if (work_is_canceling(work))
2934 schedule();
2935 finish_wait(&cancel_waitq, &cwait.wait);
2936 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002937 } while (unlikely(ret < 0));
2938
Tejun Heobbb68df2012-08-03 10:30:46 -07002939 /* tell other tasks trying to grab @work to back off */
2940 mark_work_canceling(work);
2941 local_irq_restore(flags);
2942
Tejun Heo3347fa02016-09-16 15:49:32 -04002943 /*
2944 * This allows canceling during early boot. We know that @work
2945 * isn't executing.
2946 */
2947 if (wq_online)
2948 flush_work(work);
2949
Tejun Heo7a22ad72010-06-29 10:07:13 +02002950 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002951
2952 /*
2953 * Paired with prepare_to_wait() above so that either
2954 * waitqueue_active() is visible here or !work_is_canceling() is
2955 * visible there.
2956 */
2957 smp_mb();
2958 if (waitqueue_active(&cancel_waitq))
2959 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2960
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002961 return ret;
2962}
2963
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002964/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002965 * cancel_work_sync - cancel a work and wait for it to finish
2966 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002967 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002968 * Cancel @work and wait for its execution to finish. This function
2969 * can be used even if the work re-queues itself or migrates to
2970 * another workqueue. On return from this function, @work is
2971 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002972 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002973 * cancel_work_sync(&delayed_work->work) must not be used for
2974 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002975 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002976 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002978 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002979 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002980 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002981 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002982bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002983{
Tejun Heo36e227d2012-08-03 10:30:46 -07002984 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002985}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002986EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002987
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002988/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002989 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2990 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002991 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * Delayed timer is cancelled and the pending work is queued for
2993 * immediate execution. Like flush_work(), this function only
2994 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002995 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002996 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002997 * %true if flush_work() waited for the work to finish execution,
2998 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002999 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003000bool flush_delayed_work(struct delayed_work *dwork)
3001{
Tejun Heo8930cab2012-08-03 10:30:45 -07003002 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003003 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003004 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003005 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003006 return flush_work(&dwork->work);
3007}
3008EXPORT_SYMBOL(flush_delayed_work);
3009
Jens Axboef72b8792016-08-24 15:51:50 -06003010static bool __cancel_work(struct work_struct *work, bool is_dwork)
3011{
3012 unsigned long flags;
3013 int ret;
3014
3015 do {
3016 ret = try_to_grab_pending(work, is_dwork, &flags);
3017 } while (unlikely(ret == -EAGAIN));
3018
3019 if (unlikely(ret < 0))
3020 return false;
3021
3022 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3023 local_irq_restore(flags);
3024 return ret;
3025}
3026
3027/*
3028 * See cancel_delayed_work()
3029 */
3030bool cancel_work(struct work_struct *work)
3031{
3032 return __cancel_work(work, false);
3033}
3034
Tejun Heo401a8d02010-09-16 10:36:00 +02003035/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003036 * cancel_delayed_work - cancel a delayed work
3037 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003038 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003039 * Kill off a pending delayed_work.
3040 *
3041 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3042 * pending.
3043 *
3044 * Note:
3045 * The work callback function may still be running on return, unless
3046 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3047 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003048 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003049 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003050 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003051bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003052{
Jens Axboef72b8792016-08-24 15:51:50 -06003053 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003054}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003055EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003056
3057/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003058 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3059 * @dwork: the delayed work cancel
3060 *
3061 * This is cancel_work_sync() for delayed works.
3062 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003063 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003064 * %true if @dwork was pending, %false otherwise.
3065 */
3066bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003067{
Tejun Heo36e227d2012-08-03 10:30:46 -07003068 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003069}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003070EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003072/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003073 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003074 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003075 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003076 * schedule_on_each_cpu() executes @func on each online CPU using the
3077 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003078 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003079 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003080 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003081 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003082 */
David Howells65f27f32006-11-22 14:55:48 +00003083int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003084{
3085 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003086 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003087
Andrew Mortonb6136772006-06-25 05:47:49 -07003088 works = alloc_percpu(struct work_struct);
3089 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003090 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003091
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003092 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003093
Christoph Lameter15316ba82006-01-08 01:00:43 -08003094 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003095 struct work_struct *work = per_cpu_ptr(works, cpu);
3096
3097 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003098 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003099 }
Tejun Heo93981802009-11-17 14:06:20 -08003100
3101 for_each_online_cpu(cpu)
3102 flush_work(per_cpu_ptr(works, cpu));
3103
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003104 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003105 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003106 return 0;
3107}
3108
Alan Sterneef6a7d2010-02-12 17:39:21 +09003109/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003110 * execute_in_process_context - reliably execute the routine with user context
3111 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003112 * @ew: guaranteed storage for the execute work structure (must
3113 * be available when the work executes)
3114 *
3115 * Executes the function immediately if process context is available,
3116 * otherwise schedules the function for delayed execution.
3117 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003118 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003119 * 1 - function was scheduled for execution
3120 */
David Howells65f27f32006-11-22 14:55:48 +00003121int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003122{
3123 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003124 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003125 return 0;
3126 }
3127
David Howells65f27f32006-11-22 14:55:48 +00003128 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003129 schedule_work(&ew->work);
3130
3131 return 1;
3132}
3133EXPORT_SYMBOL_GPL(execute_in_process_context);
3134
Tejun Heo7a4e3442013-03-12 11:30:00 -07003135/**
3136 * free_workqueue_attrs - free a workqueue_attrs
3137 * @attrs: workqueue_attrs to free
3138 *
3139 * Undo alloc_workqueue_attrs().
3140 */
3141void free_workqueue_attrs(struct workqueue_attrs *attrs)
3142{
3143 if (attrs) {
3144 free_cpumask_var(attrs->cpumask);
3145 kfree(attrs);
3146 }
3147}
3148
3149/**
3150 * alloc_workqueue_attrs - allocate a workqueue_attrs
3151 * @gfp_mask: allocation mask to use
3152 *
3153 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003154 * return it.
3155 *
3156 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003157 */
3158struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3159{
3160 struct workqueue_attrs *attrs;
3161
3162 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3163 if (!attrs)
3164 goto fail;
3165 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3166 goto fail;
3167
Tejun Heo13e2e552013-04-01 11:23:31 -07003168 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003169 return attrs;
3170fail:
3171 free_workqueue_attrs(attrs);
3172 return NULL;
3173}
3174
Tejun Heo29c91e92013-03-12 11:30:03 -07003175static void copy_workqueue_attrs(struct workqueue_attrs *to,
3176 const struct workqueue_attrs *from)
3177{
3178 to->nice = from->nice;
3179 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003180 /*
3181 * Unlike hash and equality test, this function doesn't ignore
3182 * ->no_numa as it is used for both pool and wq attrs. Instead,
3183 * get_unbound_pool() explicitly clears ->no_numa after copying.
3184 */
3185 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003186}
3187
Tejun Heo29c91e92013-03-12 11:30:03 -07003188/* hash value of the content of @attr */
3189static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3190{
3191 u32 hash = 0;
3192
3193 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003194 hash = jhash(cpumask_bits(attrs->cpumask),
3195 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003196 return hash;
3197}
3198
3199/* content equality test */
3200static bool wqattrs_equal(const struct workqueue_attrs *a,
3201 const struct workqueue_attrs *b)
3202{
3203 if (a->nice != b->nice)
3204 return false;
3205 if (!cpumask_equal(a->cpumask, b->cpumask))
3206 return false;
3207 return true;
3208}
3209
Tejun Heo7a4e3442013-03-12 11:30:00 -07003210/**
3211 * init_worker_pool - initialize a newly zalloc'd worker_pool
3212 * @pool: worker_pool to initialize
3213 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303214 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003215 *
3216 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003217 * inside @pool proper are initialized and put_unbound_pool() can be called
3218 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003219 */
3220static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003221{
3222 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003223 pool->id = -1;
3224 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003225 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003226 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003227 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003228 INIT_LIST_HEAD(&pool->worklist);
3229 INIT_LIST_HEAD(&pool->idle_list);
3230 hash_init(pool->busy_hash);
3231
Geliang Tangc30fb262017-02-26 08:58:21 +08003232 setup_deferrable_timer(&pool->idle_timer, idle_worker_timeout,
3233 (unsigned long)pool);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003234
3235 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3236 (unsigned long)pool);
3237
3238 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003239 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003240 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003241
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003242 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003243 INIT_HLIST_NODE(&pool->hash_node);
3244 pool->refcnt = 1;
3245
3246 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003247 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3248 if (!pool->attrs)
3249 return -ENOMEM;
3250 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003251}
3252
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003253static void rcu_free_wq(struct rcu_head *rcu)
3254{
3255 struct workqueue_struct *wq =
3256 container_of(rcu, struct workqueue_struct, rcu);
3257
3258 if (!(wq->flags & WQ_UNBOUND))
3259 free_percpu(wq->cpu_pwqs);
3260 else
3261 free_workqueue_attrs(wq->unbound_attrs);
3262
3263 kfree(wq->rescuer);
3264 kfree(wq);
3265}
3266
Tejun Heo29c91e92013-03-12 11:30:03 -07003267static void rcu_free_pool(struct rcu_head *rcu)
3268{
3269 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3270
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003271 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003272 free_workqueue_attrs(pool->attrs);
3273 kfree(pool);
3274}
3275
3276/**
3277 * put_unbound_pool - put a worker_pool
3278 * @pool: worker_pool to put
3279 *
3280 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003281 * safe manner. get_unbound_pool() calls this function on its failure path
3282 * and this function should be able to release pools which went through,
3283 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003284 *
3285 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003286 */
3287static void put_unbound_pool(struct worker_pool *pool)
3288{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003289 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003290 struct worker *worker;
3291
Tejun Heoa892cac2013-04-01 11:23:32 -07003292 lockdep_assert_held(&wq_pool_mutex);
3293
3294 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003295 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003296
3297 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003298 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003299 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003300 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003301
3302 /* release id and unhash */
3303 if (pool->id >= 0)
3304 idr_remove(&worker_pool_idr, pool->id);
3305 hash_del(&pool->hash_node);
3306
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003307 /*
3308 * Become the manager and destroy all workers. Grabbing
3309 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003310 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003311 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003312 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003313
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003314 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003315 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003316 destroy_worker(worker);
3317 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003318 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003319
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003320 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003321 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003322 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003323 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003324
3325 if (pool->detach_completion)
3326 wait_for_completion(pool->detach_completion);
3327
Tejun Heo29c91e92013-03-12 11:30:03 -07003328 mutex_unlock(&pool->manager_arb);
3329
3330 /* shut down the timers */
3331 del_timer_sync(&pool->idle_timer);
3332 del_timer_sync(&pool->mayday_timer);
3333
3334 /* sched-RCU protected to allow dereferences from get_work_pool() */
3335 call_rcu_sched(&pool->rcu, rcu_free_pool);
3336}
3337
3338/**
3339 * get_unbound_pool - get a worker_pool with the specified attributes
3340 * @attrs: the attributes of the worker_pool to get
3341 *
3342 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3343 * reference count and return it. If there already is a matching
3344 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003345 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003346 *
3347 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003348 *
3349 * Return: On success, a worker_pool with the same attributes as @attrs.
3350 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003351 */
3352static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3353{
Tejun Heo29c91e92013-03-12 11:30:03 -07003354 u32 hash = wqattrs_hash(attrs);
3355 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003356 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003357 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003358
Tejun Heoa892cac2013-04-01 11:23:32 -07003359 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003360
3361 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003362 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3363 if (wqattrs_equal(pool->attrs, attrs)) {
3364 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003365 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003366 }
3367 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003368
Xunlei Pange22735842015-10-09 11:53:12 +08003369 /* if cpumask is contained inside a NUMA node, we belong to that node */
3370 if (wq_numa_enabled) {
3371 for_each_node(node) {
3372 if (cpumask_subset(attrs->cpumask,
3373 wq_numa_possible_cpumask[node])) {
3374 target_node = node;
3375 break;
3376 }
3377 }
3378 }
3379
Tejun Heo29c91e92013-03-12 11:30:03 -07003380 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003381 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003382 if (!pool || init_worker_pool(pool) < 0)
3383 goto fail;
3384
Tejun Heo8864b4e2013-03-12 11:30:04 -07003385 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003387 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003388
Shaohua Li2865a8f2013-08-01 09:56:36 +08003389 /*
3390 * no_numa isn't a worker_pool attribute, always clear it. See
3391 * 'struct workqueue_attrs' comments for detail.
3392 */
3393 pool->attrs->no_numa = false;
3394
Tejun Heo29c91e92013-03-12 11:30:03 -07003395 if (worker_pool_assign_id(pool) < 0)
3396 goto fail;
3397
3398 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003399 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003400 goto fail;
3401
Tejun Heo29c91e92013-03-12 11:30:03 -07003402 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003403 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003404
Tejun Heo29c91e92013-03-12 11:30:03 -07003405 return pool;
3406fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 if (pool)
3408 put_unbound_pool(pool);
3409 return NULL;
3410}
3411
Tejun Heo8864b4e2013-03-12 11:30:04 -07003412static void rcu_free_pwq(struct rcu_head *rcu)
3413{
3414 kmem_cache_free(pwq_cache,
3415 container_of(rcu, struct pool_workqueue, rcu));
3416}
3417
3418/*
3419 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3420 * and needs to be destroyed.
3421 */
3422static void pwq_unbound_release_workfn(struct work_struct *work)
3423{
3424 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3425 unbound_release_work);
3426 struct workqueue_struct *wq = pwq->wq;
3427 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003428 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003429
3430 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3431 return;
3432
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003433 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003434 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003435 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003436 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003437
Tejun Heoa892cac2013-04-01 11:23:32 -07003438 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003439 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003440 mutex_unlock(&wq_pool_mutex);
3441
Tejun Heo8864b4e2013-03-12 11:30:04 -07003442 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3443
3444 /*
3445 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003446 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003447 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003448 if (is_last)
3449 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003450}
3451
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003452/**
Tejun Heo699ce092013-03-13 16:51:35 -07003453 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003454 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003455 *
Tejun Heo699ce092013-03-13 16:51:35 -07003456 * If @pwq isn't freezing, set @pwq->max_active to the associated
3457 * workqueue's saved_max_active and activate delayed work items
3458 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003459 */
Tejun Heo699ce092013-03-13 16:51:35 -07003460static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003461{
Tejun Heo699ce092013-03-13 16:51:35 -07003462 struct workqueue_struct *wq = pwq->wq;
3463 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003464 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003465
Tejun Heo699ce092013-03-13 16:51:35 -07003466 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003467 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003468
3469 /* fast exit for non-freezable wqs */
3470 if (!freezable && pwq->max_active == wq->saved_max_active)
3471 return;
3472
Tejun Heo3347fa02016-09-16 15:49:32 -04003473 /* this function can be called during early boot w/ irq disabled */
3474 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003475
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003476 /*
3477 * During [un]freezing, the caller is responsible for ensuring that
3478 * this function is called at least once after @workqueue_freezing
3479 * is updated and visible.
3480 */
3481 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003482 pwq->max_active = wq->saved_max_active;
3483
3484 while (!list_empty(&pwq->delayed_works) &&
3485 pwq->nr_active < pwq->max_active)
3486 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003487
3488 /*
3489 * Need to kick a worker after thawed or an unbound wq's
3490 * max_active is bumped. It's a slow path. Do it always.
3491 */
3492 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003493 } else {
3494 pwq->max_active = 0;
3495 }
3496
Tejun Heo3347fa02016-09-16 15:49:32 -04003497 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003498}
3499
Tejun Heoe50aba92013-04-01 11:23:35 -07003500/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003501static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3502 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003503{
3504 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3505
Tejun Heoe50aba92013-04-01 11:23:35 -07003506 memset(pwq, 0, sizeof(*pwq));
3507
Tejun Heod2c1d402013-03-12 11:30:04 -07003508 pwq->pool = pool;
3509 pwq->wq = wq;
3510 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003511 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003512 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003513 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003514 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003515 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003516}
Tejun Heod2c1d402013-03-12 11:30:04 -07003517
Tejun Heof147f292013-04-01 11:23:35 -07003518/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003519static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003520{
3521 struct workqueue_struct *wq = pwq->wq;
3522
3523 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003524
Tejun Heo1befcf32013-04-01 11:23:35 -07003525 /* may be called multiple times, ignore if already linked */
3526 if (!list_empty(&pwq->pwqs_node))
3527 return;
3528
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003529 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003530 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003531
3532 /* sync max_active to the current setting */
3533 pwq_adjust_max_active(pwq);
3534
3535 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003536 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003537}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003538
Tejun Heof147f292013-04-01 11:23:35 -07003539/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3540static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3541 const struct workqueue_attrs *attrs)
3542{
3543 struct worker_pool *pool;
3544 struct pool_workqueue *pwq;
3545
3546 lockdep_assert_held(&wq_pool_mutex);
3547
3548 pool = get_unbound_pool(attrs);
3549 if (!pool)
3550 return NULL;
3551
Tejun Heoe50aba92013-04-01 11:23:35 -07003552 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003553 if (!pwq) {
3554 put_unbound_pool(pool);
3555 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003556 }
Tejun Heo6029a912013-04-01 11:23:34 -07003557
Tejun Heof147f292013-04-01 11:23:35 -07003558 init_pwq(pwq, wq, pool);
3559 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003560}
3561
Tejun Heo4c16bd32013-04-01 11:23:36 -07003562/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003563 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003564 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003565 * @node: the target NUMA node
3566 * @cpu_going_down: if >= 0, the CPU to consider as offline
3567 * @cpumask: outarg, the resulting cpumask
3568 *
3569 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3570 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003571 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003572 *
3573 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3574 * enabled and @node has online CPUs requested by @attrs, the returned
3575 * cpumask is the intersection of the possible CPUs of @node and
3576 * @attrs->cpumask.
3577 *
3578 * The caller is responsible for ensuring that the cpumask of @node stays
3579 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003580 *
3581 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3582 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003583 */
3584static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3585 int cpu_going_down, cpumask_t *cpumask)
3586{
Tejun Heod55262c2013-04-01 11:23:38 -07003587 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003588 goto use_dfl;
3589
3590 /* does @node have any online CPUs @attrs wants? */
3591 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3592 if (cpu_going_down >= 0)
3593 cpumask_clear_cpu(cpu_going_down, cpumask);
3594
3595 if (cpumask_empty(cpumask))
3596 goto use_dfl;
3597
3598 /* yeap, return possible CPUs in @node that @attrs wants */
3599 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003600
3601 if (cpumask_empty(cpumask)) {
3602 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3603 "possible intersect\n");
3604 return false;
3605 }
3606
Tejun Heo4c16bd32013-04-01 11:23:36 -07003607 return !cpumask_equal(cpumask, attrs->cpumask);
3608
3609use_dfl:
3610 cpumask_copy(cpumask, attrs->cpumask);
3611 return false;
3612}
3613
Tejun Heo1befcf32013-04-01 11:23:35 -07003614/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3615static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3616 int node,
3617 struct pool_workqueue *pwq)
3618{
3619 struct pool_workqueue *old_pwq;
3620
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003621 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003622 lockdep_assert_held(&wq->mutex);
3623
3624 /* link_pwq() can handle duplicate calls */
3625 link_pwq(pwq);
3626
3627 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3628 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3629 return old_pwq;
3630}
3631
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003632/* context to store the prepared attrs & pwqs before applying */
3633struct apply_wqattrs_ctx {
3634 struct workqueue_struct *wq; /* target workqueue */
3635 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003636 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003637 struct pool_workqueue *dfl_pwq;
3638 struct pool_workqueue *pwq_tbl[];
3639};
3640
3641/* free the resources after success or abort */
3642static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3643{
3644 if (ctx) {
3645 int node;
3646
3647 for_each_node(node)
3648 put_pwq_unlocked(ctx->pwq_tbl[node]);
3649 put_pwq_unlocked(ctx->dfl_pwq);
3650
3651 free_workqueue_attrs(ctx->attrs);
3652
3653 kfree(ctx);
3654 }
3655}
3656
3657/* allocate the attrs and pwqs for later installation */
3658static struct apply_wqattrs_ctx *
3659apply_wqattrs_prepare(struct workqueue_struct *wq,
3660 const struct workqueue_attrs *attrs)
3661{
3662 struct apply_wqattrs_ctx *ctx;
3663 struct workqueue_attrs *new_attrs, *tmp_attrs;
3664 int node;
3665
3666 lockdep_assert_held(&wq_pool_mutex);
3667
3668 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3669 GFP_KERNEL);
3670
3671 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3672 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3673 if (!ctx || !new_attrs || !tmp_attrs)
3674 goto out_free;
3675
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003676 /*
3677 * Calculate the attrs of the default pwq.
3678 * If the user configured cpumask doesn't overlap with the
3679 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3680 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003681 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003682 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003683 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3684 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003685
3686 /*
3687 * We may create multiple pwqs with differing cpumasks. Make a
3688 * copy of @new_attrs which will be modified and used to obtain
3689 * pools.
3690 */
3691 copy_workqueue_attrs(tmp_attrs, new_attrs);
3692
3693 /*
3694 * If something goes wrong during CPU up/down, we'll fall back to
3695 * the default pwq covering whole @attrs->cpumask. Always create
3696 * it even if we don't use it immediately.
3697 */
3698 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3699 if (!ctx->dfl_pwq)
3700 goto out_free;
3701
3702 for_each_node(node) {
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003703 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003704 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3705 if (!ctx->pwq_tbl[node])
3706 goto out_free;
3707 } else {
3708 ctx->dfl_pwq->refcnt++;
3709 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3710 }
3711 }
3712
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003713 /* save the user configured attrs and sanitize it. */
3714 copy_workqueue_attrs(new_attrs, attrs);
3715 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003716 ctx->attrs = new_attrs;
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003717
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003718 ctx->wq = wq;
3719 free_workqueue_attrs(tmp_attrs);
3720 return ctx;
3721
3722out_free:
3723 free_workqueue_attrs(tmp_attrs);
3724 free_workqueue_attrs(new_attrs);
3725 apply_wqattrs_cleanup(ctx);
3726 return NULL;
3727}
3728
3729/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3730static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3731{
3732 int node;
3733
3734 /* all pwqs have been created successfully, let's install'em */
3735 mutex_lock(&ctx->wq->mutex);
3736
3737 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3738
3739 /* save the previous pwq and install the new one */
3740 for_each_node(node)
3741 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3742 ctx->pwq_tbl[node]);
3743
3744 /* @dfl_pwq might not have been used, ensure it's linked */
3745 link_pwq(ctx->dfl_pwq);
3746 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3747
3748 mutex_unlock(&ctx->wq->mutex);
3749}
3750
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003751static void apply_wqattrs_lock(void)
3752{
3753 /* CPUs should stay stable across pwq creations and installations */
3754 get_online_cpus();
3755 mutex_lock(&wq_pool_mutex);
3756}
3757
3758static void apply_wqattrs_unlock(void)
3759{
3760 mutex_unlock(&wq_pool_mutex);
3761 put_online_cpus();
3762}
3763
3764static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3765 const struct workqueue_attrs *attrs)
3766{
3767 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003768
3769 /* only unbound workqueues can change attributes */
3770 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3771 return -EINVAL;
3772
3773 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003774 if (!list_empty(&wq->pwqs)) {
3775 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3776 return -EINVAL;
3777
3778 wq->flags &= ~__WQ_ORDERED;
3779 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003780
3781 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003782 if (!ctx)
3783 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003784
3785 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003786 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003787 apply_wqattrs_cleanup(ctx);
3788
wanghaibin62011712016-01-07 20:38:59 +08003789 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003790}
3791
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003792/**
3793 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3794 * @wq: the target workqueue
3795 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3796 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003797 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3798 * machines, this function maps a separate pwq to each NUMA node with
3799 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3800 * NUMA node it was issued on. Older pwqs are released as in-flight work
3801 * items finish. Note that a work item which repeatedly requeues itself
3802 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003803 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003804 * Performs GFP_KERNEL allocations.
3805 *
3806 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003807 */
3808int apply_workqueue_attrs(struct workqueue_struct *wq,
3809 const struct workqueue_attrs *attrs)
3810{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003811 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003812
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003813 apply_wqattrs_lock();
3814 ret = apply_workqueue_attrs_locked(wq, attrs);
3815 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003816
Tejun Heo48621252013-04-01 11:23:31 -07003817 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003818}
3819
Tejun Heo4c16bd32013-04-01 11:23:36 -07003820/**
3821 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3822 * @wq: the target workqueue
3823 * @cpu: the CPU coming up or going down
3824 * @online: whether @cpu is coming up or going down
3825 *
3826 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3827 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3828 * @wq accordingly.
3829 *
3830 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3831 * falls back to @wq->dfl_pwq which may not be optimal but is always
3832 * correct.
3833 *
3834 * Note that when the last allowed CPU of a NUMA node goes offline for a
3835 * workqueue with a cpumask spanning multiple nodes, the workers which were
3836 * already executing the work items for the workqueue will lose their CPU
3837 * affinity and may execute on any CPU. This is similar to how per-cpu
3838 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3839 * affinity, it's the user's responsibility to flush the work item from
3840 * CPU_DOWN_PREPARE.
3841 */
3842static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3843 bool online)
3844{
3845 int node = cpu_to_node(cpu);
3846 int cpu_off = online ? -1 : cpu;
3847 struct pool_workqueue *old_pwq = NULL, *pwq;
3848 struct workqueue_attrs *target_attrs;
3849 cpumask_t *cpumask;
3850
3851 lockdep_assert_held(&wq_pool_mutex);
3852
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003853 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3854 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003855 return;
3856
3857 /*
3858 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3859 * Let's use a preallocated one. The following buf is protected by
3860 * CPU hotplug exclusion.
3861 */
3862 target_attrs = wq_update_unbound_numa_attrs_buf;
3863 cpumask = target_attrs->cpumask;
3864
Tejun Heo4c16bd32013-04-01 11:23:36 -07003865 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3866 pwq = unbound_pwq_by_node(wq, node);
3867
3868 /*
3869 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003870 * different from the default pwq's, we need to compare it to @pwq's
3871 * and create a new one if they don't match. If the target cpumask
3872 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003873 */
Lai Jiangshan042f7df12015-04-30 17:16:12 +08003874 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003875 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003876 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003877 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003878 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003879 }
3880
Tejun Heo4c16bd32013-04-01 11:23:36 -07003881 /* create a new pwq */
3882 pwq = alloc_unbound_pwq(wq, target_attrs);
3883 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003884 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3885 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003886 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003887 }
3888
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003889 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003890 mutex_lock(&wq->mutex);
3891 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3892 goto out_unlock;
3893
3894use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003895 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003896 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3897 get_pwq(wq->dfl_pwq);
3898 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3899 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3900out_unlock:
3901 mutex_unlock(&wq->mutex);
3902 put_pwq_unlocked(old_pwq);
3903}
3904
Tejun Heo30cdf2492013-03-12 11:29:57 -07003905static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003906{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003907 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003908 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003909
Tejun Heo30cdf2492013-03-12 11:29:57 -07003910 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003911 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3912 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003913 return -ENOMEM;
3914
3915 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003916 struct pool_workqueue *pwq =
3917 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003918 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003919 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003920
Tejun Heof147f292013-04-01 11:23:35 -07003921 init_pwq(pwq, wq, &cpu_pools[highpri]);
3922
3923 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003924 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003925 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003926 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003927 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003928 } else if (wq->flags & __WQ_ORDERED) {
3929 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3930 /* there should only be single pwq for ordering guarantee */
3931 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3932 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3933 "ordering guarantee broken for workqueue %s\n", wq->name);
3934 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003935 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003936 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003937 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003938}
3939
Tejun Heof3421792010-07-02 10:03:51 +02003940static int wq_clamp_max_active(int max_active, unsigned int flags,
3941 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003942{
Tejun Heof3421792010-07-02 10:03:51 +02003943 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3944
3945 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003946 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3947 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003948
Tejun Heof3421792010-07-02 10:03:51 +02003949 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003950}
3951
Tejun Heob196be82012-01-10 15:11:35 -08003952struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003953 unsigned int flags,
3954 int max_active,
3955 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003956 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003957{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003958 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003959 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003960 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003961 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003962
Tejun Heo5c0338c2017-07-18 18:41:52 -04003963 /*
3964 * Unbound && max_active == 1 used to imply ordered, which is no
3965 * longer the case on NUMA machines due to per-node pools. While
3966 * alloc_ordered_workqueue() is the right way to create an ordered
3967 * workqueue, keep the previous behavior to avoid subtle breakages
3968 * on NUMA.
3969 */
3970 if ((flags & WQ_UNBOUND) && max_active == 1)
3971 flags |= __WQ_ORDERED;
3972
Viresh Kumarcee22a12013-04-08 16:45:40 +05303973 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3974 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3975 flags |= WQ_UNBOUND;
3976
Tejun Heoecf68812013-04-01 11:23:34 -07003977 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003978 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003979 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003980
3981 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003982 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003983 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003984
Tejun Heo6029a912013-04-01 11:23:34 -07003985 if (flags & WQ_UNBOUND) {
3986 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3987 if (!wq->unbound_attrs)
3988 goto err_free_wq;
3989 }
3990
Tejun Heoecf68812013-04-01 11:23:34 -07003991 va_start(args, lock_name);
3992 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003993 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003994
Tejun Heod320c032010-06-29 10:07:14 +02003995 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003996 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003997
Tejun Heob196be82012-01-10 15:11:35 -08003998 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003999 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004000 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004001 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004002 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004003 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004004 INIT_LIST_HEAD(&wq->flusher_queue);
4005 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004006 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004007
Johannes Bergeb13ba82008-01-16 09:51:58 +01004008 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004009 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004010
Tejun Heo30cdf2492013-03-12 11:29:57 -07004011 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004012 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004013
Tejun Heo493008a2013-03-12 11:30:03 -07004014 /*
4015 * Workqueues which may be used during memory reclaim should
4016 * have a rescuer to guarantee forward progress.
4017 */
4018 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004019 struct worker *rescuer;
4020
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004021 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004022 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004023 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004024
Tejun Heo111c2252013-01-17 17:16:24 -08004025 rescuer->rescue_wq = wq;
4026 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004027 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004028 if (IS_ERR(rescuer->task)) {
4029 kfree(rescuer);
4030 goto err_destroy;
4031 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004032
Tejun Heod2c1d402013-03-12 11:30:04 -07004033 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004034 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004035 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004036 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004037
Tejun Heo226223a2013-03-12 11:30:05 -07004038 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4039 goto err_destroy;
4040
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004041 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004042 * wq_pool_mutex protects global freeze state and workqueues list.
4043 * Grab it, adjust max_active and add the new @wq to workqueues
4044 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004045 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004046 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004047
Lai Jiangshana357fc02013-03-25 16:57:19 -07004048 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004049 for_each_pwq(pwq, wq)
4050 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004051 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004052
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004053 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004054
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004055 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004056
Oleg Nesterov3af244332007-05-09 02:34:09 -07004057 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004058
4059err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004060 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004061 kfree(wq);
4062 return NULL;
4063err_destroy:
4064 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004065 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004066}
Tejun Heod320c032010-06-29 10:07:14 +02004067EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004068
4069/**
4070 * destroy_workqueue - safely terminate a workqueue
4071 * @wq: target workqueue
4072 *
4073 * Safely destroy a workqueue. All work currently pending will be done first.
4074 */
4075void destroy_workqueue(struct workqueue_struct *wq)
4076{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004077 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004078 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004079
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004080 /* drain it before proceeding with destruction */
4081 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004082
Tejun Heo6183c002013-03-12 11:29:57 -07004083 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004084 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004085 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004086 int i;
4087
Tejun Heo76af4d92013-03-12 11:30:00 -07004088 for (i = 0; i < WORK_NR_COLORS; i++) {
4089 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004090 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004091 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004092 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004093 }
4094 }
4095
Lai Jiangshan5c529592013-04-04 10:05:38 +08004096 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004097 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004098 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004099 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004100 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004101 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004102 }
Tejun Heo6183c002013-03-12 11:29:57 -07004103 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004104 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004105
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004106 /*
4107 * wq list is used to freeze wq, remove from list after
4108 * flushing is complete in case freeze races us.
4109 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004110 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004111 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004112 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004113
Tejun Heo226223a2013-03-12 11:30:05 -07004114 workqueue_sysfs_unregister(wq);
4115
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004116 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004117 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004118
Tejun Heo8864b4e2013-03-12 11:30:04 -07004119 if (!(wq->flags & WQ_UNBOUND)) {
4120 /*
4121 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004122 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004123 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004124 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004125 } else {
4126 /*
4127 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004128 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4129 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004130 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004131 for_each_node(node) {
4132 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4133 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4134 put_pwq_unlocked(pwq);
4135 }
4136
4137 /*
4138 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4139 * put. Don't access it afterwards.
4140 */
4141 pwq = wq->dfl_pwq;
4142 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004143 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004144 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004145}
4146EXPORT_SYMBOL_GPL(destroy_workqueue);
4147
Tejun Heodcd989c2010-06-29 10:07:14 +02004148/**
4149 * workqueue_set_max_active - adjust max_active of a workqueue
4150 * @wq: target workqueue
4151 * @max_active: new max_active value.
4152 *
4153 * Set max_active of @wq to @max_active.
4154 *
4155 * CONTEXT:
4156 * Don't call from IRQ context.
4157 */
4158void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4159{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004160 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004161
Tejun Heo8719dce2013-03-12 11:30:04 -07004162 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004163 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004164 return;
4165
Tejun Heof3421792010-07-02 10:03:51 +02004166 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004167
Lai Jiangshana357fc02013-03-25 16:57:19 -07004168 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004169
Tejun Heo0a94efb2017-07-23 08:36:15 -04004170 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004171 wq->saved_max_active = max_active;
4172
Tejun Heo699ce092013-03-13 16:51:35 -07004173 for_each_pwq(pwq, wq)
4174 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004175
Lai Jiangshana357fc02013-03-25 16:57:19 -07004176 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004177}
4178EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4179
4180/**
Tejun Heoe62676162013-03-12 17:41:37 -07004181 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4182 *
4183 * Determine whether %current is a workqueue rescuer. Can be used from
4184 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004185 *
4186 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004187 */
4188bool current_is_workqueue_rescuer(void)
4189{
4190 struct worker *worker = current_wq_worker();
4191
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004192 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004193}
4194
4195/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004196 * workqueue_congested - test whether a workqueue is congested
4197 * @cpu: CPU in question
4198 * @wq: target workqueue
4199 *
4200 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4201 * no synchronization around this function and the test result is
4202 * unreliable and only useful as advisory hints or for debugging.
4203 *
Tejun Heod3251852013-05-10 11:10:17 -07004204 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4205 * Note that both per-cpu and unbound workqueues may be associated with
4206 * multiple pool_workqueues which have separate congested states. A
4207 * workqueue being congested on one CPU doesn't mean the workqueue is also
4208 * contested on other CPUs / NUMA nodes.
4209 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004210 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004211 * %true if congested, %false otherwise.
4212 */
Tejun Heod84ff052013-03-12 11:29:59 -07004213bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004214{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004215 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004216 bool ret;
4217
Lai Jiangshan88109452013-03-20 03:28:10 +08004218 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004219
Tejun Heod3251852013-05-10 11:10:17 -07004220 if (cpu == WORK_CPU_UNBOUND)
4221 cpu = smp_processor_id();
4222
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004223 if (!(wq->flags & WQ_UNBOUND))
4224 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4225 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004226 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004227
Tejun Heo76af4d92013-03-12 11:30:00 -07004228 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004229 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004230
4231 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004232}
4233EXPORT_SYMBOL_GPL(workqueue_congested);
4234
4235/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004236 * work_busy - test whether a work is currently pending or running
4237 * @work: the work to be tested
4238 *
4239 * Test whether @work is currently pending or running. There is no
4240 * synchronization around this function and the test result is
4241 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004242 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004243 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004244 * OR'd bitmask of WORK_BUSY_* bits.
4245 */
4246unsigned int work_busy(struct work_struct *work)
4247{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004248 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004249 unsigned long flags;
4250 unsigned int ret = 0;
4251
Tejun Heodcd989c2010-06-29 10:07:14 +02004252 if (work_pending(work))
4253 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004254
Tejun Heofa1b54e2013-03-12 11:30:00 -07004255 local_irq_save(flags);
4256 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004257 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004258 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004259 if (find_worker_executing_work(pool, work))
4260 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004261 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004262 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004263 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004264
4265 return ret;
4266}
4267EXPORT_SYMBOL_GPL(work_busy);
4268
Tejun Heo3d1cb202013-04-30 15:27:22 -07004269/**
4270 * set_worker_desc - set description for the current work item
4271 * @fmt: printf-style format string
4272 * @...: arguments for the format string
4273 *
4274 * This function can be called by a running work function to describe what
4275 * the work item is about. If the worker task gets dumped, this
4276 * information will be printed out together to help debugging. The
4277 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4278 */
4279void set_worker_desc(const char *fmt, ...)
4280{
4281 struct worker *worker = current_wq_worker();
4282 va_list args;
4283
4284 if (worker) {
4285 va_start(args, fmt);
4286 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4287 va_end(args);
4288 worker->desc_valid = true;
4289 }
4290}
4291
4292/**
4293 * print_worker_info - print out worker information and description
4294 * @log_lvl: the log level to use when printing
4295 * @task: target task
4296 *
4297 * If @task is a worker and currently executing a work item, print out the
4298 * name of the workqueue being serviced and worker description set with
4299 * set_worker_desc() by the currently executing work item.
4300 *
4301 * This function can be safely called on any task as long as the
4302 * task_struct itself is accessible. While safe, this function isn't
4303 * synchronized and may print out mixups or garbages of limited length.
4304 */
4305void print_worker_info(const char *log_lvl, struct task_struct *task)
4306{
4307 work_func_t *fn = NULL;
4308 char name[WQ_NAME_LEN] = { };
4309 char desc[WORKER_DESC_LEN] = { };
4310 struct pool_workqueue *pwq = NULL;
4311 struct workqueue_struct *wq = NULL;
4312 bool desc_valid = false;
4313 struct worker *worker;
4314
4315 if (!(task->flags & PF_WQ_WORKER))
4316 return;
4317
4318 /*
4319 * This function is called without any synchronization and @task
4320 * could be in any state. Be careful with dereferences.
4321 */
Petr Mladeke7005912016-10-11 13:55:17 -07004322 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004323
4324 /*
4325 * Carefully copy the associated workqueue's workfn and name. Keep
4326 * the original last '\0' in case the original contains garbage.
4327 */
4328 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4329 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4330 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4331 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4332
4333 /* copy worker description */
4334 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4335 if (desc_valid)
4336 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4337
4338 if (fn || name[0] || desc[0]) {
4339 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4340 if (desc[0])
4341 pr_cont(" (%s)", desc);
4342 pr_cont("\n");
4343 }
4344}
4345
Tejun Heo3494fc32015-03-09 09:22:28 -04004346static void pr_cont_pool_info(struct worker_pool *pool)
4347{
4348 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4349 if (pool->node != NUMA_NO_NODE)
4350 pr_cont(" node=%d", pool->node);
4351 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4352}
4353
4354static void pr_cont_work(bool comma, struct work_struct *work)
4355{
4356 if (work->func == wq_barrier_func) {
4357 struct wq_barrier *barr;
4358
4359 barr = container_of(work, struct wq_barrier, work);
4360
4361 pr_cont("%s BAR(%d)", comma ? "," : "",
4362 task_pid_nr(barr->task));
4363 } else {
4364 pr_cont("%s %pf", comma ? "," : "", work->func);
4365 }
4366}
4367
4368static void show_pwq(struct pool_workqueue *pwq)
4369{
4370 struct worker_pool *pool = pwq->pool;
4371 struct work_struct *work;
4372 struct worker *worker;
4373 bool has_in_flight = false, has_pending = false;
4374 int bkt;
4375
4376 pr_info(" pwq %d:", pool->id);
4377 pr_cont_pool_info(pool);
4378
4379 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4380 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4381
4382 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4383 if (worker->current_pwq == pwq) {
4384 has_in_flight = true;
4385 break;
4386 }
4387 }
4388 if (has_in_flight) {
4389 bool comma = false;
4390
4391 pr_info(" in-flight:");
4392 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4393 if (worker->current_pwq != pwq)
4394 continue;
4395
4396 pr_cont("%s %d%s:%pf", comma ? "," : "",
4397 task_pid_nr(worker->task),
4398 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4399 worker->current_func);
4400 list_for_each_entry(work, &worker->scheduled, entry)
4401 pr_cont_work(false, work);
4402 comma = true;
4403 }
4404 pr_cont("\n");
4405 }
4406
4407 list_for_each_entry(work, &pool->worklist, entry) {
4408 if (get_work_pwq(work) == pwq) {
4409 has_pending = true;
4410 break;
4411 }
4412 }
4413 if (has_pending) {
4414 bool comma = false;
4415
4416 pr_info(" pending:");
4417 list_for_each_entry(work, &pool->worklist, entry) {
4418 if (get_work_pwq(work) != pwq)
4419 continue;
4420
4421 pr_cont_work(comma, work);
4422 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4423 }
4424 pr_cont("\n");
4425 }
4426
4427 if (!list_empty(&pwq->delayed_works)) {
4428 bool comma = false;
4429
4430 pr_info(" delayed:");
4431 list_for_each_entry(work, &pwq->delayed_works, entry) {
4432 pr_cont_work(comma, work);
4433 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4434 }
4435 pr_cont("\n");
4436 }
4437}
4438
4439/**
4440 * show_workqueue_state - dump workqueue state
4441 *
Roger Lu7b776af2016-07-01 11:05:02 +08004442 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4443 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004444 */
4445void show_workqueue_state(void)
4446{
4447 struct workqueue_struct *wq;
4448 struct worker_pool *pool;
4449 unsigned long flags;
4450 int pi;
4451
4452 rcu_read_lock_sched();
4453
4454 pr_info("Showing busy workqueues and worker pools:\n");
4455
4456 list_for_each_entry_rcu(wq, &workqueues, list) {
4457 struct pool_workqueue *pwq;
4458 bool idle = true;
4459
4460 for_each_pwq(pwq, wq) {
4461 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4462 idle = false;
4463 break;
4464 }
4465 }
4466 if (idle)
4467 continue;
4468
4469 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4470
4471 for_each_pwq(pwq, wq) {
4472 spin_lock_irqsave(&pwq->pool->lock, flags);
4473 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4474 show_pwq(pwq);
4475 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4476 }
4477 }
4478
4479 for_each_pool(pool, pi) {
4480 struct worker *worker;
4481 bool first = true;
4482
4483 spin_lock_irqsave(&pool->lock, flags);
4484 if (pool->nr_workers == pool->nr_idle)
4485 goto next_pool;
4486
4487 pr_info("pool %d:", pool->id);
4488 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004489 pr_cont(" hung=%us workers=%d",
4490 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4491 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004492 if (pool->manager)
4493 pr_cont(" manager: %d",
4494 task_pid_nr(pool->manager->task));
4495 list_for_each_entry(worker, &pool->idle_list, entry) {
4496 pr_cont(" %s%d", first ? "idle: " : "",
4497 task_pid_nr(worker->task));
4498 first = false;
4499 }
4500 pr_cont("\n");
4501 next_pool:
4502 spin_unlock_irqrestore(&pool->lock, flags);
4503 }
4504
4505 rcu_read_unlock_sched();
4506}
4507
Tejun Heodb7bccf2010-06-29 10:07:12 +02004508/*
4509 * CPU hotplug.
4510 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004511 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004512 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004513 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004514 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004515 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004516 * blocked draining impractical.
4517 *
Tejun Heo24647572013-01-24 11:01:33 -08004518 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004519 * running as an unbound one and allowing it to be reattached later if the
4520 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004521 */
4522
Tejun Heo706026c2013-01-24 11:01:34 -08004523static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004524{
Tejun Heo38db41d2013-01-24 11:01:34 -08004525 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004526 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004527 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004528
Tejun Heof02ae732013-03-12 11:30:03 -07004529 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004530 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004531 spin_lock_irq(&pool->lock);
4532
4533 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004534 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004535 * unbound and set DISASSOCIATED. Before this, all workers
4536 * except for the ones which are still executing works from
4537 * before the last CPU down must be on the cpu. After
4538 * this, they may become diasporas.
4539 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004540 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004541 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004542
Tejun Heo24647572013-01-24 11:01:33 -08004543 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004544
Tejun Heo94cf58b2013-01-24 11:01:33 -08004545 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004546 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004547
Lai Jiangshaneb283422013-03-08 15:18:28 -08004548 /*
4549 * Call schedule() so that we cross rq->lock and thus can
4550 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4551 * This is necessary as scheduler callbacks may be invoked
4552 * from other cpus.
4553 */
4554 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004555
Lai Jiangshaneb283422013-03-08 15:18:28 -08004556 /*
4557 * Sched callbacks are disabled now. Zap nr_running.
4558 * After this, nr_running stays zero and need_more_worker()
4559 * and keep_working() are always true as long as the
4560 * worklist is not empty. This pool now behaves as an
4561 * unbound (in terms of concurrency management) pool which
4562 * are served by workers tied to the pool.
4563 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004564 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004565
4566 /*
4567 * With concurrency management just turned off, a busy
4568 * worker blocking could lead to lengthy stalls. Kick off
4569 * unbound chain execution of currently pending work items.
4570 */
4571 spin_lock_irq(&pool->lock);
4572 wake_up_worker(pool);
4573 spin_unlock_irq(&pool->lock);
4574 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004575}
4576
Tejun Heobd7c0892013-03-19 13:45:21 -07004577/**
4578 * rebind_workers - rebind all workers of a pool to the associated CPU
4579 * @pool: pool of interest
4580 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004581 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004582 */
4583static void rebind_workers(struct worker_pool *pool)
4584{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004585 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004586
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004587 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004588
Tejun Heoa9ab7752013-03-19 13:45:21 -07004589 /*
4590 * Restore CPU affinity of all workers. As all idle workers should
4591 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304592 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004593 * of all workers first and then clear UNBOUND. As we're called
4594 * from CPU_ONLINE, the following shouldn't fail.
4595 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004596 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004597 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4598 pool->attrs->cpumask) < 0);
4599
4600 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004601
4602 /*
4603 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4604 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4605 * being reworked and this can go away in time.
4606 */
4607 if (!(pool->flags & POOL_DISASSOCIATED)) {
4608 spin_unlock_irq(&pool->lock);
4609 return;
4610 }
4611
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004612 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004613
Lai Jiangshanda028462014-05-20 17:46:31 +08004614 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004615 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004616
4617 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004618 * A bound idle worker should actually be on the runqueue
4619 * of the associated CPU for local wake-ups targeting it to
4620 * work. Kick all idle workers so that they migrate to the
4621 * associated CPU. Doing this in the same loop as
4622 * replacing UNBOUND with REBOUND is safe as no worker will
4623 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004624 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004625 if (worker_flags & WORKER_IDLE)
4626 wake_up_process(worker->task);
4627
4628 /*
4629 * We want to clear UNBOUND but can't directly call
4630 * worker_clr_flags() or adjust nr_running. Atomically
4631 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4632 * @worker will clear REBOUND using worker_clr_flags() when
4633 * it initiates the next execution cycle thus restoring
4634 * concurrency management. Note that when or whether
4635 * @worker clears REBOUND doesn't affect correctness.
4636 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004637 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004638 * tested without holding any lock in
4639 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4640 * fail incorrectly leading to premature concurrency
4641 * management operations.
4642 */
4643 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4644 worker_flags |= WORKER_REBOUND;
4645 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004646 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004647 }
4648
Tejun Heoa9ab7752013-03-19 13:45:21 -07004649 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004650}
4651
Tejun Heo7dbc7252013-03-19 13:45:21 -07004652/**
4653 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4654 * @pool: unbound pool of interest
4655 * @cpu: the CPU which is coming up
4656 *
4657 * An unbound pool may end up with a cpumask which doesn't have any online
4658 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4659 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4660 * online CPU before, cpus_allowed of all its workers should be restored.
4661 */
4662static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4663{
4664 static cpumask_t cpumask;
4665 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004666
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004667 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004668
4669 /* is @cpu allowed for @pool? */
4670 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4671 return;
4672
Tejun Heo7dbc7252013-03-19 13:45:21 -07004673 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004674
4675 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004676 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004677 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004678}
4679
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004680int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004681{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004682 struct worker_pool *pool;
4683
4684 for_each_cpu_worker_pool(pool, cpu) {
4685 if (pool->nr_workers)
4686 continue;
4687 if (!create_worker(pool))
4688 return -ENOMEM;
4689 }
4690 return 0;
4691}
4692
4693int workqueue_online_cpu(unsigned int cpu)
4694{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004695 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004696 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004697 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004698
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004699 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004700
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004701 for_each_pool(pool, pi) {
4702 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004703
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004704 if (pool->cpu == cpu)
4705 rebind_workers(pool);
4706 else if (pool->cpu < 0)
4707 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004708
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004709 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004710 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004711
4712 /* update NUMA affinity of unbound workqueues */
4713 list_for_each_entry(wq, &workqueues, list)
4714 wq_update_unbound_numa(wq, cpu, true);
4715
4716 mutex_unlock(&wq_pool_mutex);
4717 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004718}
4719
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004720int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004721{
Tejun Heo8db25e72012-07-17 12:39:28 -07004722 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004723 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004724
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004725 /* unbinding per-cpu workers should happen on the local CPU */
4726 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4727 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004728
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004729 /* update NUMA affinity of unbound workqueues */
4730 mutex_lock(&wq_pool_mutex);
4731 list_for_each_entry(wq, &workqueues, list)
4732 wq_update_unbound_numa(wq, cpu, false);
4733 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004734
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004735 /* wait for per-cpu unbinding to finish */
4736 flush_work(&unbind_work);
4737 destroy_work_on_stack(&unbind_work);
4738 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004739}
4740
Rusty Russell2d3854a2008-11-05 13:39:10 +11004741#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004742
Rusty Russell2d3854a2008-11-05 13:39:10 +11004743struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004744 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004745 long (*fn)(void *);
4746 void *arg;
4747 long ret;
4748};
4749
Tejun Heoed48ece2012-09-18 12:48:43 -07004750static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004751{
Tejun Heoed48ece2012-09-18 12:48:43 -07004752 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4753
Rusty Russell2d3854a2008-11-05 13:39:10 +11004754 wfc->ret = wfc->fn(wfc->arg);
4755}
4756
4757/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004758 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004759 * @cpu: the cpu to run on
4760 * @fn: the function to run
4761 * @arg: the function arg
4762 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004763 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004764 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004765 *
4766 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004767 */
Tejun Heod84ff052013-03-12 11:29:59 -07004768long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004769{
Tejun Heoed48ece2012-09-18 12:48:43 -07004770 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004771
Tejun Heoed48ece2012-09-18 12:48:43 -07004772 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4773 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004774 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004775 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004776 return wfc.ret;
4777}
4778EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004779
4780/**
4781 * work_on_cpu_safe - run a function in thread context on a particular cpu
4782 * @cpu: the cpu to run on
4783 * @fn: the function to run
4784 * @arg: the function argument
4785 *
4786 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4787 * any locks which would prevent @fn from completing.
4788 *
4789 * Return: The value @fn returns.
4790 */
4791long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4792{
4793 long ret = -ENODEV;
4794
4795 get_online_cpus();
4796 if (cpu_online(cpu))
4797 ret = work_on_cpu(cpu, fn, arg);
4798 put_online_cpus();
4799 return ret;
4800}
4801EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004802#endif /* CONFIG_SMP */
4803
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004804#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304805
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004806/**
4807 * freeze_workqueues_begin - begin freezing workqueues
4808 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004809 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004810 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004811 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004812 *
4813 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004814 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004815 */
4816void freeze_workqueues_begin(void)
4817{
Tejun Heo24b8a842013-03-12 11:29:58 -07004818 struct workqueue_struct *wq;
4819 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004820
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004821 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004822
Tejun Heo6183c002013-03-12 11:29:57 -07004823 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004824 workqueue_freezing = true;
4825
Tejun Heo24b8a842013-03-12 11:29:58 -07004826 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004827 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004828 for_each_pwq(pwq, wq)
4829 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004830 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004831 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004832
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004833 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004834}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004835
4836/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004837 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004838 *
4839 * Check whether freezing is complete. This function must be called
4840 * between freeze_workqueues_begin() and thaw_workqueues().
4841 *
4842 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004843 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004844 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004845 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004846 * %true if some freezable workqueues are still busy. %false if freezing
4847 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004848 */
4849bool freeze_workqueues_busy(void)
4850{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004851 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004852 struct workqueue_struct *wq;
4853 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004854
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004855 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004856
Tejun Heo6183c002013-03-12 11:29:57 -07004857 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004858
Tejun Heo24b8a842013-03-12 11:29:58 -07004859 list_for_each_entry(wq, &workqueues, list) {
4860 if (!(wq->flags & WQ_FREEZABLE))
4861 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004862 /*
4863 * nr_active is monotonically decreasing. It's safe
4864 * to peek without lock.
4865 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004866 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004867 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004868 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004869 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004870 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004871 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004872 goto out_unlock;
4873 }
4874 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004875 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004876 }
4877out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004878 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004879 return busy;
4880}
4881
4882/**
4883 * thaw_workqueues - thaw workqueues
4884 *
4885 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004886 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004887 *
4888 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004889 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004890 */
4891void thaw_workqueues(void)
4892{
Tejun Heo24b8a842013-03-12 11:29:58 -07004893 struct workqueue_struct *wq;
4894 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004895
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004896 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004897
4898 if (!workqueue_freezing)
4899 goto out_unlock;
4900
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004901 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004902
Tejun Heo24b8a842013-03-12 11:29:58 -07004903 /* restore max_active and repopulate worklist */
4904 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004905 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004906 for_each_pwq(pwq, wq)
4907 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004908 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004909 }
4910
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004911out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004912 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004913}
4914#endif /* CONFIG_FREEZER */
4915
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004916static int workqueue_apply_unbound_cpumask(void)
4917{
4918 LIST_HEAD(ctxs);
4919 int ret = 0;
4920 struct workqueue_struct *wq;
4921 struct apply_wqattrs_ctx *ctx, *n;
4922
4923 lockdep_assert_held(&wq_pool_mutex);
4924
4925 list_for_each_entry(wq, &workqueues, list) {
4926 if (!(wq->flags & WQ_UNBOUND))
4927 continue;
4928 /* creating multiple pwqs breaks ordering guarantee */
4929 if (wq->flags & __WQ_ORDERED)
4930 continue;
4931
4932 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4933 if (!ctx) {
4934 ret = -ENOMEM;
4935 break;
4936 }
4937
4938 list_add_tail(&ctx->list, &ctxs);
4939 }
4940
4941 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4942 if (!ret)
4943 apply_wqattrs_commit(ctx);
4944 apply_wqattrs_cleanup(ctx);
4945 }
4946
4947 return ret;
4948}
4949
4950/**
4951 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4952 * @cpumask: the cpumask to set
4953 *
4954 * The low-level workqueues cpumask is a global cpumask that limits
4955 * the affinity of all unbound workqueues. This function check the @cpumask
4956 * and apply it to all unbound workqueues and updates all pwqs of them.
4957 *
4958 * Retun: 0 - Success
4959 * -EINVAL - Invalid @cpumask
4960 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4961 */
4962int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4963{
4964 int ret = -EINVAL;
4965 cpumask_var_t saved_cpumask;
4966
4967 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4968 return -ENOMEM;
4969
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004970 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4971 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004972 apply_wqattrs_lock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004973
4974 /* save the old wq_unbound_cpumask. */
4975 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4976
4977 /* update wq_unbound_cpumask at first and apply it to wqs. */
4978 cpumask_copy(wq_unbound_cpumask, cpumask);
4979 ret = workqueue_apply_unbound_cpumask();
4980
4981 /* restore the wq_unbound_cpumask when failed. */
4982 if (ret < 0)
4983 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4984
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004985 apply_wqattrs_unlock();
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004986 }
Lai Jiangshan042f7df12015-04-30 17:16:12 +08004987
4988 free_cpumask_var(saved_cpumask);
4989 return ret;
4990}
4991
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08004992#ifdef CONFIG_SYSFS
4993/*
4994 * Workqueues with WQ_SYSFS flag set is visible to userland via
4995 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
4996 * following attributes.
4997 *
4998 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
4999 * max_active RW int : maximum number of in-flight work items
5000 *
5001 * Unbound workqueues have the following extra attributes.
5002 *
5003 * id RO int : the associated pool ID
5004 * nice RW int : nice value of the workers
5005 * cpumask RW mask : bitmask of allowed CPUs for the workers
5006 */
5007struct wq_device {
5008 struct workqueue_struct *wq;
5009 struct device dev;
5010};
5011
5012static struct workqueue_struct *dev_to_wq(struct device *dev)
5013{
5014 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5015
5016 return wq_dev->wq;
5017}
5018
5019static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5020 char *buf)
5021{
5022 struct workqueue_struct *wq = dev_to_wq(dev);
5023
5024 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5025}
5026static DEVICE_ATTR_RO(per_cpu);
5027
5028static ssize_t max_active_show(struct device *dev,
5029 struct device_attribute *attr, char *buf)
5030{
5031 struct workqueue_struct *wq = dev_to_wq(dev);
5032
5033 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5034}
5035
5036static ssize_t max_active_store(struct device *dev,
5037 struct device_attribute *attr, const char *buf,
5038 size_t count)
5039{
5040 struct workqueue_struct *wq = dev_to_wq(dev);
5041 int val;
5042
5043 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5044 return -EINVAL;
5045
5046 workqueue_set_max_active(wq, val);
5047 return count;
5048}
5049static DEVICE_ATTR_RW(max_active);
5050
5051static struct attribute *wq_sysfs_attrs[] = {
5052 &dev_attr_per_cpu.attr,
5053 &dev_attr_max_active.attr,
5054 NULL,
5055};
5056ATTRIBUTE_GROUPS(wq_sysfs);
5057
5058static ssize_t wq_pool_ids_show(struct device *dev,
5059 struct device_attribute *attr, char *buf)
5060{
5061 struct workqueue_struct *wq = dev_to_wq(dev);
5062 const char *delim = "";
5063 int node, written = 0;
5064
5065 rcu_read_lock_sched();
5066 for_each_node(node) {
5067 written += scnprintf(buf + written, PAGE_SIZE - written,
5068 "%s%d:%d", delim, node,
5069 unbound_pwq_by_node(wq, node)->pool->id);
5070 delim = " ";
5071 }
5072 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5073 rcu_read_unlock_sched();
5074
5075 return written;
5076}
5077
5078static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5079 char *buf)
5080{
5081 struct workqueue_struct *wq = dev_to_wq(dev);
5082 int written;
5083
5084 mutex_lock(&wq->mutex);
5085 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5086 mutex_unlock(&wq->mutex);
5087
5088 return written;
5089}
5090
5091/* prepare workqueue_attrs for sysfs store operations */
5092static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5093{
5094 struct workqueue_attrs *attrs;
5095
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005096 lockdep_assert_held(&wq_pool_mutex);
5097
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005098 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5099 if (!attrs)
5100 return NULL;
5101
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005102 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005103 return attrs;
5104}
5105
5106static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5107 const char *buf, size_t count)
5108{
5109 struct workqueue_struct *wq = dev_to_wq(dev);
5110 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005111 int ret = -ENOMEM;
5112
5113 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005114
5115 attrs = wq_sysfs_prep_attrs(wq);
5116 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005117 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005118
5119 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5120 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005121 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005122 else
5123 ret = -EINVAL;
5124
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005125out_unlock:
5126 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005127 free_workqueue_attrs(attrs);
5128 return ret ?: count;
5129}
5130
5131static ssize_t wq_cpumask_show(struct device *dev,
5132 struct device_attribute *attr, char *buf)
5133{
5134 struct workqueue_struct *wq = dev_to_wq(dev);
5135 int written;
5136
5137 mutex_lock(&wq->mutex);
5138 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5139 cpumask_pr_args(wq->unbound_attrs->cpumask));
5140 mutex_unlock(&wq->mutex);
5141 return written;
5142}
5143
5144static ssize_t wq_cpumask_store(struct device *dev,
5145 struct device_attribute *attr,
5146 const char *buf, size_t count)
5147{
5148 struct workqueue_struct *wq = dev_to_wq(dev);
5149 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005150 int ret = -ENOMEM;
5151
5152 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005153
5154 attrs = wq_sysfs_prep_attrs(wq);
5155 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005156 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005157
5158 ret = cpumask_parse(buf, attrs->cpumask);
5159 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005160 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005161
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005162out_unlock:
5163 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005164 free_workqueue_attrs(attrs);
5165 return ret ?: count;
5166}
5167
5168static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5169 char *buf)
5170{
5171 struct workqueue_struct *wq = dev_to_wq(dev);
5172 int written;
5173
5174 mutex_lock(&wq->mutex);
5175 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5176 !wq->unbound_attrs->no_numa);
5177 mutex_unlock(&wq->mutex);
5178
5179 return written;
5180}
5181
5182static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5183 const char *buf, size_t count)
5184{
5185 struct workqueue_struct *wq = dev_to_wq(dev);
5186 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005187 int v, ret = -ENOMEM;
5188
5189 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005190
5191 attrs = wq_sysfs_prep_attrs(wq);
5192 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005193 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005194
5195 ret = -EINVAL;
5196 if (sscanf(buf, "%d", &v) == 1) {
5197 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005198 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005199 }
5200
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005201out_unlock:
5202 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005203 free_workqueue_attrs(attrs);
5204 return ret ?: count;
5205}
5206
5207static struct device_attribute wq_sysfs_unbound_attrs[] = {
5208 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5209 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5210 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5211 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5212 __ATTR_NULL,
5213};
5214
5215static struct bus_type wq_subsys = {
5216 .name = "workqueue",
5217 .dev_groups = wq_sysfs_groups,
5218};
5219
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005220static ssize_t wq_unbound_cpumask_show(struct device *dev,
5221 struct device_attribute *attr, char *buf)
5222{
5223 int written;
5224
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005225 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005226 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5227 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005228 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005229
5230 return written;
5231}
5232
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005233static ssize_t wq_unbound_cpumask_store(struct device *dev,
5234 struct device_attribute *attr, const char *buf, size_t count)
5235{
5236 cpumask_var_t cpumask;
5237 int ret;
5238
5239 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5240 return -ENOMEM;
5241
5242 ret = cpumask_parse(buf, cpumask);
5243 if (!ret)
5244 ret = workqueue_set_unbound_cpumask(cpumask);
5245
5246 free_cpumask_var(cpumask);
5247 return ret ? ret : count;
5248}
5249
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005250static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df12015-04-30 17:16:12 +08005251 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5252 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005253
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005254static int __init wq_sysfs_init(void)
5255{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005256 int err;
5257
5258 err = subsys_virtual_register(&wq_subsys, NULL);
5259 if (err)
5260 return err;
5261
5262 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005263}
5264core_initcall(wq_sysfs_init);
5265
5266static void wq_device_release(struct device *dev)
5267{
5268 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5269
5270 kfree(wq_dev);
5271}
5272
5273/**
5274 * workqueue_sysfs_register - make a workqueue visible in sysfs
5275 * @wq: the workqueue to register
5276 *
5277 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5278 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5279 * which is the preferred method.
5280 *
5281 * Workqueue user should use this function directly iff it wants to apply
5282 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5283 * apply_workqueue_attrs() may race against userland updating the
5284 * attributes.
5285 *
5286 * Return: 0 on success, -errno on failure.
5287 */
5288int workqueue_sysfs_register(struct workqueue_struct *wq)
5289{
5290 struct wq_device *wq_dev;
5291 int ret;
5292
5293 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305294 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005295 * attributes breaks ordering guarantee. Disallow exposing ordered
5296 * workqueues.
5297 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005298 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005299 return -EINVAL;
5300
5301 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5302 if (!wq_dev)
5303 return -ENOMEM;
5304
5305 wq_dev->wq = wq;
5306 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005307 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005308 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005309
5310 /*
5311 * unbound_attrs are created separately. Suppress uevent until
5312 * everything is ready.
5313 */
5314 dev_set_uevent_suppress(&wq_dev->dev, true);
5315
5316 ret = device_register(&wq_dev->dev);
5317 if (ret) {
5318 kfree(wq_dev);
5319 wq->wq_dev = NULL;
5320 return ret;
5321 }
5322
5323 if (wq->flags & WQ_UNBOUND) {
5324 struct device_attribute *attr;
5325
5326 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5327 ret = device_create_file(&wq_dev->dev, attr);
5328 if (ret) {
5329 device_unregister(&wq_dev->dev);
5330 wq->wq_dev = NULL;
5331 return ret;
5332 }
5333 }
5334 }
5335
5336 dev_set_uevent_suppress(&wq_dev->dev, false);
5337 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5338 return 0;
5339}
5340
5341/**
5342 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5343 * @wq: the workqueue to unregister
5344 *
5345 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5346 */
5347static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5348{
5349 struct wq_device *wq_dev = wq->wq_dev;
5350
5351 if (!wq->wq_dev)
5352 return;
5353
5354 wq->wq_dev = NULL;
5355 device_unregister(&wq_dev->dev);
5356}
5357#else /* CONFIG_SYSFS */
5358static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5359#endif /* CONFIG_SYSFS */
5360
Tejun Heo82607adc2015-12-08 11:28:04 -05005361/*
5362 * Workqueue watchdog.
5363 *
5364 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5365 * flush dependency, a concurrency managed work item which stays RUNNING
5366 * indefinitely. Workqueue stalls can be very difficult to debug as the
5367 * usual warning mechanisms don't trigger and internal workqueue state is
5368 * largely opaque.
5369 *
5370 * Workqueue watchdog monitors all worker pools periodically and dumps
5371 * state if some pools failed to make forward progress for a while where
5372 * forward progress is defined as the first item on ->worklist changing.
5373 *
5374 * This mechanism is controlled through the kernel parameter
5375 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5376 * corresponding sysfs parameter file.
5377 */
5378#ifdef CONFIG_WQ_WATCHDOG
5379
5380static void wq_watchdog_timer_fn(unsigned long data);
5381
5382static unsigned long wq_watchdog_thresh = 30;
5383static struct timer_list wq_watchdog_timer =
5384 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5385
5386static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5387static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5388
5389static void wq_watchdog_reset_touched(void)
5390{
5391 int cpu;
5392
5393 wq_watchdog_touched = jiffies;
5394 for_each_possible_cpu(cpu)
5395 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5396}
5397
5398static void wq_watchdog_timer_fn(unsigned long data)
5399{
5400 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5401 bool lockup_detected = false;
5402 struct worker_pool *pool;
5403 int pi;
5404
5405 if (!thresh)
5406 return;
5407
5408 rcu_read_lock();
5409
5410 for_each_pool(pool, pi) {
5411 unsigned long pool_ts, touched, ts;
5412
5413 if (list_empty(&pool->worklist))
5414 continue;
5415
5416 /* get the latest of pool and touched timestamps */
5417 pool_ts = READ_ONCE(pool->watchdog_ts);
5418 touched = READ_ONCE(wq_watchdog_touched);
5419
5420 if (time_after(pool_ts, touched))
5421 ts = pool_ts;
5422 else
5423 ts = touched;
5424
5425 if (pool->cpu >= 0) {
5426 unsigned long cpu_touched =
5427 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5428 pool->cpu));
5429 if (time_after(cpu_touched, ts))
5430 ts = cpu_touched;
5431 }
5432
5433 /* did we stall? */
5434 if (time_after(jiffies, ts + thresh)) {
5435 lockup_detected = true;
5436 pr_emerg("BUG: workqueue lockup - pool");
5437 pr_cont_pool_info(pool);
5438 pr_cont(" stuck for %us!\n",
5439 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5440 }
5441 }
5442
5443 rcu_read_unlock();
5444
5445 if (lockup_detected)
5446 show_workqueue_state();
5447
5448 wq_watchdog_reset_touched();
5449 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5450}
5451
5452void wq_watchdog_touch(int cpu)
5453{
5454 if (cpu >= 0)
5455 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5456 else
5457 wq_watchdog_touched = jiffies;
5458}
5459
5460static void wq_watchdog_set_thresh(unsigned long thresh)
5461{
5462 wq_watchdog_thresh = 0;
5463 del_timer_sync(&wq_watchdog_timer);
5464
5465 if (thresh) {
5466 wq_watchdog_thresh = thresh;
5467 wq_watchdog_reset_touched();
5468 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5469 }
5470}
5471
5472static int wq_watchdog_param_set_thresh(const char *val,
5473 const struct kernel_param *kp)
5474{
5475 unsigned long thresh;
5476 int ret;
5477
5478 ret = kstrtoul(val, 0, &thresh);
5479 if (ret)
5480 return ret;
5481
5482 if (system_wq)
5483 wq_watchdog_set_thresh(thresh);
5484 else
5485 wq_watchdog_thresh = thresh;
5486
5487 return 0;
5488}
5489
5490static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5491 .set = wq_watchdog_param_set_thresh,
5492 .get = param_get_ulong,
5493};
5494
5495module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5496 0644);
5497
5498static void wq_watchdog_init(void)
5499{
5500 wq_watchdog_set_thresh(wq_watchdog_thresh);
5501}
5502
5503#else /* CONFIG_WQ_WATCHDOG */
5504
5505static inline void wq_watchdog_init(void) { }
5506
5507#endif /* CONFIG_WQ_WATCHDOG */
5508
Tejun Heobce90382013-04-01 11:23:32 -07005509static void __init wq_numa_init(void)
5510{
5511 cpumask_var_t *tbl;
5512 int node, cpu;
5513
Tejun Heobce90382013-04-01 11:23:32 -07005514 if (num_possible_nodes() <= 1)
5515 return;
5516
Tejun Heod55262c2013-04-01 11:23:38 -07005517 if (wq_disable_numa) {
5518 pr_info("workqueue: NUMA affinity support disabled\n");
5519 return;
5520 }
5521
Tejun Heo4c16bd32013-04-01 11:23:36 -07005522 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5523 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5524
Tejun Heobce90382013-04-01 11:23:32 -07005525 /*
5526 * We want masks of possible CPUs of each node which isn't readily
5527 * available. Build one from cpu_to_node() which should have been
5528 * fully initialized by now.
5529 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005530 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005531 BUG_ON(!tbl);
5532
5533 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005534 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005535 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005536
5537 for_each_possible_cpu(cpu) {
5538 node = cpu_to_node(cpu);
5539 if (WARN_ON(node == NUMA_NO_NODE)) {
5540 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5541 /* happens iff arch is bonkers, let's just proceed */
5542 return;
5543 }
5544 cpumask_set_cpu(cpu, tbl[node]);
5545 }
5546
5547 wq_numa_possible_cpumask = tbl;
5548 wq_numa_enabled = true;
5549}
5550
Tejun Heo3347fa02016-09-16 15:49:32 -04005551/**
5552 * workqueue_init_early - early init for workqueue subsystem
5553 *
5554 * This is the first half of two-staged workqueue subsystem initialization
5555 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5556 * idr are up. It sets up all the data structures and system workqueues
5557 * and allows early boot code to create workqueues and queue/cancel work
5558 * items. Actual work item execution starts only after kthreads can be
5559 * created and scheduled right before early initcalls.
5560 */
5561int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005562{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005563 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5564 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005565
Tejun Heoe904e6c2013-03-12 11:29:57 -07005566 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5567
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005568 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5569 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5570
Tejun Heoe904e6c2013-03-12 11:29:57 -07005571 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5572
Tejun Heo706026c2013-01-24 11:01:34 -08005573 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005574 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005575 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005576
Tejun Heo7a4e3442013-03-12 11:30:00 -07005577 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005578 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005579 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005580 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005581 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005582 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005583 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005584
Tejun Heo9daf9e62013-01-24 11:01:33 -08005585 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005586 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005587 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005588 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005589 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005590 }
5591
Tejun Heo8a2b7532013-09-05 12:30:04 -04005592 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005593 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5594 struct workqueue_attrs *attrs;
5595
5596 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005597 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005598 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005599
5600 /*
5601 * An ordered wq should have only one pwq as ordering is
5602 * guaranteed by max_active which is enforced by pwqs.
5603 * Turn off NUMA so that dfl_pwq is used for all nodes.
5604 */
5605 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5606 attrs->nice = std_nice[i];
5607 attrs->no_numa = true;
5608 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005609 }
5610
Tejun Heod320c032010-06-29 10:07:14 +02005611 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005612 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005613 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005614 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5615 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005616 system_freezable_wq = alloc_workqueue("events_freezable",
5617 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305618 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5619 WQ_POWER_EFFICIENT, 0);
5620 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5621 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5622 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005623 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305624 !system_unbound_wq || !system_freezable_wq ||
5625 !system_power_efficient_wq ||
5626 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005627
Tejun Heo3347fa02016-09-16 15:49:32 -04005628 return 0;
5629}
5630
5631/**
5632 * workqueue_init - bring workqueue subsystem fully online
5633 *
5634 * This is the latter half of two-staged workqueue subsystem initialization
5635 * and invoked as soon as kthreads can be created and scheduled.
5636 * Workqueues have been created and work items queued on them, but there
5637 * are no kworkers executing the work items yet. Populate the worker pools
5638 * with the initial workers and enable future kworker creations.
5639 */
5640int __init workqueue_init(void)
5641{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005642 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005643 struct worker_pool *pool;
5644 int cpu, bkt;
5645
Tejun Heo2186d9f2016-10-19 12:01:27 -04005646 /*
5647 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5648 * CPU to node mapping may not be available that early on some
5649 * archs such as power and arm64. As per-cpu pools created
5650 * previously could be missing node hint and unbound pools NUMA
5651 * affinity, fix them up.
5652 */
5653 wq_numa_init();
5654
5655 mutex_lock(&wq_pool_mutex);
5656
5657 for_each_possible_cpu(cpu) {
5658 for_each_cpu_worker_pool(pool, cpu) {
5659 pool->node = cpu_to_node(cpu);
5660 }
5661 }
5662
5663 list_for_each_entry(wq, &workqueues, list)
5664 wq_update_unbound_numa(wq, smp_processor_id(), true);
5665
5666 mutex_unlock(&wq_pool_mutex);
5667
Tejun Heo3347fa02016-09-16 15:49:32 -04005668 /* create the initial workers */
5669 for_each_online_cpu(cpu) {
5670 for_each_cpu_worker_pool(pool, cpu) {
5671 pool->flags &= ~POOL_DISASSOCIATED;
5672 BUG_ON(!create_worker(pool));
5673 }
5674 }
5675
5676 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5677 BUG_ON(!create_worker(pool));
5678
5679 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005680 wq_watchdog_init();
5681
Suresh Siddha6ee05782010-07-30 14:57:37 -07005682 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005683}