blob: df96f797939e47092d08a5b816db05abdbd6dc8c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
24 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +090051#include <linux/nmi.h>
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +090052#include <linux/kvm_para.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020053
Tejun Heoea138442013-01-18 14:05:55 -080054#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Tejun Heoc8e55f32010-06-29 10:07:12 +020056enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 /*
Tejun Heo24647572013-01-24 11:01:33 -080058 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 *
Tejun Heo24647572013-01-24 11:01:33 -080060 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070061 * While associated (!DISASSOCIATED), all workers are bound to the
62 * CPU and none has %WORKER_UNBOUND set and concurrency management
63 * is in effect.
64 *
65 * While DISASSOCIATED, the cpu may be offline and all workers have
66 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080067 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070068 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070069 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080070 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080071 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070072 */
Tejun Heo43a980a2017-10-09 08:04:13 -070073 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080074 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020075
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020077 WORKER_DIE = 1 << 1, /* die die die */
78 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020079 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020080 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020081 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070082 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020083
Tejun Heoa9ab7752013-03-19 13:45:21 -070084 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
85 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020086
Tejun Heoe34cdddb2013-01-24 11:01:33 -080087 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070088
Tejun Heo29c91e92013-03-12 11:30:03 -070089 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020090 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020091
Tejun Heoe22bee72010-06-29 10:07:14 +020092 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
93 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
94
Tejun Heo3233cdb2011-02-16 18:10:19 +010095 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
96 /* call for help after 10ms
97 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020098 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
99 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +0200100
101 /*
102 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800103 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200104 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800105 RESCUER_NICE_LEVEL = MIN_NICE,
106 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700107
108 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200109};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200112 * Structure fields follow one of the following exclusion rules.
113 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200114 * I: Modifiable by initialization/destruction paths and read-only for
115 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200116 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200117 * P: Preemption protected. Disabling preemption is enough and should
118 * only be modified and accessed from the local cpu.
119 *
Tejun Heod565ed62013-01-24 11:01:33 -0800120 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200121 *
Tejun Heod565ed62013-01-24 11:01:33 -0800122 * X: During normal operation, modification requires pool->lock and should
123 * be done only from local cpu. Either disabling preemption on local
124 * cpu or grabbing pool->lock is enough for read access. If
125 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200126 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800127 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700128 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700129 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700130 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700131 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700132 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800133 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
134 *
135 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
136 * sched-RCU for reads.
137 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700138 * WQ: wq->mutex protected.
139 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700140 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700141 *
142 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200143 */
144
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800145/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200146
Tejun Heobd7bdd42012-07-12 14:46:37 -0700147struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800148 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700149 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700150 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800151 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700152 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700153
Tejun Heo82607adc2015-12-08 11:28:04 -0500154 unsigned long watchdog_ts; /* L: watchdog timestamp */
155
Tejun Heobd7bdd42012-07-12 14:46:37 -0700156 struct list_head worklist; /* L: list of pending works */
157 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700158
159 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700160 int nr_idle; /* L: currently idle ones */
161
162 struct list_head idle_list; /* X: list of idle workers */
163 struct timer_list idle_timer; /* L: worker idle timeout */
164 struct timer_list mayday_timer; /* L: SOS timer for workers */
165
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700166 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800167 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
168 /* L: hash of busy workers */
169
Tejun Heobc3a1af2013-03-13 19:47:39 -0700170 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo2607d7a2015-03-09 09:22:28 -0400171 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800172 struct mutex attach_mutex; /* attach/detach exclusion */
173 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800174 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800175
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800176 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800177
Tejun Heo7a4e3442013-03-12 11:30:00 -0700178 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700179 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
180 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700181
Tejun Heoe19e3972013-01-24 11:39:44 -0800182 /*
183 * The current concurrency level. As it's likely to be accessed
184 * from other CPUs during try_to_wake_up(), put it in a separate
185 * cacheline.
186 */
187 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700188
189 /*
190 * Destruction of pool is sched-RCU protected to allow dereferences
191 * from get_work_pool().
192 */
193 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200194} ____cacheline_aligned_in_smp;
195
196/*
Tejun Heo112202d2013-02-13 19:29:12 -0800197 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
198 * of work_struct->data are used for flags and the remaining high bits
199 * point to the pwq; thus, pwqs need to be aligned at two's power of the
200 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
Tejun Heo112202d2013-02-13 19:29:12 -0800202struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700203 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200204 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200205 int work_color; /* L: current color */
206 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700207 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200208 int nr_in_flight[WORK_NR_COLORS];
209 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200210 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200211 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200212 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700213 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700214 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700215
216 /*
217 * Release of unbound pwq is punted to system_wq. See put_pwq()
218 * and pwq_unbound_release_workfn() for details. pool_workqueue
219 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700220 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700221 */
222 struct work_struct unbound_release_work;
223 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700224} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200227 * Structure used to wait for workqueue flush.
228 */
229struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700230 struct list_head list; /* WQ: list of flushers */
231 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200232 struct completion done; /* flush completion */
233};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Tejun Heo226223a2013-03-12 11:30:05 -0700235struct wq_device;
236
Tejun Heo73f53c42010-06-29 10:07:11 +0200237/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700238 * The externally visible workqueue. It relays the issued work items to
239 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 */
241struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700242 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400243 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200244
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct mutex mutex; /* protects this wq */
246 int work_color; /* WQ: current work color */
247 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800248 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700249 struct wq_flusher *first_flusher; /* WQ: first flusher */
250 struct list_head flusher_queue; /* WQ: flush waiters */
251 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200252
Tejun Heo2e109a22013-03-13 19:47:40 -0700253 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200254 struct worker *rescuer; /* I: rescue worker */
255
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700256 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700257 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700258
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800259 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
260 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700261
Tejun Heo226223a2013-03-12 11:30:05 -0700262#ifdef CONFIG_SYSFS
263 struct wq_device *wq_dev; /* I: for sysfs interface */
264#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200266 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700267#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700268 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700269
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400270 /*
271 * Destruction of workqueue_struct is sched-RCU protected to allow
272 * walking the workqueues list without grabbing wq_pool_mutex.
273 * This is used to dump all workqueues from sysrq.
274 */
275 struct rcu_head rcu;
276
Tejun Heo2728fd22013-04-01 11:23:35 -0700277 /* hot fields used during command issue, aligned to cacheline */
278 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
279 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800280 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
Tejun Heoe904e6c2013-03-12 11:29:57 -0700283static struct kmem_cache *pwq_cache;
284
Tejun Heobce90382013-04-01 11:23:32 -0700285static cpumask_var_t *wq_numa_possible_cpumask;
286 /* possible CPUs of each node */
287
Tejun Heod55262c2013-04-01 11:23:38 -0700288static bool wq_disable_numa;
289module_param_named(disable_numa, wq_disable_numa, bool, 0444);
290
Viresh Kumarcee22a12013-04-08 16:45:40 +0530291/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930292static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530293module_param_named(power_efficient, wq_power_efficient, bool, 0444);
294
Tejun Heoac4bbc02016-09-16 15:49:32 -0400295bool wq_online; /* can kworkers be created yet? */
296
Tejun Heobce90382013-04-01 11:23:32 -0700297static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
298
Tejun Heo4c16bd32013-04-01 11:23:36 -0700299/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
300static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
301
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700302static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700303static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo43a980a2017-10-09 08:04:13 -0700304static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700305
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400306static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700307static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700308
Mike Galbraithef5571802016-02-09 17:59:38 -0500309/* PL: allowable cpus for unbound wqs and work items */
310static cpumask_var_t wq_unbound_cpumask;
311
312/* CPU where unbound work was last round robin scheduled from this CPU */
313static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800314
Tejun Heof303fcc2016-02-09 17:59:38 -0500315/*
316 * Local execution of unbound work items is no longer guaranteed. The
317 * following always forces round-robin CPU selection on unbound work items
318 * to uncover usages which depend on it.
319 */
320#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
321static bool wq_debug_force_rr_cpu = true;
322#else
323static bool wq_debug_force_rr_cpu = false;
324#endif
325module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
326
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700327/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700328static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700329
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700330static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700331
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700332/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700333static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
334
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700335/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700336static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
337
Tejun Heo8a2b7532013-09-05 12:30:04 -0400338/* I: attributes used when instantiating ordered pools on demand */
339static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
340
Tejun Heod320c032010-06-29 10:07:14 +0200341struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400342EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300343struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900344EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300345struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200346EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300347struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200348EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300349struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100350EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530351struct workqueue_struct *system_power_efficient_wq __read_mostly;
352EXPORT_SYMBOL_GPL(system_power_efficient_wq);
353struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
354EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200355
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700356static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800357static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700358
Tejun Heo97bd2342010-10-05 10:41:14 +0200359#define CREATE_TRACE_POINTS
360#include <trace/events/workqueue.h>
361
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700362#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700363 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
364 !lockdep_is_held(&wq_pool_mutex), \
365 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700366
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700367#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700368 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
369 !lockdep_is_held(&wq->mutex), \
370 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700371
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800372#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700373 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
374 !lockdep_is_held(&wq->mutex) && \
375 !lockdep_is_held(&wq_pool_mutex), \
376 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800377
Tejun Heof02ae732013-03-12 11:30:03 -0700378#define for_each_cpu_worker_pool(pool, cpu) \
379 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
380 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700381 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700382
Tejun Heo49e3cf42013-03-12 11:29:58 -0700383/**
Tejun Heo17116962013-03-12 11:29:58 -0700384 * for_each_pool - iterate through all worker_pools in the system
385 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700386 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700387 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700388 * This must be called either with wq_pool_mutex held or sched RCU read
389 * locked. If the pool needs to be used beyond the locking in effect, the
390 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700391 *
392 * The if/else clause exists only for the lockdep assertion and can be
393 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700394 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700395#define for_each_pool(pool, pi) \
396 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700397 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700398 else
Tejun Heo17116962013-03-12 11:29:58 -0700399
400/**
Tejun Heo822d8402013-03-19 13:45:21 -0700401 * for_each_pool_worker - iterate through all workers of a worker_pool
402 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700403 * @pool: worker_pool to iterate workers of
404 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800405 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700406 *
407 * The if/else clause exists only for the lockdep assertion and can be
408 * ignored.
409 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800410#define for_each_pool_worker(worker, pool) \
411 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800412 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700413 else
414
415/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700416 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
417 * @pwq: iteration cursor
418 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700419 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700420 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700421 * If the pwq needs to be used beyond the locking in effect, the caller is
422 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700423 *
424 * The if/else clause exists only for the lockdep assertion and can be
425 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700426 */
427#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700428 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700429 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700430 else
Tejun Heof3421792010-07-02 10:03:51 +0200431
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900432#ifdef CONFIG_DEBUG_OBJECTS_WORK
433
434static struct debug_obj_descr work_debug_descr;
435
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100436static void *work_debug_hint(void *addr)
437{
438 return ((struct work_struct *) addr)->func;
439}
440
Du, Changbinb9fdac72016-05-19 17:09:41 -0700441static bool work_is_static_object(void *addr)
442{
443 struct work_struct *work = addr;
444
445 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
446}
447
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900448/*
449 * fixup_init is called when:
450 * - an active object is initialized
451 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700452static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900453{
454 struct work_struct *work = addr;
455
456 switch (state) {
457 case ODEBUG_STATE_ACTIVE:
458 cancel_work_sync(work);
459 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700460 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900461 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700462 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900463 }
464}
465
466/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900467 * fixup_free is called when:
468 * - an active object is freed
469 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700470static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900471{
472 struct work_struct *work = addr;
473
474 switch (state) {
475 case ODEBUG_STATE_ACTIVE:
476 cancel_work_sync(work);
477 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700478 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900479 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700480 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900481 }
482}
483
484static struct debug_obj_descr work_debug_descr = {
485 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100486 .debug_hint = work_debug_hint,
Du, Changbinb9fdac72016-05-19 17:09:41 -0700487 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900488 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900489 .fixup_free = work_fixup_free,
490};
491
492static inline void debug_work_activate(struct work_struct *work)
493{
494 debug_object_activate(work, &work_debug_descr);
495}
496
497static inline void debug_work_deactivate(struct work_struct *work)
498{
499 debug_object_deactivate(work, &work_debug_descr);
500}
501
502void __init_work(struct work_struct *work, int onstack)
503{
504 if (onstack)
505 debug_object_init_on_stack(work, &work_debug_descr);
506 else
507 debug_object_init(work, &work_debug_descr);
508}
509EXPORT_SYMBOL_GPL(__init_work);
510
511void destroy_work_on_stack(struct work_struct *work)
512{
513 debug_object_free(work, &work_debug_descr);
514}
515EXPORT_SYMBOL_GPL(destroy_work_on_stack);
516
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000517void destroy_delayed_work_on_stack(struct delayed_work *work)
518{
519 destroy_timer_on_stack(&work->timer);
520 debug_object_free(&work->work, &work_debug_descr);
521}
522EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
523
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900524#else
525static inline void debug_work_activate(struct work_struct *work) { }
526static inline void debug_work_deactivate(struct work_struct *work) { }
527#endif
528
Li Bin4e8b22b2013-09-10 09:52:35 +0800529/**
530 * worker_pool_assign_id - allocate ID and assing it to @pool
531 * @pool: the pool pointer of interest
532 *
533 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
534 * successfully, -errno on failure.
535 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800536static int worker_pool_assign_id(struct worker_pool *pool)
537{
538 int ret;
539
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700540 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700541
Li Bin4e8b22b2013-09-10 09:52:35 +0800542 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
543 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700544 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700545 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700546 return 0;
547 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800548 return ret;
549}
550
Tejun Heo76af4d92013-03-12 11:30:00 -0700551/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700552 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
553 * @wq: the target workqueue
554 * @node: the node ID
555 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800556 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
557 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700558 * If the pwq needs to be used beyond the locking in effect, the caller is
559 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700560 *
561 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700562 */
563static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
564 int node)
565{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800566 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500567
568 /*
569 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
570 * delayed item is pending. The plan is to keep CPU -> NODE
571 * mapping valid and stable across CPU on/offlines. Once that
572 * happens, this workaround can be removed.
573 */
574 if (unlikely(node == NUMA_NO_NODE))
575 return wq->dfl_pwq;
576
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700577 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
578}
579
Tejun Heo73f53c42010-06-29 10:07:11 +0200580static unsigned int work_color_to_flags(int color)
581{
582 return color << WORK_STRUCT_COLOR_SHIFT;
583}
584
585static int get_work_color(struct work_struct *work)
586{
587 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
588 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
589}
590
591static int work_next_color(int color)
592{
593 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700594}
595
David Howells4594bf12006-12-07 11:33:26 +0000596/*
Tejun Heo112202d2013-02-13 19:29:12 -0800597 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
598 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800599 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200600 *
Tejun Heo112202d2013-02-13 19:29:12 -0800601 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
602 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700603 * work->data. These functions should only be called while the work is
604 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605 *
Tejun Heo112202d2013-02-13 19:29:12 -0800606 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800607 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800608 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800609 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700610 *
611 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
612 * canceled. While being canceled, a work item may have its PENDING set
613 * but stay off timer and worklist for arbitrarily long and nobody should
614 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000615 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200616static inline void set_work_data(struct work_struct *work, unsigned long data,
617 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000618{
Tejun Heo6183c002013-03-12 11:29:57 -0700619 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200620 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000621}
David Howells365970a2006-11-22 14:54:49 +0000622
Tejun Heo112202d2013-02-13 19:29:12 -0800623static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200624 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200625{
Tejun Heo112202d2013-02-13 19:29:12 -0800626 set_work_data(work, (unsigned long)pwq,
627 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200628}
629
Lai Jiangshan4468a002013-02-06 18:04:53 -0800630static void set_work_pool_and_keep_pending(struct work_struct *work,
631 int pool_id)
632{
633 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
634 WORK_STRUCT_PENDING);
635}
636
Tejun Heo7c3eed52013-01-24 11:01:33 -0800637static void set_work_pool_and_clear_pending(struct work_struct *work,
638 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000639{
Tejun Heo23657bb2012-08-13 17:08:19 -0700640 /*
641 * The following wmb is paired with the implied mb in
642 * test_and_set_bit(PENDING) and ensures all updates to @work made
643 * here are visible to and precede any updates by the next PENDING
644 * owner.
645 */
646 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800647 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200648 /*
649 * The following mb guarantees that previous clear of a PENDING bit
650 * will not be reordered with any speculative LOADS or STORES from
651 * work->current_func, which is executed afterwards. This possible
652 * reordering can lead to a missed execution on attempt to qeueue
653 * the same @work. E.g. consider this case:
654 *
655 * CPU#0 CPU#1
656 * ---------------------------- --------------------------------
657 *
658 * 1 STORE event_indicated
659 * 2 queue_work_on() {
660 * 3 test_and_set_bit(PENDING)
661 * 4 } set_..._and_clear_pending() {
662 * 5 set_work_data() # clear bit
663 * 6 smp_mb()
664 * 7 work->current_func() {
665 * 8 LOAD event_indicated
666 * }
667 *
668 * Without an explicit full barrier speculative LOAD on line 8 can
669 * be executed before CPU#0 does STORE on line 1. If that happens,
670 * CPU#0 observes the PENDING bit is still set and new execution of
671 * a @work is not queued in a hope, that CPU#1 will eventually
672 * finish the queued @work. Meanwhile CPU#1 does not see
673 * event_indicated is set, because speculative LOAD was executed
674 * before actual STORE.
675 */
676 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200677}
678
679static void clear_work_data(struct work_struct *work)
680{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800681 smp_wmb(); /* see set_work_pool_and_clear_pending() */
682 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200683}
684
Tejun Heo112202d2013-02-13 19:29:12 -0800685static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200686{
Tejun Heoe1201532010-07-22 14:14:25 +0200687 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200688
Tejun Heo112202d2013-02-13 19:29:12 -0800689 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200690 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
691 else
692 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200693}
694
Tejun Heo7c3eed52013-01-24 11:01:33 -0800695/**
696 * get_work_pool - return the worker_pool a given work was associated with
697 * @work: the work item of interest
698 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700699 * Pools are created and destroyed under wq_pool_mutex, and allows read
700 * access under sched-RCU read lock. As such, this function should be
701 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700702 *
703 * All fields of the returned pool are accessible as long as the above
704 * mentioned locking is in effect. If the returned pool needs to be used
705 * beyond the critical section, the caller is responsible for ensuring the
706 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700707 *
708 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800709 */
710static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200711{
Tejun Heoe1201532010-07-22 14:14:25 +0200712 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800713 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200714
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700715 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700716
Tejun Heo112202d2013-02-13 19:29:12 -0800717 if (data & WORK_STRUCT_PWQ)
718 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800719 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200720
Tejun Heo7c3eed52013-01-24 11:01:33 -0800721 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
722 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200723 return NULL;
724
Tejun Heofa1b54e2013-03-12 11:30:00 -0700725 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800726}
727
728/**
729 * get_work_pool_id - return the worker pool ID a given work is associated with
730 * @work: the work item of interest
731 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700732 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800733 * %WORK_OFFQ_POOL_NONE if none.
734 */
735static int get_work_pool_id(struct work_struct *work)
736{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800737 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800738
Tejun Heo112202d2013-02-13 19:29:12 -0800739 if (data & WORK_STRUCT_PWQ)
740 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800741 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
742
743 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800744}
745
Tejun Heobbb68df2012-08-03 10:30:46 -0700746static void mark_work_canceling(struct work_struct *work)
747{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800748 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700749
Tejun Heo7c3eed52013-01-24 11:01:33 -0800750 pool_id <<= WORK_OFFQ_POOL_SHIFT;
751 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700752}
753
754static bool work_is_canceling(struct work_struct *work)
755{
756 unsigned long data = atomic_long_read(&work->data);
757
Tejun Heo112202d2013-02-13 19:29:12 -0800758 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700759}
760
David Howells365970a2006-11-22 14:54:49 +0000761/*
Tejun Heo32704762012-07-13 22:16:45 -0700762 * Policy functions. These define the policies on how the global worker
763 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800764 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000765 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200766
Tejun Heo63d95a92012-07-12 14:46:37 -0700767static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000768{
Tejun Heoe19e3972013-01-24 11:39:44 -0800769 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000770}
771
Tejun Heoe22bee72010-06-29 10:07:14 +0200772/*
773 * Need to wake up a worker? Called from anything but currently
774 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700775 *
776 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800777 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700778 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200779 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700780static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000781{
Tejun Heo63d95a92012-07-12 14:46:37 -0700782 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000783}
784
Tejun Heoe22bee72010-06-29 10:07:14 +0200785/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700786static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200787{
Tejun Heo63d95a92012-07-12 14:46:37 -0700788 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200789}
790
791/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700792static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200793{
Tejun Heoe19e3972013-01-24 11:39:44 -0800794 return !list_empty(&pool->worklist) &&
795 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200796}
797
798/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700799static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200800{
Tejun Heo63d95a92012-07-12 14:46:37 -0700801 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200802}
803
Tejun Heoe22bee72010-06-29 10:07:14 +0200804/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700805static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200806{
Tejun Heo43a980a2017-10-09 08:04:13 -0700807 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700808 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
809 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200810
811 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
812}
813
814/*
815 * Wake up functions.
816 */
817
Lai Jiangshan1037de32014-05-22 16:44:07 +0800818/* Return the first idle worker. Safe with preemption disabled */
819static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200820{
Tejun Heo63d95a92012-07-12 14:46:37 -0700821 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200822 return NULL;
823
Tejun Heo63d95a92012-07-12 14:46:37 -0700824 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200825}
826
827/**
828 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700829 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200830 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700831 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200832 *
833 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800834 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200835 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700836static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200837{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800838 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200839
840 if (likely(worker))
841 wake_up_process(worker->task);
842}
843
Tejun Heo4690c4a2010-06-29 10:07:10 +0200844/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200845 * wq_worker_waking_up - a worker is waking up
846 * @task: task waking up
847 * @cpu: CPU @task is waking up to
848 *
849 * This function is called during try_to_wake_up() when a worker is
850 * being awoken.
851 *
852 * CONTEXT:
853 * spin_lock_irq(rq->lock)
854 */
Tejun Heod84ff052013-03-12 11:29:59 -0700855void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200856{
857 struct worker *worker = kthread_data(task);
858
Joonsoo Kim36576002012-10-26 23:03:49 +0900859 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800860 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800861 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900862 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200863}
864
865/**
866 * wq_worker_sleeping - a worker is going to sleep
867 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200868 *
869 * This function is called during schedule() when a busy worker is
870 * going to sleep. Worker on the same cpu can be woken up by
871 * returning pointer to its task.
872 *
873 * CONTEXT:
874 * spin_lock_irq(rq->lock)
875 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700876 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200877 * Worker task on @cpu to wake up, %NULL if none.
878 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100879struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200880{
881 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800882 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200883
Tejun Heo111c2252013-01-17 17:16:24 -0800884 /*
885 * Rescuers, which may not have all the fields set up like normal
886 * workers, also reach here, let's not access anything before
887 * checking NOT_RUNNING.
888 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500889 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200890 return NULL;
891
Tejun Heo111c2252013-01-17 17:16:24 -0800892 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800893
Tejun Heoe22bee72010-06-29 10:07:14 +0200894 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100895 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700896 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200897
898 /*
899 * The counterpart of the following dec_and_test, implied mb,
900 * worklist not empty test sequence is in insert_work().
901 * Please read comment there.
902 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700903 * NOT_RUNNING is clear. This means that we're bound to and
904 * running on the local cpu w/ rq lock held and preemption
905 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800906 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700907 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200908 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800909 if (atomic_dec_and_test(&pool->nr_running) &&
910 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800911 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200912 return to_wakeup ? to_wakeup->task : NULL;
913}
914
915/**
916 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200917 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200918 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200919 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800920 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200921 *
Tejun Heocb444762010-07-02 10:03:50 +0200922 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800923 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200924 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800925static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200926{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700927 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200928
Tejun Heocb444762010-07-02 10:03:50 +0200929 WARN_ON_ONCE(worker->task != current);
930
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800931 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200932 if ((flags & WORKER_NOT_RUNNING) &&
933 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800934 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200935 }
936
Tejun Heod302f012010-06-29 10:07:13 +0200937 worker->flags |= flags;
938}
939
940/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200941 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200942 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200943 * @flags: flags to clear
944 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200945 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200946 *
Tejun Heocb444762010-07-02 10:03:50 +0200947 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800948 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200949 */
950static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
951{
Tejun Heo63d95a92012-07-12 14:46:37 -0700952 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200953 unsigned int oflags = worker->flags;
954
Tejun Heocb444762010-07-02 10:03:50 +0200955 WARN_ON_ONCE(worker->task != current);
956
Tejun Heod302f012010-06-29 10:07:13 +0200957 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200958
Tejun Heo42c025f2011-01-11 15:58:49 +0100959 /*
960 * If transitioning out of NOT_RUNNING, increment nr_running. Note
961 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
962 * of multiple flags, not a single flag.
963 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200964 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
965 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800966 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200967}
968
969/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200970 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800971 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200972 * @work: work to find worker for
973 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800974 * Find a worker which is executing @work on @pool by searching
975 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800976 * to match, its current execution should match the address of @work and
977 * its work function. This is to avoid unwanted dependency between
978 * unrelated work executions through a work item being recycled while still
979 * being executed.
980 *
981 * This is a bit tricky. A work item may be freed once its execution
982 * starts and nothing prevents the freed area from being recycled for
983 * another work item. If the same work item address ends up being reused
984 * before the original execution finishes, workqueue will identify the
985 * recycled work item as currently executing and make it wait until the
986 * current execution finishes, introducing an unwanted dependency.
987 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700988 * This function checks the work item address and work function to avoid
989 * false positives. Note that this isn't complete as one may construct a
990 * work function which can introduce dependency onto itself through a
991 * recycled work item. Well, if somebody wants to shoot oneself in the
992 * foot that badly, there's only so much we can do, and if such deadlock
993 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200994 *
995 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800996 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200997 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700998 * Return:
999 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001000 * otherwise.
1001 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001002static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001003 struct work_struct *work)
1004{
Sasha Levin42f85702012-12-17 10:01:23 -05001005 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001006
Sasha Levinb67bfe02013-02-27 17:06:00 -08001007 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001008 (unsigned long)work)
1009 if (worker->current_work == work &&
1010 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001011 return worker;
1012
1013 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001014}
1015
1016/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001017 * move_linked_works - move linked works to a list
1018 * @work: start of series of works to be scheduled
1019 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301020 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001021 *
1022 * Schedule linked works starting from @work to @head. Work series to
1023 * be scheduled starts at @work and includes any consecutive work with
1024 * WORK_STRUCT_LINKED set in its predecessor.
1025 *
1026 * If @nextp is not NULL, it's updated to point to the next work of
1027 * the last scheduled work. This allows move_linked_works() to be
1028 * nested inside outer list_for_each_entry_safe().
1029 *
1030 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001031 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001032 */
1033static void move_linked_works(struct work_struct *work, struct list_head *head,
1034 struct work_struct **nextp)
1035{
1036 struct work_struct *n;
1037
1038 /*
1039 * Linked worklist will always end before the end of the list,
1040 * use NULL for list head.
1041 */
1042 list_for_each_entry_safe_from(work, n, NULL, entry) {
1043 list_move_tail(&work->entry, head);
1044 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1045 break;
1046 }
1047
1048 /*
1049 * If we're already inside safe list traversal and have moved
1050 * multiple works to the scheduled queue, the next position
1051 * needs to be updated.
1052 */
1053 if (nextp)
1054 *nextp = n;
1055}
1056
Tejun Heo8864b4e2013-03-12 11:30:04 -07001057/**
1058 * get_pwq - get an extra reference on the specified pool_workqueue
1059 * @pwq: pool_workqueue to get
1060 *
1061 * Obtain an extra reference on @pwq. The caller should guarantee that
1062 * @pwq has positive refcnt and be holding the matching pool->lock.
1063 */
1064static void get_pwq(struct pool_workqueue *pwq)
1065{
1066 lockdep_assert_held(&pwq->pool->lock);
1067 WARN_ON_ONCE(pwq->refcnt <= 0);
1068 pwq->refcnt++;
1069}
1070
1071/**
1072 * put_pwq - put a pool_workqueue reference
1073 * @pwq: pool_workqueue to put
1074 *
1075 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1076 * destruction. The caller should be holding the matching pool->lock.
1077 */
1078static void put_pwq(struct pool_workqueue *pwq)
1079{
1080 lockdep_assert_held(&pwq->pool->lock);
1081 if (likely(--pwq->refcnt))
1082 return;
1083 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1084 return;
1085 /*
1086 * @pwq can't be released under pool->lock, bounce to
1087 * pwq_unbound_release_workfn(). This never recurses on the same
1088 * pool->lock as this path is taken only for unbound workqueues and
1089 * the release work item is scheduled on a per-cpu workqueue. To
1090 * avoid lockdep warning, unbound pool->locks are given lockdep
1091 * subclass of 1 in get_unbound_pool().
1092 */
1093 schedule_work(&pwq->unbound_release_work);
1094}
1095
Tejun Heodce90d42013-04-01 11:23:35 -07001096/**
1097 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1098 * @pwq: pool_workqueue to put (can be %NULL)
1099 *
1100 * put_pwq() with locking. This function also allows %NULL @pwq.
1101 */
1102static void put_pwq_unlocked(struct pool_workqueue *pwq)
1103{
1104 if (pwq) {
1105 /*
1106 * As both pwqs and pools are sched-RCU protected, the
1107 * following lock operations are safe.
1108 */
1109 spin_lock_irq(&pwq->pool->lock);
1110 put_pwq(pwq);
1111 spin_unlock_irq(&pwq->pool->lock);
1112 }
1113}
1114
Tejun Heo112202d2013-02-13 19:29:12 -08001115static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001116{
Tejun Heo112202d2013-02-13 19:29:12 -08001117 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001118
1119 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001120 if (list_empty(&pwq->pool->worklist))
1121 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001122 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001123 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001124 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001125}
1126
Tejun Heo112202d2013-02-13 19:29:12 -08001127static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001128{
Tejun Heo112202d2013-02-13 19:29:12 -08001129 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001130 struct work_struct, entry);
1131
Tejun Heo112202d2013-02-13 19:29:12 -08001132 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001133}
1134
Tejun Heobf4ede02012-08-03 10:30:46 -07001135/**
Tejun Heo112202d2013-02-13 19:29:12 -08001136 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1137 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001138 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001139 *
1140 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001141 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001142 *
1143 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001144 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001145 */
Tejun Heo112202d2013-02-13 19:29:12 -08001146static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001147{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001148 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001149 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001150 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001151
Tejun Heo112202d2013-02-13 19:29:12 -08001152 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001153
Tejun Heo112202d2013-02-13 19:29:12 -08001154 pwq->nr_active--;
1155 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001156 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001157 if (pwq->nr_active < pwq->max_active)
1158 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001159 }
1160
1161 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001162 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001163 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001164
1165 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001166 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001167 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001168
Tejun Heo112202d2013-02-13 19:29:12 -08001169 /* this pwq is done, clear flush_color */
1170 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001171
1172 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001173 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001174 * will handle the rest.
1175 */
Tejun Heo112202d2013-02-13 19:29:12 -08001176 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1177 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001178out_put:
1179 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001180}
1181
Tejun Heo36e227d2012-08-03 10:30:46 -07001182/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001183 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001184 * @work: work item to steal
1185 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001186 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001187 *
1188 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001189 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001190 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001191 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001192 * 1 if @work was pending and we successfully stole PENDING
1193 * 0 if @work was idle and we claimed PENDING
1194 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001195 * -ENOENT if someone else is canceling @work, this state may persist
1196 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001197 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001198 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001199 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001200 * interrupted while holding PENDING and @work off queue, irq must be
1201 * disabled on entry. This, combined with delayed_work->timer being
1202 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001203 *
1204 * On successful return, >= 0, irq is disabled and the caller is
1205 * responsible for releasing it using local_irq_restore(*@flags).
1206 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001207 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001208 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001209static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1210 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001211{
Tejun Heod565ed62013-01-24 11:01:33 -08001212 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001213 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001214
Tejun Heobbb68df2012-08-03 10:30:46 -07001215 local_irq_save(*flags);
1216
Tejun Heo36e227d2012-08-03 10:30:46 -07001217 /* try to steal the timer if it exists */
1218 if (is_dwork) {
1219 struct delayed_work *dwork = to_delayed_work(work);
1220
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001221 /*
1222 * dwork->timer is irqsafe. If del_timer() fails, it's
1223 * guaranteed that the timer is not queued anywhere and not
1224 * running on the local CPU.
1225 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001226 if (likely(del_timer(&dwork->timer)))
1227 return 1;
1228 }
1229
1230 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001231 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1232 return 0;
1233
1234 /*
1235 * The queueing is in progress, or it is already queued. Try to
1236 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1237 */
Tejun Heod565ed62013-01-24 11:01:33 -08001238 pool = get_work_pool(work);
1239 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001240 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001241
Tejun Heod565ed62013-01-24 11:01:33 -08001242 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001243 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001244 * work->data is guaranteed to point to pwq only while the work
1245 * item is queued on pwq->wq, and both updating work->data to point
1246 * to pwq on queueing and to pool on dequeueing are done under
1247 * pwq->pool->lock. This in turn guarantees that, if work->data
1248 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001249 * item is currently queued on that pool.
1250 */
Tejun Heo112202d2013-02-13 19:29:12 -08001251 pwq = get_work_pwq(work);
1252 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001253 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001254
Tejun Heo16062832013-02-06 18:04:53 -08001255 /*
1256 * A delayed work item cannot be grabbed directly because
1257 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001258 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001259 * management later on and cause stall. Make sure the work
1260 * item is activated before grabbing.
1261 */
1262 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001263 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001264
Tejun Heo16062832013-02-06 18:04:53 -08001265 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001266 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001267
Tejun Heo112202d2013-02-13 19:29:12 -08001268 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001269 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001270
Tejun Heo16062832013-02-06 18:04:53 -08001271 spin_unlock(&pool->lock);
1272 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001273 }
Tejun Heod565ed62013-01-24 11:01:33 -08001274 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001275fail:
1276 local_irq_restore(*flags);
1277 if (work_is_canceling(work))
1278 return -ENOENT;
1279 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001280 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001281}
1282
1283/**
Tejun Heo706026c2013-01-24 11:01:34 -08001284 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001285 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001286 * @work: work to insert
1287 * @head: insertion point
1288 * @extra_flags: extra WORK_STRUCT_* flags to set
1289 *
Tejun Heo112202d2013-02-13 19:29:12 -08001290 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001291 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001292 *
1293 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001294 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001295 */
Tejun Heo112202d2013-02-13 19:29:12 -08001296static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1297 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001298{
Tejun Heo112202d2013-02-13 19:29:12 -08001299 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001300
Tejun Heo4690c4a2010-06-29 10:07:10 +02001301 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001302 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001303 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001304 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001305
1306 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001307 * Ensure either wq_worker_sleeping() sees the above
1308 * list_add_tail() or we see zero nr_running to avoid workers lying
1309 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001310 */
1311 smp_mb();
1312
Tejun Heo63d95a92012-07-12 14:46:37 -07001313 if (__need_more_worker(pool))
1314 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001315}
1316
Tejun Heoc8efcc22010-12-20 19:32:04 +01001317/*
1318 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001319 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001320 */
1321static bool is_chained_work(struct workqueue_struct *wq)
1322{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001323 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001324
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001325 worker = current_wq_worker();
1326 /*
1327 * Return %true iff I'm a worker execuing a work item on @wq. If
1328 * I'm @worker, it's safe to dereference it without locking.
1329 */
Tejun Heo112202d2013-02-13 19:29:12 -08001330 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001331}
1332
Mike Galbraithef5571802016-02-09 17:59:38 -05001333/*
1334 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1335 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1336 * avoid perturbing sensitive tasks.
1337 */
1338static int wq_select_unbound_cpu(int cpu)
1339{
Tejun Heof303fcc2016-02-09 17:59:38 -05001340 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001341 int new_cpu;
1342
Tejun Heof303fcc2016-02-09 17:59:38 -05001343 if (likely(!wq_debug_force_rr_cpu)) {
1344 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1345 return cpu;
1346 } else if (!printed_dbg_warning) {
1347 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1348 printed_dbg_warning = true;
1349 }
1350
Mike Galbraithef5571802016-02-09 17:59:38 -05001351 if (cpumask_empty(wq_unbound_cpumask))
1352 return cpu;
1353
1354 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1355 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1356 if (unlikely(new_cpu >= nr_cpu_ids)) {
1357 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1358 if (unlikely(new_cpu >= nr_cpu_ids))
1359 return cpu;
1360 }
1361 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1362
1363 return new_cpu;
1364}
1365
Tejun Heod84ff052013-03-12 11:29:59 -07001366static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 struct work_struct *work)
1368{
Tejun Heo112202d2013-02-13 19:29:12 -08001369 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001370 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001371 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001372 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001373 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001374
1375 /*
1376 * While a work item is PENDING && off queue, a task trying to
1377 * steal the PENDING will busy-loop waiting for it to either get
1378 * queued or lose PENDING. Grabbing PENDING and queueing should
1379 * happen with IRQ disabled.
1380 */
1381 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001383
Li Bin9ef28a72013-09-09 13:13:58 +08001384 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001385 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001386 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001387 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001388retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001389 /* pwq which will be used unless @work is executing elsewhere */
Hillf Danton3772b932020-01-24 20:14:45 -05001390 if (wq->flags & WQ_UNBOUND) {
1391 if (req_cpu == WORK_CPU_UNBOUND)
1392 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Hillf Danton3772b932020-01-24 20:14:45 -05001394 } else {
1395 if (req_cpu == WORK_CPU_UNBOUND)
1396 cpu = raw_smp_processor_id();
1397 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1398 }
Tejun Heodbf25762012-08-20 14:51:23 -07001399
Tejun Heoc9178082013-03-12 11:30:04 -07001400 /*
1401 * If @work was previously on a different pool, it might still be
1402 * running there, in which case the work needs to be queued on that
1403 * pool to guarantee non-reentrancy.
1404 */
1405 last_pool = get_work_pool(work);
1406 if (last_pool && last_pool != pwq->pool) {
1407 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001408
Tejun Heoc9178082013-03-12 11:30:04 -07001409 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001410
Tejun Heoc9178082013-03-12 11:30:04 -07001411 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001412
Tejun Heoc9178082013-03-12 11:30:04 -07001413 if (worker && worker->current_pwq->wq == wq) {
1414 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001415 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001416 /* meh... not running there, queue here */
1417 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001418 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001419 }
Tejun Heof3421792010-07-02 10:03:51 +02001420 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001421 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001422 }
1423
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001424 /*
1425 * pwq is determined and locked. For unbound pools, we could have
1426 * raced with pwq release and it could already be dead. If its
1427 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001428 * without another pwq replacing it in the numa_pwq_tbl or while
1429 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001430 * make forward-progress.
1431 */
1432 if (unlikely(!pwq->refcnt)) {
1433 if (wq->flags & WQ_UNBOUND) {
1434 spin_unlock(&pwq->pool->lock);
1435 cpu_relax();
1436 goto retry;
1437 }
1438 /* oops */
1439 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1440 wq->name, cpu);
1441 }
1442
Tejun Heo112202d2013-02-13 19:29:12 -08001443 /* pwq determined, queue */
1444 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001445
Dan Carpenterf5b25522012-04-13 22:06:58 +03001446 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001447 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001448 return;
1449 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001450
Tejun Heo112202d2013-02-13 19:29:12 -08001451 pwq->nr_in_flight[pwq->work_color]++;
1452 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001453
Tejun Heo112202d2013-02-13 19:29:12 -08001454 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001455 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001456 pwq->nr_active++;
1457 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001458 if (list_empty(worklist))
1459 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001460 } else {
1461 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001462 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001463 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001464
Zqiangb7372542021-02-18 11:16:49 +08001465 debug_work_activate(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001466 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001467
Tejun Heo112202d2013-02-13 19:29:12 -08001468 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469}
1470
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001471/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001472 * queue_work_on - queue work on specific cpu
1473 * @cpu: CPU number to execute work on
1474 * @wq: workqueue to use
1475 * @work: work to queue
1476 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001477 * We queue the work to a specific CPU, the caller must ensure it
1478 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001479 *
1480 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001481 */
Tejun Heod4283e92012-08-03 10:30:44 -07001482bool queue_work_on(int cpu, struct workqueue_struct *wq,
1483 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001484{
Tejun Heod4283e92012-08-03 10:30:44 -07001485 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001486 unsigned long flags;
1487
1488 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001489
Tejun Heo22df02b2010-06-29 10:07:10 +02001490 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001491 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001492 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001493 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001494
1495 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001496 return ret;
1497}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001498EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001499
Tejun Heod8e794d2012-08-03 10:30:45 -07001500void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501{
David Howells52bad642006-11-22 14:54:01 +00001502 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001504 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001505 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001507EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001509static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1510 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001512 struct timer_list *timer = &dwork->timer;
1513 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Tejun Heo757e1842017-03-06 15:33:42 -05001515 WARN_ON_ONCE(!wq);
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001516 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1517 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001518 WARN_ON_ONCE(timer_pending(timer));
1519 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001520
Tejun Heo8852aac2012-12-01 16:23:42 -08001521 /*
1522 * If @delay is 0, queue @dwork->work immediately. This is for
1523 * both optimization and correctness. The earliest @timer can
1524 * expire is on the closest next tick and delayed_work users depend
1525 * on that there's no such delay when @delay is 0.
1526 */
1527 if (!delay) {
1528 __queue_work(cpu, wq, &dwork->work);
1529 return;
1530 }
1531
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001532 timer_stats_timer_set_start_info(&dwork->timer);
1533
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001534 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001535 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001536 timer->expires = jiffies + delay;
1537
Tejun Heo041bd122016-02-09 16:11:26 -05001538 if (unlikely(cpu != WORK_CPU_UNBOUND))
1539 add_timer_on(timer, cpu);
1540 else
1541 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542}
1543
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001544/**
1545 * queue_delayed_work_on - queue work on specific CPU after delay
1546 * @cpu: CPU number to execute work on
1547 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001548 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001549 * @delay: number of jiffies to wait before queueing
1550 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001551 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001552 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1553 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001554 */
Tejun Heod4283e92012-08-03 10:30:44 -07001555bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1556 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001557{
David Howells52bad642006-11-22 14:54:01 +00001558 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001559 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001560 unsigned long flags;
1561
1562 /* read the comment in __queue_work() */
1563 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001564
Tejun Heo22df02b2010-06-29 10:07:10 +02001565 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001566 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001567 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001568 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001569
1570 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001571 return ret;
1572}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001573EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Tejun Heoc8e55f32010-06-29 10:07:12 +02001575/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001576 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1577 * @cpu: CPU number to execute work on
1578 * @wq: workqueue to use
1579 * @dwork: work to queue
1580 * @delay: number of jiffies to wait before queueing
1581 *
1582 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1583 * modify @dwork's timer so that it expires after @delay. If @delay is
1584 * zero, @work is guaranteed to be scheduled immediately regardless of its
1585 * current state.
1586 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001587 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001588 * pending and its timer was modified.
1589 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001590 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001591 * See try_to_grab_pending() for details.
1592 */
1593bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1594 struct delayed_work *dwork, unsigned long delay)
1595{
1596 unsigned long flags;
1597 int ret;
1598
1599 do {
1600 ret = try_to_grab_pending(&dwork->work, true, &flags);
1601 } while (unlikely(ret == -EAGAIN));
1602
1603 if (likely(ret >= 0)) {
1604 __queue_delayed_work(cpu, wq, dwork, delay);
1605 local_irq_restore(flags);
1606 }
1607
1608 /* -ENOENT from try_to_grab_pending() becomes %true */
1609 return ret;
1610}
1611EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1612
1613/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001614 * worker_enter_idle - enter idle state
1615 * @worker: worker which is entering idle state
1616 *
1617 * @worker is entering idle state. Update stats and idle timer if
1618 * necessary.
1619 *
1620 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001621 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001622 */
1623static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001625 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Tejun Heo6183c002013-03-12 11:29:57 -07001627 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1628 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1629 (worker->hentry.next || worker->hentry.pprev)))
1630 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Lai Jiangshan051e1852014-07-22 13:03:02 +08001632 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001633 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001634 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001635 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001636
Tejun Heoc8e55f32010-06-29 10:07:12 +02001637 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001638 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001639
Tejun Heo628c78e2012-07-17 12:39:27 -07001640 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1641 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001642
Tejun Heo544ecf32012-05-14 15:04:50 -07001643 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001644 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001645 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001646 * nr_running, the warning may trigger spuriously. Check iff
1647 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001648 */
Tejun Heo24647572013-01-24 11:01:33 -08001649 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001650 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001651 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652}
1653
Tejun Heoc8e55f32010-06-29 10:07:12 +02001654/**
1655 * worker_leave_idle - leave idle state
1656 * @worker: worker which is leaving idle state
1657 *
1658 * @worker is leaving idle state. Update stats.
1659 *
1660 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001661 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001662 */
1663static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001665 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Tejun Heo6183c002013-03-12 11:29:57 -07001667 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1668 return;
Tejun Heod302f012010-06-29 10:07:13 +02001669 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001670 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001671 list_del_init(&worker->entry);
1672}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001674static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001675{
1676 struct worker *worker;
1677
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001678 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001679 if (worker) {
1680 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001681 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001682 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001683 /* on creation a worker is in !idle && prep state */
1684 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001685 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001686 return worker;
1687}
1688
1689/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001690 * worker_attach_to_pool() - attach a worker to a pool
1691 * @worker: worker to be attached
1692 * @pool: the target pool
1693 *
1694 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1695 * cpu-binding of @worker are kept coordinated with the pool across
1696 * cpu-[un]hotplugs.
1697 */
1698static void worker_attach_to_pool(struct worker *worker,
1699 struct worker_pool *pool)
1700{
1701 mutex_lock(&pool->attach_mutex);
1702
1703 /*
1704 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1705 * online CPUs. It'll be re-applied when any of the CPUs come up.
1706 */
1707 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1708
1709 /*
1710 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1711 * stable across this function. See the comments above the
1712 * flag definition for details.
1713 */
1714 if (pool->flags & POOL_DISASSOCIATED)
1715 worker->flags |= WORKER_UNBOUND;
1716
1717 list_add_tail(&worker->node, &pool->workers);
1718
1719 mutex_unlock(&pool->attach_mutex);
1720}
1721
1722/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001723 * worker_detach_from_pool() - detach a worker from its pool
1724 * @worker: worker which is attached to its pool
1725 * @pool: the pool @worker is attached to
1726 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001727 * Undo the attaching which had been done in worker_attach_to_pool(). The
1728 * caller worker shouldn't access to the pool after detached except it has
1729 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001730 */
1731static void worker_detach_from_pool(struct worker *worker,
1732 struct worker_pool *pool)
1733{
1734 struct completion *detach_completion = NULL;
1735
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001736 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001737 list_del(&worker->node);
1738 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001739 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001740 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001741
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001742 /* clear leftover flags without pool->lock after it is detached */
1743 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1744
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001745 if (detach_completion)
1746 complete(detach_completion);
1747}
1748
1749/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001750 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001751 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001752 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001753 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001754 *
1755 * CONTEXT:
1756 * Might sleep. Does GFP_KERNEL allocations.
1757 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001758 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001759 * Pointer to the newly created worker.
1760 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001761static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001762{
Tejun Heoc34056a2010-06-29 10:07:11 +02001763 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001764 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001765 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001766
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001767 /* ID is needed to determine kthread name */
1768 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001769 if (id < 0)
1770 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001771
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001772 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001773 if (!worker)
1774 goto fail;
1775
Tejun Heobd7bdd42012-07-12 14:46:37 -07001776 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 worker->id = id;
1778
Tejun Heo29c91e92013-03-12 11:30:03 -07001779 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001780 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1781 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001782 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001783 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1784
Tejun Heof3f90ad2013-04-01 11:23:34 -07001785 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001786 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001787 if (IS_ERR(worker->task))
1788 goto fail;
1789
Oleg Nesterov91151222013-11-14 12:56:18 +01001790 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001791 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001792
Lai Jiangshanda028462014-05-20 17:46:31 +08001793 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001794 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001795
Lai Jiangshan051e1852014-07-22 13:03:02 +08001796 /* start the newly created worker */
1797 spin_lock_irq(&pool->lock);
1798 worker->pool->nr_workers++;
1799 worker_enter_idle(worker);
1800 wake_up_process(worker->task);
1801 spin_unlock_irq(&pool->lock);
1802
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001804
Tejun Heoc34056a2010-06-29 10:07:11 +02001805fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001806 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001807 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001808 kfree(worker);
1809 return NULL;
1810}
1811
1812/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001813 * destroy_worker - destroy a workqueue worker
1814 * @worker: worker to be destroyed
1815 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001816 * Destroy @worker and adjust @pool stats accordingly. The worker should
1817 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001818 *
1819 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001820 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001821 */
1822static void destroy_worker(struct worker *worker)
1823{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001824 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001825
Tejun Heocd549682013-03-13 19:47:39 -07001826 lockdep_assert_held(&pool->lock);
1827
Tejun Heoc34056a2010-06-29 10:07:11 +02001828 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001829 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001830 WARN_ON(!list_empty(&worker->scheduled)) ||
1831 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001832 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001833
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001834 pool->nr_workers--;
1835 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001836
Tejun Heoc8e55f32010-06-29 10:07:12 +02001837 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001838 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001839 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001840}
1841
Tejun Heo63d95a92012-07-12 14:46:37 -07001842static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001843{
Tejun Heo63d95a92012-07-12 14:46:37 -07001844 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001845
Tejun Heod565ed62013-01-24 11:01:33 -08001846 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001847
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001848 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001849 struct worker *worker;
1850 unsigned long expires;
1851
1852 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001853 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001854 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1855
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001856 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001857 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001858 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001859 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001860
1861 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001862 }
1863
Tejun Heod565ed62013-01-24 11:01:33 -08001864 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001865}
1866
Tejun Heo493a1722013-03-12 11:29:59 -07001867static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001868{
Tejun Heo112202d2013-02-13 19:29:12 -08001869 struct pool_workqueue *pwq = get_work_pwq(work);
1870 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001871
Tejun Heo2e109a22013-03-13 19:47:40 -07001872 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873
Tejun Heo493008a2013-03-12 11:30:03 -07001874 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001875 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001876
1877 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001878 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001879 /*
1880 * If @pwq is for an unbound wq, its base ref may be put at
1881 * any time due to an attribute change. Pin @pwq until the
1882 * rescuer is done with it.
1883 */
1884 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001885 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001887 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001888}
1889
Tejun Heo706026c2013-01-24 11:01:34 -08001890static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001891{
Tejun Heo63d95a92012-07-12 14:46:37 -07001892 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001893 struct work_struct *work;
1894
Tejun Heob2d82902014-12-08 12:39:16 -05001895 spin_lock_irq(&pool->lock);
1896 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001897
Tejun Heo63d95a92012-07-12 14:46:37 -07001898 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 /*
1900 * We've been trying to create a new worker but
1901 * haven't been successful. We might be hitting an
1902 * allocation deadlock. Send distress signals to
1903 * rescuers.
1904 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001905 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 send_mayday(work);
1907 }
1908
Tejun Heob2d82902014-12-08 12:39:16 -05001909 spin_unlock(&wq_mayday_lock);
1910 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001911
Tejun Heo63d95a92012-07-12 14:46:37 -07001912 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001913}
1914
1915/**
1916 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001919 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 * have at least one idle worker on return from this function. If
1921 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001922 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 * possible allocation deadlock.
1924 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001925 * On return, need_to_create_worker() is guaranteed to be %false and
1926 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001927 *
1928 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001929 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001930 * multiple times. Does GFP_KERNEL allocations. Called only from
1931 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 */
Tejun Heo29187a92015-01-16 14:21:16 -05001933static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001934__releases(&pool->lock)
1935__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001936{
Tejun Heoe22bee72010-06-29 10:07:14 +02001937restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001938 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001939
Tejun Heoe22bee72010-06-29 10:07:14 +02001940 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001941 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001942
1943 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001944 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 break;
1946
Lai Jiangshane212f362014-06-03 15:32:17 +08001947 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001948
Tejun Heo63d95a92012-07-12 14:46:37 -07001949 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 break;
1951 }
1952
Tejun Heo63d95a92012-07-12 14:46:37 -07001953 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001954 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001955 /*
1956 * This is necessary even after a new worker was just successfully
1957 * created as @pool->lock was dropped and the new worker might have
1958 * already become busy.
1959 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001960 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001961 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001962}
1963
1964/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 * manage_workers - manage worker pool
1966 * @worker: self
1967 *
Tejun Heo706026c2013-01-24 11:01:34 -08001968 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001969 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001970 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 *
1972 * The caller can safely start processing works on false return. On
1973 * true return, it's guaranteed that need_to_create_worker() is false
1974 * and may_start_working() is true.
1975 *
1976 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001977 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 * multiple times. Does GFP_KERNEL allocations.
1979 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001980 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05001981 * %false if the pool doesn't need management and the caller can safely
1982 * start processing works, %true if management function was performed and
1983 * the conditions that the caller verified before calling the function may
1984 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001985 */
1986static bool manage_workers(struct worker *worker)
1987{
Tejun Heo63d95a92012-07-12 14:46:37 -07001988 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001989
Tejun Heo43a980a2017-10-09 08:04:13 -07001990 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05001991 return false;
Tejun Heo43a980a2017-10-09 08:04:13 -07001992
1993 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04001994 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02001995
Tejun Heo29187a92015-01-16 14:21:16 -05001996 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001997
Tejun Heo2607d7a2015-03-09 09:22:28 -04001998 pool->manager = NULL;
Tejun Heo43a980a2017-10-09 08:04:13 -07001999 pool->flags &= ~POOL_MANAGER_ACTIVE;
2000 wake_up(&wq_manager_wait);
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 Heo974271c2012-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 Heo974271c2012-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 Heo974271c2012-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
Tejun Heo112202d2013-02-13 19:29:12 -08002094 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002095 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002096 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002097 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002098 /*
2099 * While we must be careful to not use "work" after this, the trace
2100 * point will only record its address.
2101 */
2102 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002103 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002104 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002105
2106 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002107 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2108 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002109 current->comm, preempt_count(), task_pid_nr(current),
2110 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002111 debug_show_held_locks(current);
2112 dump_stack();
2113 }
2114
Tejun Heob22ce272013-08-28 17:33:37 -04002115 /*
2116 * The following prevents a kworker from hogging CPU on !PREEMPT
2117 * kernels, where a requeueing work item waiting for something to
2118 * happen could deadlock with stop_machine as such work item could
2119 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002120 * stop_machine. At the same time, report a quiescent RCU state so
2121 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002122 */
Joe Lawrence3e28e372014-10-05 13:24:22 -04002123 cond_resched_rcu_qs();
Tejun Heob22ce272013-08-28 17:33:37 -04002124
Tejun Heod565ed62013-01-24 11:01:33 -08002125 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002126
Tejun Heofb0e7be2010-06-29 10:07:15 +02002127 /* clear cpu intensive status */
2128 if (unlikely(cpu_intensive))
2129 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2130
Tejun Heoa62428c2010-06-29 10:07:10 +02002131 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002132 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002133 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002134 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002135 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002136 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002137 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002138}
2139
Tejun Heoaffee4b2010-06-29 10:07:12 +02002140/**
2141 * process_scheduled_works - process scheduled works
2142 * @worker: self
2143 *
2144 * Process all scheduled works. Please note that the scheduled list
2145 * may change while processing a work, so this function repeatedly
2146 * fetches a work from the top and executes it.
2147 *
2148 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002149 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002150 * multiple times.
2151 */
2152static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002154 while (!list_empty(&worker->scheduled)) {
2155 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002157 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159}
2160
Tejun Heo4690c4a2010-06-29 10:07:10 +02002161/**
2162 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002163 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002164 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002165 * The worker thread function. All workers belong to a worker_pool -
2166 * either a per-cpu one or dynamic unbound one. These workers process all
2167 * work items regardless of their specific target workqueue. The only
2168 * exception is work items which belong to workqueues with a rescuer which
2169 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002170 *
2171 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002172 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002173static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174{
Tejun Heoc34056a2010-06-29 10:07:11 +02002175 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002176 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177
Tejun Heoe22bee72010-06-29 10:07:14 +02002178 /* tell the scheduler that this is a workqueue worker */
2179 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002180woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002181 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002182
Tejun Heoa9ab7752013-03-19 13:45:21 -07002183 /* am I supposed to die? */
2184 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002185 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002186 WARN_ON_ONCE(!list_empty(&worker->entry));
2187 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002188
2189 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002190 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002191 worker_detach_from_pool(worker, pool);
2192 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002193 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002195
Tejun Heoc8e55f32010-06-29 10:07:12 +02002196 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002197recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002198 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002199 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002200 goto sleep;
2201
2202 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002203 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002204 goto recheck;
2205
Tejun Heoc8e55f32010-06-29 10:07:12 +02002206 /*
2207 * ->scheduled list can only be filled while a worker is
2208 * preparing to process a work or actually processing it.
2209 * Make sure nobody diddled with it while I was sleeping.
2210 */
Tejun Heo6183c002013-03-12 11:29:57 -07002211 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002212
Tejun Heoe22bee72010-06-29 10:07:14 +02002213 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002214 * Finish PREP stage. We're guaranteed to have at least one idle
2215 * worker or that someone else has already assumed the manager
2216 * role. This is where @worker starts participating in concurrency
2217 * management if applicable and concurrency management is restored
2218 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002219 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002220 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002221
2222 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002223 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002224 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002225 struct work_struct, entry);
2226
Tejun Heo82607adc2015-12-08 11:28:04 -05002227 pool->watchdog_ts = jiffies;
2228
Tejun Heoc8e55f32010-06-29 10:07:12 +02002229 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2230 /* optimization path, not strictly necessary */
2231 process_one_work(worker, work);
2232 if (unlikely(!list_empty(&worker->scheduled)))
2233 process_scheduled_works(worker);
2234 } else {
2235 move_linked_works(work, &worker->scheduled, NULL);
2236 process_scheduled_works(worker);
2237 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002238 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002239
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002240 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002241sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002242 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002243 * pool->lock is held and there's no work to process and no need to
2244 * manage, sleep. Workers are woken up only while holding
2245 * pool->lock or from local cpu, so setting the current state
2246 * before releasing pool->lock is enough to prevent losing any
2247 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002248 */
2249 worker_enter_idle(worker);
2250 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002251 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002252 schedule();
2253 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254}
2255
Tejun Heoe22bee72010-06-29 10:07:14 +02002256/**
2257 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002258 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002259 *
2260 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002261 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002262 *
Tejun Heo706026c2013-01-24 11:01:34 -08002263 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002264 * worker which uses GFP_KERNEL allocation which has slight chance of
2265 * developing into deadlock if some works currently on the same queue
2266 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2267 * the problem rescuer solves.
2268 *
Tejun Heo706026c2013-01-24 11:01:34 -08002269 * When such condition is possible, the pool summons rescuers of all
2270 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002271 * those works so that forward progress can be guaranteed.
2272 *
2273 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002274 *
2275 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002276 */
Tejun Heo111c2252013-01-17 17:16:24 -08002277static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002278{
Tejun Heo111c2252013-01-17 17:16:24 -08002279 struct worker *rescuer = __rescuer;
2280 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002281 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002282 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002283
2284 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002285
2286 /*
2287 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2288 * doesn't participate in concurrency management.
2289 */
2290 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002291repeat:
2292 set_current_state(TASK_INTERRUPTIBLE);
2293
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002294 /*
2295 * By the time the rescuer is requested to stop, the workqueue
2296 * shouldn't have any work pending, but @wq->maydays may still have
2297 * pwq(s) queued. This can happen by non-rescuer workers consuming
2298 * all the work items before the rescuer got to them. Go through
2299 * @wq->maydays processing before acting on should_stop so that the
2300 * list is always empty on exit.
2301 */
2302 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002303
Tejun Heo493a1722013-03-12 11:29:59 -07002304 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002305 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002306
2307 while (!list_empty(&wq->maydays)) {
2308 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2309 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002310 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002311 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002312 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002313
2314 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002315 list_del_init(&pwq->mayday_node);
2316
Tejun Heo2e109a22013-03-13 19:47:40 -07002317 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002318
Lai Jiangshan51697d392014-05-20 17:46:36 +08002319 worker_attach_to_pool(rescuer, pool);
2320
2321 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002322 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002323
2324 /*
2325 * Slurp in all works issued via this workqueue and
2326 * process'em.
2327 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002328 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002329 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2330 if (get_work_pwq(work) == pwq) {
2331 if (first)
2332 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002333 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002334 }
2335 first = false;
2336 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002337
NeilBrown008847f2014-12-08 12:39:16 -05002338 if (!list_empty(scheduled)) {
2339 process_scheduled_works(rescuer);
2340
2341 /*
2342 * The above execution of rescued work items could
2343 * have created more to rescue through
2344 * pwq_activate_first_delayed() or chained
2345 * queueing. Let's put @pwq back on mayday list so
2346 * that such back-to-back work items, which may be
2347 * being used to relieve memory pressure, don't
2348 * incur MAYDAY_INTERVAL delay inbetween.
2349 */
2350 if (need_to_create_worker(pool)) {
2351 spin_lock(&wq_mayday_lock);
Tejun Heo4f5b0c72019-09-25 06:59:15 -07002352 /*
2353 * Queue iff we aren't racing destruction
2354 * and somebody else hasn't queued it already.
2355 */
2356 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2357 get_pwq(pwq);
2358 list_add_tail(&pwq->mayday_node, &wq->maydays);
2359 }
NeilBrown008847f2014-12-08 12:39:16 -05002360 spin_unlock(&wq_mayday_lock);
2361 }
2362 }
Tejun Heo75769582011-02-14 14:04:46 +01002363
2364 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002365 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002366 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002367 */
2368 put_pwq(pwq);
2369
2370 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002371 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002372 * regular worker; otherwise, we end up with 0 concurrency
2373 * and stalling the execution.
2374 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002375 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002376 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002377
Lai Jiangshanb3104102013-02-19 12:17:02 -08002378 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002379 spin_unlock_irq(&pool->lock);
2380
2381 worker_detach_from_pool(rescuer, pool);
2382
2383 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002384 }
2385
Tejun Heo2e109a22013-03-13 19:47:40 -07002386 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002387
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002388 if (should_stop) {
2389 __set_current_state(TASK_RUNNING);
2390 rescuer->task->flags &= ~PF_WQ_WORKER;
2391 return 0;
2392 }
2393
Tejun Heo111c2252013-01-17 17:16:24 -08002394 /* rescuers should never participate in concurrency management */
2395 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002396 schedule();
2397 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398}
2399
Tejun Heofca839c2015-12-07 10:58:57 -05002400/**
2401 * check_flush_dependency - check for flush dependency sanity
2402 * @target_wq: workqueue being flushed
2403 * @target_work: work item being flushed (NULL for workqueue flushes)
2404 *
2405 * %current is trying to flush the whole @target_wq or @target_work on it.
2406 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2407 * reclaiming memory or running on a workqueue which doesn't have
2408 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2409 * a deadlock.
2410 */
2411static void check_flush_dependency(struct workqueue_struct *target_wq,
2412 struct work_struct *target_work)
2413{
2414 work_func_t target_func = target_work ? target_work->func : NULL;
2415 struct worker *worker;
2416
2417 if (target_wq->flags & WQ_MEM_RECLAIM)
2418 return;
2419
2420 worker = current_wq_worker();
2421
2422 WARN_ONCE(current->flags & PF_MEMALLOC,
2423 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2424 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002425 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2426 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002427 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2428 worker->current_pwq->wq->name, worker->current_func,
2429 target_wq->name, target_func);
2430}
2431
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002432struct wq_barrier {
2433 struct work_struct work;
2434 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002435 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002436};
2437
2438static void wq_barrier_func(struct work_struct *work)
2439{
2440 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2441 complete(&barr->done);
2442}
2443
Tejun Heo4690c4a2010-06-29 10:07:10 +02002444/**
2445 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002446 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002447 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002448 * @target: target work to attach @barr to
2449 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002450 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002451 * @barr is linked to @target such that @barr is completed only after
2452 * @target finishes execution. Please note that the ordering
2453 * guarantee is observed only with respect to @target and on the local
2454 * cpu.
2455 *
2456 * Currently, a queued barrier can't be canceled. This is because
2457 * try_to_grab_pending() can't determine whether the work to be
2458 * grabbed is at the head of the queue and thus can't clear LINKED
2459 * flag of the previous work while there must be a valid next work
2460 * after a work with LINKED flag set.
2461 *
2462 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002463 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002464 *
2465 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002466 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002467 */
Tejun Heo112202d2013-02-13 19:29:12 -08002468static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002469 struct wq_barrier *barr,
2470 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002471{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002472 struct list_head *head;
2473 unsigned int linked = 0;
2474
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002475 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002476 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002477 * as we know for sure that this will not trigger any of the
2478 * checks and call back into the fixup functions where we
2479 * might deadlock.
2480 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002481 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002482 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002483 init_completion(&barr->done);
Tejun Heo2607d7a2015-03-09 09:22:28 -04002484 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002485
Tejun Heoaffee4b2010-06-29 10:07:12 +02002486 /*
2487 * If @target is currently being executed, schedule the
2488 * barrier to the worker; otherwise, put it after @target.
2489 */
2490 if (worker)
2491 head = worker->scheduled.next;
2492 else {
2493 unsigned long *bits = work_data_bits(target);
2494
2495 head = target->entry.next;
2496 /* there can already be other linked works, inherit and set */
2497 linked = *bits & WORK_STRUCT_LINKED;
2498 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2499 }
2500
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002501 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002502 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002503 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002504}
2505
Tejun Heo73f53c42010-06-29 10:07:11 +02002506/**
Tejun Heo112202d2013-02-13 19:29:12 -08002507 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002508 * @wq: workqueue being flushed
2509 * @flush_color: new flush color, < 0 for no-op
2510 * @work_color: new work color, < 0 for no-op
2511 *
Tejun Heo112202d2013-02-13 19:29:12 -08002512 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002513 *
Tejun Heo112202d2013-02-13 19:29:12 -08002514 * If @flush_color is non-negative, flush_color on all pwqs should be
2515 * -1. If no pwq has in-flight commands at the specified color, all
2516 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2517 * has in flight commands, its pwq->flush_color is set to
2518 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002519 * wakeup logic is armed and %true is returned.
2520 *
2521 * The caller should have initialized @wq->first_flusher prior to
2522 * calling this function with non-negative @flush_color. If
2523 * @flush_color is negative, no flush color update is done and %false
2524 * is returned.
2525 *
Tejun Heo112202d2013-02-13 19:29:12 -08002526 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002527 * work_color which is previous to @work_color and all will be
2528 * advanced to @work_color.
2529 *
2530 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002531 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002532 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002533 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002534 * %true if @flush_color >= 0 and there's something to flush. %false
2535 * otherwise.
2536 */
Tejun Heo112202d2013-02-13 19:29:12 -08002537static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002538 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539{
Tejun Heo73f53c42010-06-29 10:07:11 +02002540 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002541 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002542
Tejun Heo73f53c42010-06-29 10:07:11 +02002543 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002544 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002545 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002546 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002547
Tejun Heo49e3cf42013-03-12 11:29:58 -07002548 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002549 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002550
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002551 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002552
2553 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002554 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002555
Tejun Heo112202d2013-02-13 19:29:12 -08002556 if (pwq->nr_in_flight[flush_color]) {
2557 pwq->flush_color = flush_color;
2558 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002559 wait = true;
2560 }
2561 }
2562
2563 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002564 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002565 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002566 }
2567
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002568 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002569 }
2570
Tejun Heo112202d2013-02-13 19:29:12 -08002571 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002572 complete(&wq->first_flusher->done);
2573
2574 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575}
2576
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002577/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002579 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002581 * This function sleeps until all work items which were queued on entry
2582 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002584void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585{
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 struct wq_flusher this_flusher = {
2587 .list = LIST_HEAD_INIT(this_flusher.list),
2588 .flush_color = -1,
2589 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2590 };
2591 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002592
Tejun Heoac4bbc02016-09-16 15:49:32 -04002593 if (WARN_ON(!wq_online))
2594 return;
2595
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002596 lock_map_acquire(&wq->lockdep_map);
2597 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002598
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002599 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002600
2601 /*
2602 * Start-to-wait phase
2603 */
2604 next_color = work_next_color(wq->work_color);
2605
2606 if (next_color != wq->flush_color) {
2607 /*
2608 * Color space is not full. The current work_color
2609 * becomes our flush_color and work_color is advanced
2610 * by one.
2611 */
Tejun Heo6183c002013-03-12 11:29:57 -07002612 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002613 this_flusher.flush_color = wq->work_color;
2614 wq->work_color = next_color;
2615
2616 if (!wq->first_flusher) {
2617 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002618 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002619
2620 wq->first_flusher = &this_flusher;
2621
Tejun Heo112202d2013-02-13 19:29:12 -08002622 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002623 wq->work_color)) {
2624 /* nothing to flush, done */
2625 wq->flush_color = next_color;
2626 wq->first_flusher = NULL;
2627 goto out_unlock;
2628 }
2629 } else {
2630 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002631 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002632 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002633 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002634 }
2635 } else {
2636 /*
2637 * Oops, color space is full, wait on overflow queue.
2638 * The next flush completion will assign us
2639 * flush_color and transfer to flusher_queue.
2640 */
2641 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2642 }
2643
Tejun Heofca839c2015-12-07 10:58:57 -05002644 check_flush_dependency(wq, NULL);
2645
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002646 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002647
2648 wait_for_completion(&this_flusher.done);
2649
2650 /*
2651 * Wake-up-and-cascade phase
2652 *
2653 * First flushers are responsible for cascading flushes and
2654 * handling overflow. Non-first flushers can simply return.
2655 */
2656 if (wq->first_flusher != &this_flusher)
2657 return;
2658
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002659 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002660
Tejun Heo4ce48b32010-07-02 10:03:51 +02002661 /* we might have raced, check again with mutex held */
2662 if (wq->first_flusher != &this_flusher)
2663 goto out_unlock;
2664
Tejun Heo73f53c42010-06-29 10:07:11 +02002665 wq->first_flusher = NULL;
2666
Tejun Heo6183c002013-03-12 11:29:57 -07002667 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2668 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002669
2670 while (true) {
2671 struct wq_flusher *next, *tmp;
2672
2673 /* complete all the flushers sharing the current flush color */
2674 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2675 if (next->flush_color != wq->flush_color)
2676 break;
2677 list_del_init(&next->list);
2678 complete(&next->done);
2679 }
2680
Tejun Heo6183c002013-03-12 11:29:57 -07002681 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2682 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002683
2684 /* this flush_color is finished, advance by one */
2685 wq->flush_color = work_next_color(wq->flush_color);
2686
2687 /* one color has been freed, handle overflow queue */
2688 if (!list_empty(&wq->flusher_overflow)) {
2689 /*
2690 * Assign the same color to all overflowed
2691 * flushers, advance work_color and append to
2692 * flusher_queue. This is the start-to-wait
2693 * phase for these overflowed flushers.
2694 */
2695 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2696 tmp->flush_color = wq->work_color;
2697
2698 wq->work_color = work_next_color(wq->work_color);
2699
2700 list_splice_tail_init(&wq->flusher_overflow,
2701 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002702 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002703 }
2704
2705 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002706 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002707 break;
2708 }
2709
2710 /*
2711 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002712 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002713 */
Tejun Heo6183c002013-03-12 11:29:57 -07002714 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2715 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002716
2717 list_del_init(&next->list);
2718 wq->first_flusher = next;
2719
Tejun Heo112202d2013-02-13 19:29:12 -08002720 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002721 break;
2722
2723 /*
2724 * Meh... this color is already done, clear first
2725 * flusher and repeat cascading.
2726 */
2727 wq->first_flusher = NULL;
2728 }
2729
2730out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002731 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002733EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002735/**
2736 * drain_workqueue - drain a workqueue
2737 * @wq: workqueue to drain
2738 *
2739 * Wait until the workqueue becomes empty. While draining is in progress,
2740 * only chain queueing is allowed. IOW, only currently pending or running
2741 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002742 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002743 * by the depth of chaining and should be relatively short. Whine if it
2744 * takes too long.
2745 */
2746void drain_workqueue(struct workqueue_struct *wq)
2747{
2748 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002749 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002750
2751 /*
2752 * __queue_work() needs to test whether there are drainers, is much
2753 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002754 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002755 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002756 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002757 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002758 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002759 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002760reflush:
2761 flush_workqueue(wq);
2762
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002763 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002764
Tejun Heo49e3cf42013-03-12 11:29:58 -07002765 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002766 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002768 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002769 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002770 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002771
2772 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002773 continue;
2774
2775 if (++flush_cnt == 10 ||
2776 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002777 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002778 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002779
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002780 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002781 goto reflush;
2782 }
2783
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002785 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002786 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002787}
2788EXPORT_SYMBOL_GPL(drain_workqueue);
2789
Tejun Heo606a5022012-08-20 14:51:23 -07002790static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002791{
2792 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002793 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002794 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002795
2796 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002797
Tejun Heofa1b54e2013-03-12 11:30:00 -07002798 local_irq_disable();
2799 pool = get_work_pool(work);
2800 if (!pool) {
2801 local_irq_enable();
2802 return false;
2803 }
2804
2805 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002806 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002807 pwq = get_work_pwq(work);
2808 if (pwq) {
2809 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002810 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002811 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002812 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002813 if (!worker)
2814 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002815 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002816 }
Tejun Heobaf59022010-09-16 10:42:16 +02002817
Tejun Heofca839c2015-12-07 10:58:57 -05002818 check_flush_dependency(pwq->wq, work);
2819
Tejun Heo112202d2013-02-13 19:29:12 -08002820 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002821 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002822
Tejun Heoe1594892011-01-09 23:32:15 +01002823 /*
2824 * If @max_active is 1 or rescuer is in use, flushing another work
2825 * item on the same workqueue may lead to deadlock. Make sure the
2826 * flusher is not running on the same workqueue by verifying write
2827 * access.
2828 */
Tejun Heo493008a2013-03-12 11:30:03 -07002829 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002830 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002831 else
Tejun Heo112202d2013-02-13 19:29:12 -08002832 lock_map_acquire_read(&pwq->wq->lockdep_map);
2833 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002834
Tejun Heobaf59022010-09-16 10:42:16 +02002835 return true;
2836already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002837 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002838 return false;
2839}
2840
Oleg Nesterovdb700892008-07-25 01:47:49 -07002841/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002842 * flush_work - wait for a work to finish executing the last queueing instance
2843 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002844 *
Tejun Heo606a5022012-08-20 14:51:23 -07002845 * Wait until @work has finished execution. @work is guaranteed to be idle
2846 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002847 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002848 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002849 * %true if flush_work() waited for the work to finish execution,
2850 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002851 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002852bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002853{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002854 struct wq_barrier barr;
2855
Tejun Heoac4bbc02016-09-16 15:49:32 -04002856 if (WARN_ON(!wq_online))
2857 return false;
2858
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002859 lock_map_acquire(&work->lockdep_map);
2860 lock_map_release(&work->lockdep_map);
2861
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002862 if (start_flush_work(work, &barr)) {
2863 wait_for_completion(&barr.done);
2864 destroy_work_on_stack(&barr.work);
2865 return true;
2866 } else {
2867 return false;
2868 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002869}
2870EXPORT_SYMBOL_GPL(flush_work);
2871
Tejun Heo8603e1b32015-03-05 08:04:13 -05002872struct cwt_wait {
2873 wait_queue_t wait;
2874 struct work_struct *work;
2875};
2876
2877static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
2878{
2879 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2880
2881 if (cwait->work != key)
2882 return 0;
2883 return autoremove_wake_function(wait, mode, sync, key);
2884}
2885
Tejun Heo36e227d2012-08-03 10:30:46 -07002886static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002887{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002888 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002889 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002890 int ret;
2891
2892 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002893 ret = try_to_grab_pending(work, is_dwork, &flags);
2894 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002895 * If someone else is already canceling, wait for it to
2896 * finish. flush_work() doesn't work for PREEMPT_NONE
2897 * because we may get scheduled between @work's completion
2898 * and the other canceling task resuming and clearing
2899 * CANCELING - flush_work() will return false immediately
2900 * as @work is no longer busy, try_to_grab_pending() will
2901 * return -ENOENT as @work is still being canceled and the
2902 * other canceling task won't be able to clear CANCELING as
2903 * we're hogging the CPU.
2904 *
2905 * Let's wait for completion using a waitqueue. As this
2906 * may lead to the thundering herd problem, use a custom
2907 * wake function which matches @work along with exclusive
2908 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002909 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002910 if (unlikely(ret == -ENOENT)) {
2911 struct cwt_wait cwait;
2912
2913 init_wait(&cwait.wait);
2914 cwait.wait.func = cwt_wakefn;
2915 cwait.work = work;
2916
2917 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2918 TASK_UNINTERRUPTIBLE);
2919 if (work_is_canceling(work))
2920 schedule();
2921 finish_wait(&cancel_waitq, &cwait.wait);
2922 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002923 } while (unlikely(ret < 0));
2924
Tejun Heobbb68df2012-08-03 10:30:46 -07002925 /* tell other tasks trying to grab @work to back off */
2926 mark_work_canceling(work);
2927 local_irq_restore(flags);
2928
Tejun Heoac4bbc02016-09-16 15:49:32 -04002929 /*
2930 * This allows canceling during early boot. We know that @work
2931 * isn't executing.
2932 */
2933 if (wq_online)
2934 flush_work(work);
2935
Tejun Heo7a22ad72010-06-29 10:07:13 +02002936 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002937
2938 /*
2939 * Paired with prepare_to_wait() above so that either
2940 * waitqueue_active() is visible here or !work_is_canceling() is
2941 * visible there.
2942 */
2943 smp_mb();
2944 if (waitqueue_active(&cancel_waitq))
2945 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2946
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002947 return ret;
2948}
2949
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002950/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002951 * cancel_work_sync - cancel a work and wait for it to finish
2952 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002953 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002954 * Cancel @work and wait for its execution to finish. This function
2955 * can be used even if the work re-queues itself or migrates to
2956 * another workqueue. On return from this function, @work is
2957 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002958 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002959 * cancel_work_sync(&delayed_work->work) must not be used for
2960 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002961 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002963 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002964 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002965 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002966 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002967 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002968bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002969{
Tejun Heo36e227d2012-08-03 10:30:46 -07002970 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002971}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002972EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002973
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002974/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002975 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2976 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002978 * Delayed timer is cancelled and the pending work is queued for
2979 * immediate execution. Like flush_work(), this function only
2980 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002981 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002982 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002983 * %true if flush_work() waited for the work to finish execution,
2984 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002985 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002986bool flush_delayed_work(struct delayed_work *dwork)
2987{
Tejun Heo8930cab2012-08-03 10:30:45 -07002988 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002989 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002990 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002991 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 return flush_work(&dwork->work);
2993}
2994EXPORT_SYMBOL(flush_delayed_work);
2995
Jens Axboef72b8792016-08-24 15:51:50 -06002996static bool __cancel_work(struct work_struct *work, bool is_dwork)
2997{
2998 unsigned long flags;
2999 int ret;
3000
3001 do {
3002 ret = try_to_grab_pending(work, is_dwork, &flags);
3003 } while (unlikely(ret == -EAGAIN));
3004
3005 if (unlikely(ret < 0))
3006 return false;
3007
3008 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3009 local_irq_restore(flags);
3010 return ret;
3011}
3012
3013/*
3014 * See cancel_delayed_work()
3015 */
3016bool cancel_work(struct work_struct *work)
3017{
3018 return __cancel_work(work, false);
3019}
3020
Tejun Heo401a8d02010-09-16 10:36:00 +02003021/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003022 * cancel_delayed_work - cancel a delayed work
3023 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003024 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003025 * Kill off a pending delayed_work.
3026 *
3027 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3028 * pending.
3029 *
3030 * Note:
3031 * The work callback function may still be running on return, unless
3032 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3033 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003034 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003035 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003036 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003037bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003038{
Jens Axboef72b8792016-08-24 15:51:50 -06003039 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003040}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003041EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003042
3043/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003044 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3045 * @dwork: the delayed work cancel
3046 *
3047 * This is cancel_work_sync() for delayed works.
3048 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003049 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003050 * %true if @dwork was pending, %false otherwise.
3051 */
3052bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003053{
Tejun Heo36e227d2012-08-03 10:30:46 -07003054 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003055}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003056EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003058/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003059 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003060 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003061 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003062 * schedule_on_each_cpu() executes @func on each online CPU using the
3063 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003064 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003065 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003066 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003067 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003068 */
David Howells65f27f32006-11-22 14:55:48 +00003069int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003070{
3071 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003072 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003073
Andrew Mortonb6136772006-06-25 05:47:49 -07003074 works = alloc_percpu(struct work_struct);
3075 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003076 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003077
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003078 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003079
Christoph Lameter15316ba2006-01-08 01:00:43 -08003080 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003081 struct work_struct *work = per_cpu_ptr(works, cpu);
3082
3083 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003084 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003085 }
Tejun Heo93981802009-11-17 14:06:20 -08003086
3087 for_each_online_cpu(cpu)
3088 flush_work(per_cpu_ptr(works, cpu));
3089
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003090 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003091 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003092 return 0;
3093}
3094
Alan Sterneef6a7d2010-02-12 17:39:21 +09003095/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003096 * execute_in_process_context - reliably execute the routine with user context
3097 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003098 * @ew: guaranteed storage for the execute work structure (must
3099 * be available when the work executes)
3100 *
3101 * Executes the function immediately if process context is available,
3102 * otherwise schedules the function for delayed execution.
3103 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003104 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003105 * 1 - function was scheduled for execution
3106 */
David Howells65f27f32006-11-22 14:55:48 +00003107int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003108{
3109 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003110 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003111 return 0;
3112 }
3113
David Howells65f27f32006-11-22 14:55:48 +00003114 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003115 schedule_work(&ew->work);
3116
3117 return 1;
3118}
3119EXPORT_SYMBOL_GPL(execute_in_process_context);
3120
Tejun Heo7a4e3442013-03-12 11:30:00 -07003121/**
3122 * free_workqueue_attrs - free a workqueue_attrs
3123 * @attrs: workqueue_attrs to free
3124 *
3125 * Undo alloc_workqueue_attrs().
3126 */
3127void free_workqueue_attrs(struct workqueue_attrs *attrs)
3128{
3129 if (attrs) {
3130 free_cpumask_var(attrs->cpumask);
3131 kfree(attrs);
3132 }
3133}
3134
3135/**
3136 * alloc_workqueue_attrs - allocate a workqueue_attrs
3137 * @gfp_mask: allocation mask to use
3138 *
3139 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003140 * return it.
3141 *
3142 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003143 */
3144struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3145{
3146 struct workqueue_attrs *attrs;
3147
3148 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3149 if (!attrs)
3150 goto fail;
3151 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3152 goto fail;
3153
Tejun Heo13e2e552013-04-01 11:23:31 -07003154 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003155 return attrs;
3156fail:
3157 free_workqueue_attrs(attrs);
3158 return NULL;
3159}
3160
Tejun Heo29c91e92013-03-12 11:30:03 -07003161static void copy_workqueue_attrs(struct workqueue_attrs *to,
3162 const struct workqueue_attrs *from)
3163{
3164 to->nice = from->nice;
3165 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003166 /*
3167 * Unlike hash and equality test, this function doesn't ignore
3168 * ->no_numa as it is used for both pool and wq attrs. Instead,
3169 * get_unbound_pool() explicitly clears ->no_numa after copying.
3170 */
3171 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003172}
3173
Tejun Heo29c91e92013-03-12 11:30:03 -07003174/* hash value of the content of @attr */
3175static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3176{
3177 u32 hash = 0;
3178
3179 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003180 hash = jhash(cpumask_bits(attrs->cpumask),
3181 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003182 return hash;
3183}
3184
3185/* content equality test */
3186static bool wqattrs_equal(const struct workqueue_attrs *a,
3187 const struct workqueue_attrs *b)
3188{
3189 if (a->nice != b->nice)
3190 return false;
3191 if (!cpumask_equal(a->cpumask, b->cpumask))
3192 return false;
3193 return true;
3194}
3195
Tejun Heo7a4e3442013-03-12 11:30:00 -07003196/**
3197 * init_worker_pool - initialize a newly zalloc'd worker_pool
3198 * @pool: worker_pool to initialize
3199 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303200 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003201 *
3202 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003203 * inside @pool proper are initialized and put_unbound_pool() can be called
3204 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003205 */
3206static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003207{
3208 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003209 pool->id = -1;
3210 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003211 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003212 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003213 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003214 INIT_LIST_HEAD(&pool->worklist);
3215 INIT_LIST_HEAD(&pool->idle_list);
3216 hash_init(pool->busy_hash);
3217
3218 init_timer_deferrable(&pool->idle_timer);
3219 pool->idle_timer.function = idle_worker_timeout;
3220 pool->idle_timer.data = (unsigned long)pool;
3221
3222 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3223 (unsigned long)pool);
3224
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003225 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003226 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003227
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003228 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003229 INIT_HLIST_NODE(&pool->hash_node);
3230 pool->refcnt = 1;
3231
3232 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003233 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3234 if (!pool->attrs)
3235 return -ENOMEM;
3236 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003237}
3238
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003239static void rcu_free_wq(struct rcu_head *rcu)
3240{
3241 struct workqueue_struct *wq =
3242 container_of(rcu, struct workqueue_struct, rcu);
3243
3244 if (!(wq->flags & WQ_UNBOUND))
3245 free_percpu(wq->cpu_pwqs);
3246 else
3247 free_workqueue_attrs(wq->unbound_attrs);
3248
3249 kfree(wq->rescuer);
3250 kfree(wq);
3251}
3252
Tejun Heo29c91e92013-03-12 11:30:03 -07003253static void rcu_free_pool(struct rcu_head *rcu)
3254{
3255 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3256
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003257 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003258 free_workqueue_attrs(pool->attrs);
3259 kfree(pool);
3260}
3261
3262/**
3263 * put_unbound_pool - put a worker_pool
3264 * @pool: worker_pool to put
3265 *
3266 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003267 * safe manner. get_unbound_pool() calls this function on its failure path
3268 * and this function should be able to release pools which went through,
3269 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003270 *
3271 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003272 */
3273static void put_unbound_pool(struct worker_pool *pool)
3274{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003275 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003276 struct worker *worker;
3277
Tejun Heoa892cac2013-04-01 11:23:32 -07003278 lockdep_assert_held(&wq_pool_mutex);
3279
3280 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003281 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003282
3283 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003284 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003285 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003286 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003287
3288 /* release id and unhash */
3289 if (pool->id >= 0)
3290 idr_remove(&worker_pool_idr, pool->id);
3291 hash_del(&pool->hash_node);
3292
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003293 /*
Tejun Heo43a980a2017-10-09 08:04:13 -07003294 * Become the manager and destroy all workers. This prevents
3295 * @pool's workers from blocking on attach_mutex. We're the last
3296 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003297 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003298 spin_lock_irq(&pool->lock);
Tejun Heo43a980a2017-10-09 08:04:13 -07003299 wait_event_lock_irq(wq_manager_wait,
3300 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3301 pool->flags |= POOL_MANAGER_ACTIVE;
3302
Lai Jiangshan1037de32014-05-22 16:44:07 +08003303 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003304 destroy_worker(worker);
3305 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003306 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003307
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003308 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003309 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003310 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003311 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003312
3313 if (pool->detach_completion)
3314 wait_for_completion(pool->detach_completion);
3315
Tejun Heo29c91e92013-03-12 11:30:03 -07003316 /* shut down the timers */
3317 del_timer_sync(&pool->idle_timer);
3318 del_timer_sync(&pool->mayday_timer);
3319
3320 /* sched-RCU protected to allow dereferences from get_work_pool() */
3321 call_rcu_sched(&pool->rcu, rcu_free_pool);
3322}
3323
3324/**
3325 * get_unbound_pool - get a worker_pool with the specified attributes
3326 * @attrs: the attributes of the worker_pool to get
3327 *
3328 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3329 * reference count and return it. If there already is a matching
3330 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003331 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003332 *
3333 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003334 *
3335 * Return: On success, a worker_pool with the same attributes as @attrs.
3336 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003337 */
3338static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3339{
Tejun Heo29c91e92013-03-12 11:30:03 -07003340 u32 hash = wqattrs_hash(attrs);
3341 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003342 int node;
Xunlei Pange2273582015-10-09 11:53:12 +08003343 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003344
Tejun Heoa892cac2013-04-01 11:23:32 -07003345 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003346
3347 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003348 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3349 if (wqattrs_equal(pool->attrs, attrs)) {
3350 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003351 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003352 }
3353 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003354
Xunlei Pange2273582015-10-09 11:53:12 +08003355 /* if cpumask is contained inside a NUMA node, we belong to that node */
3356 if (wq_numa_enabled) {
3357 for_each_node(node) {
3358 if (cpumask_subset(attrs->cpumask,
3359 wq_numa_possible_cpumask[node])) {
3360 target_node = node;
3361 break;
3362 }
3363 }
3364 }
3365
Tejun Heo29c91e92013-03-12 11:30:03 -07003366 /* nope, create a new one */
Xunlei Pange2273582015-10-09 11:53:12 +08003367 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003368 if (!pool || init_worker_pool(pool) < 0)
3369 goto fail;
3370
Tejun Heo8864b4e2013-03-12 11:30:04 -07003371 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003372 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange2273582015-10-09 11:53:12 +08003373 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003374
Shaohua Li2865a8f2013-08-01 09:56:36 +08003375 /*
3376 * no_numa isn't a worker_pool attribute, always clear it. See
3377 * 'struct workqueue_attrs' comments for detail.
3378 */
3379 pool->attrs->no_numa = false;
3380
Tejun Heo29c91e92013-03-12 11:30:03 -07003381 if (worker_pool_assign_id(pool) < 0)
3382 goto fail;
3383
3384 /* create and start the initial worker */
Tejun Heoac4bbc02016-09-16 15:49:32 -04003385 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 goto fail;
3387
Tejun Heo29c91e92013-03-12 11:30:03 -07003388 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003389 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003390
Tejun Heo29c91e92013-03-12 11:30:03 -07003391 return pool;
3392fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003393 if (pool)
3394 put_unbound_pool(pool);
3395 return NULL;
3396}
3397
Tejun Heo8864b4e2013-03-12 11:30:04 -07003398static void rcu_free_pwq(struct rcu_head *rcu)
3399{
3400 kmem_cache_free(pwq_cache,
3401 container_of(rcu, struct pool_workqueue, rcu));
3402}
3403
3404/*
3405 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3406 * and needs to be destroyed.
3407 */
3408static void pwq_unbound_release_workfn(struct work_struct *work)
3409{
3410 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3411 unbound_release_work);
3412 struct workqueue_struct *wq = pwq->wq;
3413 struct worker_pool *pool = pwq->pool;
Yang Yingliang1f63eec2021-07-14 17:19:33 +08003414 bool is_last = false;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003415
Yang Yingliang1f63eec2021-07-14 17:19:33 +08003416 /*
3417 * when @pwq is not linked, it doesn't hold any reference to the
3418 * @wq, and @wq is invalid to access.
3419 */
3420 if (!list_empty(&pwq->pwqs_node)) {
3421 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3422 return;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003423
Yang Yingliang1f63eec2021-07-14 17:19:33 +08003424 mutex_lock(&wq->mutex);
3425 list_del_rcu(&pwq->pwqs_node);
3426 is_last = list_empty(&wq->pwqs);
3427 mutex_unlock(&wq->mutex);
3428 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003429
Tejun Heoa892cac2013-04-01 11:23:32 -07003430 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003431 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003432 mutex_unlock(&wq_pool_mutex);
3433
Tejun Heo8864b4e2013-03-12 11:30:04 -07003434 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3435
3436 /*
3437 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003438 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003439 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003440 if (is_last)
3441 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003442}
3443
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003444/**
Tejun Heo699ce092013-03-13 16:51:35 -07003445 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003446 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003447 *
Tejun Heo699ce092013-03-13 16:51:35 -07003448 * If @pwq isn't freezing, set @pwq->max_active to the associated
3449 * workqueue's saved_max_active and activate delayed work items
3450 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003451 */
Tejun Heo699ce092013-03-13 16:51:35 -07003452static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003453{
Tejun Heo699ce092013-03-13 16:51:35 -07003454 struct workqueue_struct *wq = pwq->wq;
3455 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heoac4bbc02016-09-16 15:49:32 -04003456 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003457
Tejun Heo699ce092013-03-13 16:51:35 -07003458 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003459 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003460
3461 /* fast exit for non-freezable wqs */
3462 if (!freezable && pwq->max_active == wq->saved_max_active)
3463 return;
3464
Tejun Heoac4bbc02016-09-16 15:49:32 -04003465 /* this function can be called during early boot w/ irq disabled */
3466 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003467
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003468 /*
3469 * During [un]freezing, the caller is responsible for ensuring that
3470 * this function is called at least once after @workqueue_freezing
3471 * is updated and visible.
3472 */
3473 if (!freezable || !workqueue_freezing) {
Yunfeng Yefe458772020-11-19 14:21:25 +08003474 bool kick = false;
3475
Tejun Heo699ce092013-03-13 16:51:35 -07003476 pwq->max_active = wq->saved_max_active;
3477
3478 while (!list_empty(&pwq->delayed_works) &&
Yunfeng Yefe458772020-11-19 14:21:25 +08003479 pwq->nr_active < pwq->max_active) {
Tejun Heo699ce092013-03-13 16:51:35 -07003480 pwq_activate_first_delayed(pwq);
Yunfeng Yefe458772020-11-19 14:21:25 +08003481 kick = true;
3482 }
Lai Jiangshan951a0782013-03-20 10:52:30 -07003483
3484 /*
3485 * Need to kick a worker after thawed or an unbound wq's
Yunfeng Yefe458772020-11-19 14:21:25 +08003486 * max_active is bumped. In realtime scenarios, always kicking a
3487 * worker will cause interference on the isolated cpu cores, so
3488 * let's kick iff work items were activated.
Lai Jiangshan951a0782013-03-20 10:52:30 -07003489 */
Yunfeng Yefe458772020-11-19 14:21:25 +08003490 if (kick)
3491 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003492 } else {
3493 pwq->max_active = 0;
3494 }
3495
Tejun Heoac4bbc02016-09-16 15:49:32 -04003496 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003497}
3498
Tejun Heoe50aba92013-04-01 11:23:35 -07003499/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003500static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3501 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003502{
3503 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3504
Tejun Heoe50aba92013-04-01 11:23:35 -07003505 memset(pwq, 0, sizeof(*pwq));
3506
Tejun Heod2c1d402013-03-12 11:30:04 -07003507 pwq->pool = pool;
3508 pwq->wq = wq;
3509 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003510 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003511 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003512 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003513 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003514 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003515}
Tejun Heod2c1d402013-03-12 11:30:04 -07003516
Tejun Heof147f292013-04-01 11:23:35 -07003517/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003518static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003519{
3520 struct workqueue_struct *wq = pwq->wq;
3521
3522 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003523
Tejun Heo1befcf32013-04-01 11:23:35 -07003524 /* may be called multiple times, ignore if already linked */
3525 if (!list_empty(&pwq->pwqs_node))
3526 return;
3527
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003528 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003529 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003530
3531 /* sync max_active to the current setting */
3532 pwq_adjust_max_active(pwq);
3533
3534 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003535 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003536}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003537
Tejun Heof147f292013-04-01 11:23:35 -07003538/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3539static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3540 const struct workqueue_attrs *attrs)
3541{
3542 struct worker_pool *pool;
3543 struct pool_workqueue *pwq;
3544
3545 lockdep_assert_held(&wq_pool_mutex);
3546
3547 pool = get_unbound_pool(attrs);
3548 if (!pool)
3549 return NULL;
3550
Tejun Heoe50aba92013-04-01 11:23:35 -07003551 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003552 if (!pwq) {
3553 put_unbound_pool(pool);
3554 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003555 }
Tejun Heo6029a912013-04-01 11:23:34 -07003556
Tejun Heof147f292013-04-01 11:23:35 -07003557 init_pwq(pwq, wq, pool);
3558 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003559}
3560
Tejun Heo4c16bd32013-04-01 11:23:36 -07003561/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003562 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003563 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003564 * @node: the target NUMA node
3565 * @cpu_going_down: if >= 0, the CPU to consider as offline
3566 * @cpumask: outarg, the resulting cpumask
3567 *
3568 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3569 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003570 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003571 *
3572 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3573 * enabled and @node has online CPUs requested by @attrs, the returned
3574 * cpumask is the intersection of the possible CPUs of @node and
3575 * @attrs->cpumask.
3576 *
3577 * The caller is responsible for ensuring that the cpumask of @node stays
3578 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003579 *
3580 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3581 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003582 */
3583static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3584 int cpu_going_down, cpumask_t *cpumask)
3585{
Tejun Heod55262c2013-04-01 11:23:38 -07003586 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003587 goto use_dfl;
3588
3589 /* does @node have any online CPUs @attrs wants? */
3590 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3591 if (cpu_going_down >= 0)
3592 cpumask_clear_cpu(cpu_going_down, cpumask);
3593
3594 if (cpumask_empty(cpumask))
3595 goto use_dfl;
3596
3597 /* yeap, return possible CPUs in @node that @attrs wants */
3598 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3599 return !cpumask_equal(cpumask, attrs->cpumask);
3600
3601use_dfl:
3602 cpumask_copy(cpumask, attrs->cpumask);
3603 return false;
3604}
3605
Tejun Heo1befcf32013-04-01 11:23:35 -07003606/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3607static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3608 int node,
3609 struct pool_workqueue *pwq)
3610{
3611 struct pool_workqueue *old_pwq;
3612
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003613 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003614 lockdep_assert_held(&wq->mutex);
3615
3616 /* link_pwq() can handle duplicate calls */
3617 link_pwq(pwq);
3618
3619 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3620 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3621 return old_pwq;
3622}
3623
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003624/* context to store the prepared attrs & pwqs before applying */
3625struct apply_wqattrs_ctx {
3626 struct workqueue_struct *wq; /* target workqueue */
3627 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003628 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003629 struct pool_workqueue *dfl_pwq;
3630 struct pool_workqueue *pwq_tbl[];
3631};
3632
3633/* free the resources after success or abort */
3634static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3635{
3636 if (ctx) {
3637 int node;
3638
3639 for_each_node(node)
3640 put_pwq_unlocked(ctx->pwq_tbl[node]);
3641 put_pwq_unlocked(ctx->dfl_pwq);
3642
3643 free_workqueue_attrs(ctx->attrs);
3644
3645 kfree(ctx);
3646 }
3647}
3648
3649/* allocate the attrs and pwqs for later installation */
3650static struct apply_wqattrs_ctx *
3651apply_wqattrs_prepare(struct workqueue_struct *wq,
3652 const struct workqueue_attrs *attrs)
3653{
3654 struct apply_wqattrs_ctx *ctx;
3655 struct workqueue_attrs *new_attrs, *tmp_attrs;
3656 int node;
3657
3658 lockdep_assert_held(&wq_pool_mutex);
3659
3660 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3661 GFP_KERNEL);
3662
3663 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3664 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3665 if (!ctx || !new_attrs || !tmp_attrs)
3666 goto out_free;
3667
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003668 /*
3669 * Calculate the attrs of the default pwq.
3670 * If the user configured cpumask doesn't overlap with the
3671 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3672 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003673 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003674 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003675 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3676 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003677
3678 /*
3679 * We may create multiple pwqs with differing cpumasks. Make a
3680 * copy of @new_attrs which will be modified and used to obtain
3681 * pools.
3682 */
3683 copy_workqueue_attrs(tmp_attrs, new_attrs);
3684
3685 /*
3686 * If something goes wrong during CPU up/down, we'll fall back to
3687 * the default pwq covering whole @attrs->cpumask. Always create
3688 * it even if we don't use it immediately.
3689 */
3690 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3691 if (!ctx->dfl_pwq)
3692 goto out_free;
3693
3694 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003695 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003696 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3697 if (!ctx->pwq_tbl[node])
3698 goto out_free;
3699 } else {
3700 ctx->dfl_pwq->refcnt++;
3701 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3702 }
3703 }
3704
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003705 /* save the user configured attrs and sanitize it. */
3706 copy_workqueue_attrs(new_attrs, attrs);
3707 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003708 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003709
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003710 ctx->wq = wq;
3711 free_workqueue_attrs(tmp_attrs);
3712 return ctx;
3713
3714out_free:
3715 free_workqueue_attrs(tmp_attrs);
3716 free_workqueue_attrs(new_attrs);
3717 apply_wqattrs_cleanup(ctx);
3718 return NULL;
3719}
3720
3721/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3722static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3723{
3724 int node;
3725
3726 /* all pwqs have been created successfully, let's install'em */
3727 mutex_lock(&ctx->wq->mutex);
3728
3729 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3730
3731 /* save the previous pwq and install the new one */
3732 for_each_node(node)
3733 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3734 ctx->pwq_tbl[node]);
3735
3736 /* @dfl_pwq might not have been used, ensure it's linked */
3737 link_pwq(ctx->dfl_pwq);
3738 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3739
3740 mutex_unlock(&ctx->wq->mutex);
3741}
3742
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003743static void apply_wqattrs_lock(void)
3744{
3745 /* CPUs should stay stable across pwq creations and installations */
3746 get_online_cpus();
3747 mutex_lock(&wq_pool_mutex);
3748}
3749
3750static void apply_wqattrs_unlock(void)
3751{
3752 mutex_unlock(&wq_pool_mutex);
3753 put_online_cpus();
3754}
3755
3756static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3757 const struct workqueue_attrs *attrs)
3758{
3759 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003760
3761 /* only unbound workqueues can change attributes */
3762 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3763 return -EINVAL;
3764
3765 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heof9636c92017-07-23 08:36:15 -04003766 if (!list_empty(&wq->pwqs)) {
3767 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3768 return -EINVAL;
3769
3770 wq->flags &= ~__WQ_ORDERED;
3771 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003772
3773 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003774 if (!ctx)
3775 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003776
3777 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003778 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003779 apply_wqattrs_cleanup(ctx);
3780
wanghaibin62011712016-01-07 20:38:59 +08003781 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003782}
3783
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003784/**
3785 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3786 * @wq: the target workqueue
3787 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3788 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003789 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3790 * machines, this function maps a separate pwq to each NUMA node with
3791 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3792 * NUMA node it was issued on. Older pwqs are released as in-flight work
3793 * items finish. Note that a work item which repeatedly requeues itself
3794 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003795 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003796 * Performs GFP_KERNEL allocations.
3797 *
3798 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003799 */
3800int apply_workqueue_attrs(struct workqueue_struct *wq,
3801 const struct workqueue_attrs *attrs)
3802{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003803 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003804
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003805 apply_wqattrs_lock();
3806 ret = apply_workqueue_attrs_locked(wq, attrs);
3807 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003808
Tejun Heo48621252013-04-01 11:23:31 -07003809 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003810}
3811
Tejun Heo4c16bd32013-04-01 11:23:36 -07003812/**
3813 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3814 * @wq: the target workqueue
3815 * @cpu: the CPU coming up or going down
3816 * @online: whether @cpu is coming up or going down
3817 *
3818 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3819 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3820 * @wq accordingly.
3821 *
3822 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3823 * falls back to @wq->dfl_pwq which may not be optimal but is always
3824 * correct.
3825 *
3826 * Note that when the last allowed CPU of a NUMA node goes offline for a
3827 * workqueue with a cpumask spanning multiple nodes, the workers which were
3828 * already executing the work items for the workqueue will lose their CPU
3829 * affinity and may execute on any CPU. This is similar to how per-cpu
3830 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3831 * affinity, it's the user's responsibility to flush the work item from
3832 * CPU_DOWN_PREPARE.
3833 */
3834static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3835 bool online)
3836{
3837 int node = cpu_to_node(cpu);
3838 int cpu_off = online ? -1 : cpu;
3839 struct pool_workqueue *old_pwq = NULL, *pwq;
3840 struct workqueue_attrs *target_attrs;
3841 cpumask_t *cpumask;
3842
3843 lockdep_assert_held(&wq_pool_mutex);
3844
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003845 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3846 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003847 return;
3848
3849 /*
3850 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3851 * Let's use a preallocated one. The following buf is protected by
3852 * CPU hotplug exclusion.
3853 */
3854 target_attrs = wq_update_unbound_numa_attrs_buf;
3855 cpumask = target_attrs->cpumask;
3856
Tejun Heo4c16bd32013-04-01 11:23:36 -07003857 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3858 pwq = unbound_pwq_by_node(wq, node);
3859
3860 /*
3861 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003862 * different from the default pwq's, we need to compare it to @pwq's
3863 * and create a new one if they don't match. If the target cpumask
3864 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003865 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003866 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003867 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003868 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003869 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003870 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003871 }
3872
Tejun Heo4c16bd32013-04-01 11:23:36 -07003873 /* create a new pwq */
3874 pwq = alloc_unbound_pwq(wq, target_attrs);
3875 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003876 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3877 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003878 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003879 }
3880
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003881 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003882 mutex_lock(&wq->mutex);
3883 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3884 goto out_unlock;
3885
3886use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003887 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003888 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3889 get_pwq(wq->dfl_pwq);
3890 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3891 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3892out_unlock:
3893 mutex_unlock(&wq->mutex);
3894 put_pwq_unlocked(old_pwq);
3895}
3896
Tejun Heo30cdf242013-03-12 11:29:57 -07003897static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003898{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003899 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003900 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003901
Tejun Heo30cdf242013-03-12 11:29:57 -07003902 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003903 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3904 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003905 return -ENOMEM;
3906
3907 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003908 struct pool_workqueue *pwq =
3909 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003910 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003911 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003912
Tejun Heof147f292013-04-01 11:23:35 -07003913 init_pwq(pwq, wq, &cpu_pools[highpri]);
3914
3915 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003916 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003917 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003918 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003919 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003920 } else if (wq->flags & __WQ_ORDERED) {
3921 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3922 /* there should only be single pwq for ordering guarantee */
3923 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3924 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3925 "ordering guarantee broken for workqueue %s\n", wq->name);
3926 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003927 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003928 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003929 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003930}
3931
Tejun Heof3421792010-07-02 10:03:51 +02003932static int wq_clamp_max_active(int max_active, unsigned int flags,
3933 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003934{
Tejun Heof3421792010-07-02 10:03:51 +02003935 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3936
3937 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003938 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3939 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003940
Tejun Heof3421792010-07-02 10:03:51 +02003941 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003942}
3943
Tejun Heob196be82012-01-10 15:11:35 -08003944struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003945 unsigned int flags,
3946 int max_active,
3947 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003948 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003949{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003950 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07003951 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003952 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003953 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003954
Tejun Heo61a0adb2017-07-18 18:41:52 -04003955 /*
3956 * Unbound && max_active == 1 used to imply ordered, which is no
3957 * longer the case on NUMA machines due to per-node pools. While
3958 * alloc_ordered_workqueue() is the right way to create an ordered
3959 * workqueue, keep the previous behavior to avoid subtle breakages
3960 * on NUMA.
3961 */
3962 if ((flags & WQ_UNBOUND) && max_active == 1)
3963 flags |= __WQ_ORDERED;
3964
Viresh Kumarcee22a12013-04-08 16:45:40 +05303965 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3966 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3967 flags |= WQ_UNBOUND;
3968
Tejun Heoecf68812013-04-01 11:23:34 -07003969 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003970 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08003971 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003972
3973 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003974 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003975 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003976
Tejun Heo6029a912013-04-01 11:23:34 -07003977 if (flags & WQ_UNBOUND) {
3978 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3979 if (!wq->unbound_attrs)
3980 goto err_free_wq;
3981 }
3982
Tejun Heoecf68812013-04-01 11:23:34 -07003983 va_start(args, lock_name);
3984 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003985 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003986
Tejun Heod320c032010-06-29 10:07:14 +02003987 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003988 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003989
Tejun Heob196be82012-01-10 15:11:35 -08003990 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003991 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003992 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003993 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003994 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003995 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003996 INIT_LIST_HEAD(&wq->flusher_queue);
3997 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003998 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003999
Johannes Bergeb13ba82008-01-16 09:51:58 +01004000 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004001 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004002
Tejun Heo30cdf242013-03-12 11:29:57 -07004003 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004004 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004005
Tejun Heo493008a2013-03-12 11:30:03 -07004006 /*
4007 * Workqueues which may be used during memory reclaim should
4008 * have a rescuer to guarantee forward progress.
4009 */
4010 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004011 struct worker *rescuer;
4012
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004013 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004014 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004015 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004016
Tejun Heo111c2252013-01-17 17:16:24 -08004017 rescuer->rescue_wq = wq;
4018 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004019 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004020 if (IS_ERR(rescuer->task)) {
4021 kfree(rescuer);
4022 goto err_destroy;
4023 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004024
Tejun Heod2c1d402013-03-12 11:30:04 -07004025 wq->rescuer = rescuer;
Peter Zijlstra25834c72015-05-15 17:43:34 +02004026 kthread_bind_mask(rescuer->task, cpu_possible_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02004027 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004028 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004029
Tejun Heo226223a2013-03-12 11:30:05 -07004030 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4031 goto err_destroy;
4032
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004033 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004034 * wq_pool_mutex protects global freeze state and workqueues list.
4035 * Grab it, adjust max_active and add the new @wq to workqueues
4036 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004037 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004038 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004039
Lai Jiangshana357fc02013-03-25 16:57:19 -07004040 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004041 for_each_pwq(pwq, wq)
4042 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004043 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004044
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004045 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004046
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004047 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004048
Oleg Nesterov3af244332007-05-09 02:34:09 -07004049 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004050
4051err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004052 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004053 kfree(wq);
4054 return NULL;
4055err_destroy:
4056 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004057 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004058}
Tejun Heod320c032010-06-29 10:07:14 +02004059EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004060
4061/**
4062 * destroy_workqueue - safely terminate a workqueue
4063 * @wq: target workqueue
4064 *
4065 * Safely destroy a workqueue. All work currently pending will be done first.
4066 */
4067void destroy_workqueue(struct workqueue_struct *wq)
4068{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004069 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004070 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004071
Tejun Heo54f859a2019-09-18 18:43:40 -07004072 /*
4073 * Remove it from sysfs first so that sanity check failure doesn't
4074 * lead to sysfs name conflicts.
4075 */
4076 workqueue_sysfs_unregister(wq);
4077
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004078 /* drain it before proceeding with destruction */
4079 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004080
Tejun Heo54f859a2019-09-18 18:43:40 -07004081 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4082 if (wq->rescuer) {
4083 struct worker *rescuer = wq->rescuer;
4084
4085 /* this prevents new queueing */
4086 spin_lock_irq(&wq_mayday_lock);
4087 wq->rescuer = NULL;
4088 spin_unlock_irq(&wq_mayday_lock);
4089
4090 /* rescuer will empty maydays list before exiting */
4091 kthread_stop(rescuer->task);
Tejun Heo1a1e9ff2019-09-20 13:39:57 -07004092 kfree(rescuer);
Tejun Heo54f859a2019-09-18 18:43:40 -07004093 }
4094
Tejun Heo6183c002013-03-12 11:29:57 -07004095 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004096 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004097 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004098 int i;
4099
Tejun Heo76af4d92013-03-12 11:30:00 -07004100 for (i = 0; i < WORK_NR_COLORS; i++) {
4101 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004102 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004103 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004104 }
4105 }
4106
Lai Jiangshan5c529592013-04-04 10:05:38 +08004107 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004108 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004109 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004110 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004111 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004112 }
Tejun Heo6183c002013-03-12 11:29:57 -07004113 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004114 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004115
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004116 /*
4117 * wq list is used to freeze wq, remove from list after
4118 * flushing is complete in case freeze races us.
4119 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004120 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004121 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004122 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004123
Tejun Heo8864b4e2013-03-12 11:30:04 -07004124 if (!(wq->flags & WQ_UNBOUND)) {
4125 /*
4126 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004127 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004128 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004129 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004130 } else {
4131 /*
4132 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004133 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4134 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004135 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004136 for_each_node(node) {
4137 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4138 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4139 put_pwq_unlocked(pwq);
4140 }
4141
4142 /*
4143 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4144 * put. Don't access it afterwards.
4145 */
4146 pwq = wq->dfl_pwq;
4147 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004148 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004149 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004150}
4151EXPORT_SYMBOL_GPL(destroy_workqueue);
4152
Tejun Heodcd989c2010-06-29 10:07:14 +02004153/**
4154 * workqueue_set_max_active - adjust max_active of a workqueue
4155 * @wq: target workqueue
4156 * @max_active: new max_active value.
4157 *
4158 * Set max_active of @wq to @max_active.
4159 *
4160 * CONTEXT:
4161 * Don't call from IRQ context.
4162 */
4163void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4164{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004165 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004166
Tejun Heo8719dce2013-03-12 11:30:04 -07004167 /* disallow meddling with max_active for ordered workqueues */
Tejun Heof9636c92017-07-23 08:36:15 -04004168 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004169 return;
4170
Tejun Heof3421792010-07-02 10:03:51 +02004171 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004172
Lai Jiangshana357fc02013-03-25 16:57:19 -07004173 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004174
Tejun Heof9636c92017-07-23 08:36:15 -04004175 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004176 wq->saved_max_active = max_active;
4177
Tejun Heo699ce092013-03-13 16:51:35 -07004178 for_each_pwq(pwq, wq)
4179 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004180
Lai Jiangshana357fc02013-03-25 16:57:19 -07004181 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004182}
4183EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4184
4185/**
Lukas Wunner225ce6d2018-02-11 10:38:28 +01004186 * current_work - retrieve %current task's work struct
4187 *
4188 * Determine if %current task is a workqueue worker and what it's working on.
4189 * Useful to find out the context that the %current task is running in.
4190 *
4191 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4192 */
4193struct work_struct *current_work(void)
4194{
4195 struct worker *worker = current_wq_worker();
4196
4197 return worker ? worker->current_work : NULL;
4198}
4199EXPORT_SYMBOL(current_work);
4200
4201/**
Tejun Heoe62676162013-03-12 17:41:37 -07004202 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4203 *
4204 * Determine whether %current is a workqueue rescuer. Can be used from
4205 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004206 *
4207 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004208 */
4209bool current_is_workqueue_rescuer(void)
4210{
4211 struct worker *worker = current_wq_worker();
4212
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004213 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004214}
4215
4216/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004217 * workqueue_congested - test whether a workqueue is congested
4218 * @cpu: CPU in question
4219 * @wq: target workqueue
4220 *
4221 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4222 * no synchronization around this function and the test result is
4223 * unreliable and only useful as advisory hints or for debugging.
4224 *
Tejun Heod3251852013-05-10 11:10:17 -07004225 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4226 * Note that both per-cpu and unbound workqueues may be associated with
4227 * multiple pool_workqueues which have separate congested states. A
4228 * workqueue being congested on one CPU doesn't mean the workqueue is also
4229 * contested on other CPUs / NUMA nodes.
4230 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004231 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004232 * %true if congested, %false otherwise.
4233 */
Tejun Heod84ff052013-03-12 11:29:59 -07004234bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004235{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004236 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004237 bool ret;
4238
Lai Jiangshan88109452013-03-20 03:28:10 +08004239 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004240
Tejun Heod3251852013-05-10 11:10:17 -07004241 if (cpu == WORK_CPU_UNBOUND)
4242 cpu = smp_processor_id();
4243
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004244 if (!(wq->flags & WQ_UNBOUND))
4245 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4246 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004247 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004248
Tejun Heo76af4d92013-03-12 11:30:00 -07004249 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004250 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004251
4252 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004253}
4254EXPORT_SYMBOL_GPL(workqueue_congested);
4255
4256/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004257 * work_busy - test whether a work is currently pending or running
4258 * @work: the work to be tested
4259 *
4260 * Test whether @work is currently pending or running. There is no
4261 * synchronization around this function and the test result is
4262 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004263 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004264 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004265 * OR'd bitmask of WORK_BUSY_* bits.
4266 */
4267unsigned int work_busy(struct work_struct *work)
4268{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004269 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004270 unsigned long flags;
4271 unsigned int ret = 0;
4272
Tejun Heodcd989c2010-06-29 10:07:14 +02004273 if (work_pending(work))
4274 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004275
Tejun Heofa1b54e2013-03-12 11:30:00 -07004276 local_irq_save(flags);
4277 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004278 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004279 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004280 if (find_worker_executing_work(pool, work))
4281 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004282 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004283 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004284 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004285
4286 return ret;
4287}
4288EXPORT_SYMBOL_GPL(work_busy);
4289
Tejun Heo3d1cb202013-04-30 15:27:22 -07004290/**
4291 * set_worker_desc - set description for the current work item
4292 * @fmt: printf-style format string
4293 * @...: arguments for the format string
4294 *
4295 * This function can be called by a running work function to describe what
4296 * the work item is about. If the worker task gets dumped, this
4297 * information will be printed out together to help debugging. The
4298 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4299 */
4300void set_worker_desc(const char *fmt, ...)
4301{
4302 struct worker *worker = current_wq_worker();
4303 va_list args;
4304
4305 if (worker) {
4306 va_start(args, fmt);
4307 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4308 va_end(args);
4309 worker->desc_valid = true;
4310 }
4311}
4312
4313/**
4314 * print_worker_info - print out worker information and description
4315 * @log_lvl: the log level to use when printing
4316 * @task: target task
4317 *
4318 * If @task is a worker and currently executing a work item, print out the
4319 * name of the workqueue being serviced and worker description set with
4320 * set_worker_desc() by the currently executing work item.
4321 *
4322 * This function can be safely called on any task as long as the
4323 * task_struct itself is accessible. While safe, this function isn't
4324 * synchronized and may print out mixups or garbages of limited length.
4325 */
4326void print_worker_info(const char *log_lvl, struct task_struct *task)
4327{
4328 work_func_t *fn = NULL;
4329 char name[WQ_NAME_LEN] = { };
4330 char desc[WORKER_DESC_LEN] = { };
4331 struct pool_workqueue *pwq = NULL;
4332 struct workqueue_struct *wq = NULL;
4333 bool desc_valid = false;
4334 struct worker *worker;
4335
4336 if (!(task->flags & PF_WQ_WORKER))
4337 return;
4338
4339 /*
4340 * This function is called without any synchronization and @task
4341 * could be in any state. Be careful with dereferences.
4342 */
Petr Mladeke7005912016-10-11 13:55:17 -07004343 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004344
4345 /*
4346 * Carefully copy the associated workqueue's workfn and name. Keep
4347 * the original last '\0' in case the original contains garbage.
4348 */
4349 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4350 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4351 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4352 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4353
4354 /* copy worker description */
4355 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4356 if (desc_valid)
4357 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4358
4359 if (fn || name[0] || desc[0]) {
4360 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4361 if (desc[0])
4362 pr_cont(" (%s)", desc);
4363 pr_cont("\n");
4364 }
4365}
4366
Tejun Heo3494fc32015-03-09 09:22:28 -04004367static void pr_cont_pool_info(struct worker_pool *pool)
4368{
4369 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4370 if (pool->node != NUMA_NO_NODE)
4371 pr_cont(" node=%d", pool->node);
4372 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4373}
4374
4375static void pr_cont_work(bool comma, struct work_struct *work)
4376{
4377 if (work->func == wq_barrier_func) {
4378 struct wq_barrier *barr;
4379
4380 barr = container_of(work, struct wq_barrier, work);
4381
4382 pr_cont("%s BAR(%d)", comma ? "," : "",
4383 task_pid_nr(barr->task));
4384 } else {
4385 pr_cont("%s %pf", comma ? "," : "", work->func);
4386 }
4387}
4388
4389static void show_pwq(struct pool_workqueue *pwq)
4390{
4391 struct worker_pool *pool = pwq->pool;
4392 struct work_struct *work;
4393 struct worker *worker;
4394 bool has_in_flight = false, has_pending = false;
4395 int bkt;
4396
4397 pr_info(" pwq %d:", pool->id);
4398 pr_cont_pool_info(pool);
4399
Tejun Heo4f5b0c72019-09-25 06:59:15 -07004400 pr_cont(" active=%d/%d refcnt=%d%s\n",
4401 pwq->nr_active, pwq->max_active, pwq->refcnt,
Tejun Heo3494fc32015-03-09 09:22:28 -04004402 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4403
4404 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4405 if (worker->current_pwq == pwq) {
4406 has_in_flight = true;
4407 break;
4408 }
4409 }
4410 if (has_in_flight) {
4411 bool comma = false;
4412
4413 pr_info(" in-flight:");
4414 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4415 if (worker->current_pwq != pwq)
4416 continue;
4417
4418 pr_cont("%s %d%s:%pf", comma ? "," : "",
4419 task_pid_nr(worker->task),
4420 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4421 worker->current_func);
4422 list_for_each_entry(work, &worker->scheduled, entry)
4423 pr_cont_work(false, work);
4424 comma = true;
4425 }
4426 pr_cont("\n");
4427 }
4428
4429 list_for_each_entry(work, &pool->worklist, entry) {
4430 if (get_work_pwq(work) == pwq) {
4431 has_pending = true;
4432 break;
4433 }
4434 }
4435 if (has_pending) {
4436 bool comma = false;
4437
4438 pr_info(" pending:");
4439 list_for_each_entry(work, &pool->worklist, entry) {
4440 if (get_work_pwq(work) != pwq)
4441 continue;
4442
4443 pr_cont_work(comma, work);
4444 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4445 }
4446 pr_cont("\n");
4447 }
4448
4449 if (!list_empty(&pwq->delayed_works)) {
4450 bool comma = false;
4451
4452 pr_info(" delayed:");
4453 list_for_each_entry(work, &pwq->delayed_works, entry) {
4454 pr_cont_work(comma, work);
4455 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4456 }
4457 pr_cont("\n");
4458 }
4459}
4460
4461/**
4462 * show_workqueue_state - dump workqueue state
4463 *
Roger Lu7b776af2016-07-01 11:05:02 +08004464 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4465 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004466 */
4467void show_workqueue_state(void)
4468{
4469 struct workqueue_struct *wq;
4470 struct worker_pool *pool;
4471 unsigned long flags;
4472 int pi;
4473
4474 rcu_read_lock_sched();
4475
4476 pr_info("Showing busy workqueues and worker pools:\n");
4477
4478 list_for_each_entry_rcu(wq, &workqueues, list) {
4479 struct pool_workqueue *pwq;
4480 bool idle = true;
4481
4482 for_each_pwq(pwq, wq) {
4483 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4484 idle = false;
4485 break;
4486 }
4487 }
4488 if (idle)
4489 continue;
4490
4491 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4492
4493 for_each_pwq(pwq, wq) {
4494 spin_lock_irqsave(&pwq->pool->lock, flags);
4495 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4496 show_pwq(pwq);
4497 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004498 /*
4499 * We could be printing a lot from atomic context, e.g.
4500 * sysrq-t -> show_workqueue_state(). Avoid triggering
4501 * hard lockup.
4502 */
4503 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004504 }
4505 }
4506
4507 for_each_pool(pool, pi) {
4508 struct worker *worker;
4509 bool first = true;
4510
4511 spin_lock_irqsave(&pool->lock, flags);
4512 if (pool->nr_workers == pool->nr_idle)
4513 goto next_pool;
4514
4515 pr_info("pool %d:", pool->id);
4516 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004517 pr_cont(" hung=%us workers=%d",
4518 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4519 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004520 if (pool->manager)
4521 pr_cont(" manager: %d",
4522 task_pid_nr(pool->manager->task));
4523 list_for_each_entry(worker, &pool->idle_list, entry) {
4524 pr_cont(" %s%d", first ? "idle: " : "",
4525 task_pid_nr(worker->task));
4526 first = false;
4527 }
4528 pr_cont("\n");
4529 next_pool:
4530 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatskyca2d7362018-01-11 09:53:35 +09004531 /*
4532 * We could be printing a lot from atomic context, e.g.
4533 * sysrq-t -> show_workqueue_state(). Avoid triggering
4534 * hard lockup.
4535 */
4536 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004537 }
4538
4539 rcu_read_unlock_sched();
4540}
4541
Tejun Heodb7bccf2010-06-29 10:07:12 +02004542/*
4543 * CPU hotplug.
4544 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004545 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004546 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004547 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004548 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004549 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004550 * blocked draining impractical.
4551 *
Tejun Heo24647572013-01-24 11:01:33 -08004552 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004553 * running as an unbound one and allowing it to be reattached later if the
4554 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004555 */
4556
Tejun Heo706026c2013-01-24 11:01:34 -08004557static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004558{
Tejun Heo38db41d2013-01-24 11:01:34 -08004559 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004560 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004561 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004562
Tejun Heof02ae732013-03-12 11:30:03 -07004563 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004564 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004565 spin_lock_irq(&pool->lock);
4566
4567 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004568 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004569 * unbound and set DISASSOCIATED. Before this, all workers
4570 * except for the ones which are still executing works from
4571 * before the last CPU down must be on the cpu. After
4572 * this, they may become diasporas.
4573 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004574 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004575 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004576
Tejun Heo24647572013-01-24 11:01:33 -08004577 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004578
Tejun Heo94cf58b2013-01-24 11:01:33 -08004579 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004580 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004581
Lai Jiangshaneb283422013-03-08 15:18:28 -08004582 /*
4583 * Call schedule() so that we cross rq->lock and thus can
4584 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4585 * This is necessary as scheduler callbacks may be invoked
4586 * from other cpus.
4587 */
4588 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004589
Lai Jiangshaneb283422013-03-08 15:18:28 -08004590 /*
4591 * Sched callbacks are disabled now. Zap nr_running.
4592 * After this, nr_running stays zero and need_more_worker()
4593 * and keep_working() are always true as long as the
4594 * worklist is not empty. This pool now behaves as an
4595 * unbound (in terms of concurrency management) pool which
4596 * are served by workers tied to the pool.
4597 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004598 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004599
4600 /*
4601 * With concurrency management just turned off, a busy
4602 * worker blocking could lead to lengthy stalls. Kick off
4603 * unbound chain execution of currently pending work items.
4604 */
4605 spin_lock_irq(&pool->lock);
4606 wake_up_worker(pool);
4607 spin_unlock_irq(&pool->lock);
4608 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004609}
4610
Tejun Heobd7c0892013-03-19 13:45:21 -07004611/**
4612 * rebind_workers - rebind all workers of a pool to the associated CPU
4613 * @pool: pool of interest
4614 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004615 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004616 */
4617static void rebind_workers(struct worker_pool *pool)
4618{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004619 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004620
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004621 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004622
Tejun Heoa9ab7752013-03-19 13:45:21 -07004623 /*
4624 * Restore CPU affinity of all workers. As all idle workers should
4625 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304626 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004627 * of all workers first and then clear UNBOUND. As we're called
4628 * from CPU_ONLINE, the following shouldn't fail.
4629 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004630 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004631 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4632 pool->attrs->cpumask) < 0);
4633
4634 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004635
4636 /*
4637 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4638 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4639 * being reworked and this can go away in time.
4640 */
4641 if (!(pool->flags & POOL_DISASSOCIATED)) {
4642 spin_unlock_irq(&pool->lock);
4643 return;
4644 }
4645
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004646 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004647
Lai Jiangshanda028462014-05-20 17:46:31 +08004648 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004649 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004650
4651 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004652 * A bound idle worker should actually be on the runqueue
4653 * of the associated CPU for local wake-ups targeting it to
4654 * work. Kick all idle workers so that they migrate to the
4655 * associated CPU. Doing this in the same loop as
4656 * replacing UNBOUND with REBOUND is safe as no worker will
4657 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004658 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004659 if (worker_flags & WORKER_IDLE)
4660 wake_up_process(worker->task);
4661
4662 /*
4663 * We want to clear UNBOUND but can't directly call
4664 * worker_clr_flags() or adjust nr_running. Atomically
4665 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4666 * @worker will clear REBOUND using worker_clr_flags() when
4667 * it initiates the next execution cycle thus restoring
4668 * concurrency management. Note that when or whether
4669 * @worker clears REBOUND doesn't affect correctness.
4670 *
4671 * ACCESS_ONCE() is necessary because @worker->flags may be
4672 * tested without holding any lock in
4673 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4674 * fail incorrectly leading to premature concurrency
4675 * management operations.
4676 */
4677 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4678 worker_flags |= WORKER_REBOUND;
4679 worker_flags &= ~WORKER_UNBOUND;
4680 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004681 }
4682
Tejun Heoa9ab7752013-03-19 13:45:21 -07004683 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004684}
4685
Tejun Heo7dbc7252013-03-19 13:45:21 -07004686/**
4687 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4688 * @pool: unbound pool of interest
4689 * @cpu: the CPU which is coming up
4690 *
4691 * An unbound pool may end up with a cpumask which doesn't have any online
4692 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4693 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4694 * online CPU before, cpus_allowed of all its workers should be restored.
4695 */
4696static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4697{
4698 static cpumask_t cpumask;
4699 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004700
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004701 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004702
4703 /* is @cpu allowed for @pool? */
4704 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4705 return;
4706
Tejun Heo7dbc7252013-03-19 13:45:21 -07004707 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004708
4709 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004710 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004711 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004712}
4713
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004714int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004715{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004716 struct worker_pool *pool;
4717
4718 for_each_cpu_worker_pool(pool, cpu) {
4719 if (pool->nr_workers)
4720 continue;
4721 if (!create_worker(pool))
4722 return -ENOMEM;
4723 }
4724 return 0;
4725}
4726
4727int workqueue_online_cpu(unsigned int cpu)
4728{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004729 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004730 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004731 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004732
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004733 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004734
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004735 for_each_pool(pool, pi) {
4736 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004737
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004738 if (pool->cpu == cpu)
4739 rebind_workers(pool);
4740 else if (pool->cpu < 0)
4741 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004742
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004743 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004744 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004745
4746 /* update NUMA affinity of unbound workqueues */
4747 list_for_each_entry(wq, &workqueues, list)
4748 wq_update_unbound_numa(wq, cpu, true);
4749
4750 mutex_unlock(&wq_pool_mutex);
4751 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004752}
4753
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004754int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004755{
Tejun Heo8db25e72012-07-17 12:39:28 -07004756 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004757 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004758
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004759 /* unbinding per-cpu workers should happen on the local CPU */
4760 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4761 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004762
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004763 /* update NUMA affinity of unbound workqueues */
4764 mutex_lock(&wq_pool_mutex);
4765 list_for_each_entry(wq, &workqueues, list)
4766 wq_update_unbound_numa(wq, cpu, false);
4767 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004768
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004769 /* wait for per-cpu unbinding to finish */
4770 flush_work(&unbind_work);
4771 destroy_work_on_stack(&unbind_work);
4772 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004773}
4774
Rusty Russell2d3854a2008-11-05 13:39:10 +11004775#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004776
Rusty Russell2d3854a2008-11-05 13:39:10 +11004777struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004778 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004779 long (*fn)(void *);
4780 void *arg;
4781 long ret;
4782};
4783
Tejun Heoed48ece2012-09-18 12:48:43 -07004784static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004785{
Tejun Heoed48ece2012-09-18 12:48:43 -07004786 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4787
Rusty Russell2d3854a2008-11-05 13:39:10 +11004788 wfc->ret = wfc->fn(wfc->arg);
4789}
4790
4791/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004792 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004793 * @cpu: the cpu to run on
4794 * @fn: the function to run
4795 * @arg: the function arg
4796 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004797 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004798 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004799 *
4800 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004801 */
Tejun Heod84ff052013-03-12 11:29:59 -07004802long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004803{
Tejun Heoed48ece2012-09-18 12:48:43 -07004804 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004805
Tejun Heoed48ece2012-09-18 12:48:43 -07004806 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4807 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004808 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004809 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004810 return wfc.ret;
4811}
4812EXPORT_SYMBOL_GPL(work_on_cpu);
4813#endif /* CONFIG_SMP */
4814
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004815#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304816
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004817/**
4818 * freeze_workqueues_begin - begin freezing workqueues
4819 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004820 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004821 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004822 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004823 *
4824 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004825 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004826 */
4827void freeze_workqueues_begin(void)
4828{
Tejun Heo24b8a842013-03-12 11:29:58 -07004829 struct workqueue_struct *wq;
4830 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004831
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004832 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004833
Tejun Heo6183c002013-03-12 11:29:57 -07004834 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004835 workqueue_freezing = true;
4836
Tejun Heo24b8a842013-03-12 11:29:58 -07004837 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004838 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004839 for_each_pwq(pwq, wq)
4840 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004841 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004842 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004843
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004844 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004845}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004846
4847/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004848 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004849 *
4850 * Check whether freezing is complete. This function must be called
4851 * between freeze_workqueues_begin() and thaw_workqueues().
4852 *
4853 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004854 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004855 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004856 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004857 * %true if some freezable workqueues are still busy. %false if freezing
4858 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004859 */
4860bool freeze_workqueues_busy(void)
4861{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004862 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004863 struct workqueue_struct *wq;
4864 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004865
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004866 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004867
Tejun Heo6183c002013-03-12 11:29:57 -07004868 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004869
Tejun Heo24b8a842013-03-12 11:29:58 -07004870 list_for_each_entry(wq, &workqueues, list) {
4871 if (!(wq->flags & WQ_FREEZABLE))
4872 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004873 /*
4874 * nr_active is monotonically decreasing. It's safe
4875 * to peek without lock.
4876 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004877 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004878 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004879 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004880 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004881 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004882 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004883 goto out_unlock;
4884 }
4885 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004886 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004887 }
4888out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004889 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004890 return busy;
4891}
4892
4893/**
4894 * thaw_workqueues - thaw workqueues
4895 *
4896 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004897 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004898 *
4899 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004900 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004901 */
4902void thaw_workqueues(void)
4903{
Tejun Heo24b8a842013-03-12 11:29:58 -07004904 struct workqueue_struct *wq;
4905 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004906
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004907 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004908
4909 if (!workqueue_freezing)
4910 goto out_unlock;
4911
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004912 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004913
Tejun Heo24b8a842013-03-12 11:29:58 -07004914 /* restore max_active and repopulate worklist */
4915 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004916 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004917 for_each_pwq(pwq, wq)
4918 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004919 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004920 }
4921
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004922out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004923 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004924}
4925#endif /* CONFIG_FREEZER */
4926
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004927static int workqueue_apply_unbound_cpumask(void)
4928{
4929 LIST_HEAD(ctxs);
4930 int ret = 0;
4931 struct workqueue_struct *wq;
4932 struct apply_wqattrs_ctx *ctx, *n;
4933
4934 lockdep_assert_held(&wq_pool_mutex);
4935
4936 list_for_each_entry(wq, &workqueues, list) {
4937 if (!(wq->flags & WQ_UNBOUND))
4938 continue;
4939 /* creating multiple pwqs breaks ordering guarantee */
4940 if (wq->flags & __WQ_ORDERED)
4941 continue;
4942
4943 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4944 if (!ctx) {
4945 ret = -ENOMEM;
4946 break;
4947 }
4948
4949 list_add_tail(&ctx->list, &ctxs);
4950 }
4951
4952 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4953 if (!ret)
4954 apply_wqattrs_commit(ctx);
4955 apply_wqattrs_cleanup(ctx);
4956 }
4957
4958 return ret;
4959}
4960
4961/**
4962 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4963 * @cpumask: the cpumask to set
4964 *
4965 * The low-level workqueues cpumask is a global cpumask that limits
4966 * the affinity of all unbound workqueues. This function check the @cpumask
4967 * and apply it to all unbound workqueues and updates all pwqs of them.
4968 *
4969 * Retun: 0 - Success
4970 * -EINVAL - Invalid @cpumask
4971 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4972 */
4973int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4974{
4975 int ret = -EINVAL;
4976 cpumask_var_t saved_cpumask;
4977
4978 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4979 return -ENOMEM;
4980
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004981 cpumask_and(cpumask, cpumask, cpu_possible_mask);
4982 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004983 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004984
4985 /* save the old wq_unbound_cpumask. */
4986 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4987
4988 /* update wq_unbound_cpumask at first and apply it to wqs. */
4989 cpumask_copy(wq_unbound_cpumask, cpumask);
4990 ret = workqueue_apply_unbound_cpumask();
4991
4992 /* restore the wq_unbound_cpumask when failed. */
4993 if (ret < 0)
4994 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4995
Lai Jiangshana0111cf2015-05-19 18:03:47 +08004996 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004997 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004998
4999 free_cpumask_var(saved_cpumask);
5000 return ret;
5001}
5002
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005003#ifdef CONFIG_SYSFS
5004/*
5005 * Workqueues with WQ_SYSFS flag set is visible to userland via
5006 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5007 * following attributes.
5008 *
5009 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5010 * max_active RW int : maximum number of in-flight work items
5011 *
5012 * Unbound workqueues have the following extra attributes.
5013 *
5014 * id RO int : the associated pool ID
5015 * nice RW int : nice value of the workers
5016 * cpumask RW mask : bitmask of allowed CPUs for the workers
5017 */
5018struct wq_device {
5019 struct workqueue_struct *wq;
5020 struct device dev;
5021};
5022
5023static struct workqueue_struct *dev_to_wq(struct device *dev)
5024{
5025 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5026
5027 return wq_dev->wq;
5028}
5029
5030static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5031 char *buf)
5032{
5033 struct workqueue_struct *wq = dev_to_wq(dev);
5034
5035 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5036}
5037static DEVICE_ATTR_RO(per_cpu);
5038
5039static ssize_t max_active_show(struct device *dev,
5040 struct device_attribute *attr, char *buf)
5041{
5042 struct workqueue_struct *wq = dev_to_wq(dev);
5043
5044 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5045}
5046
5047static ssize_t max_active_store(struct device *dev,
5048 struct device_attribute *attr, const char *buf,
5049 size_t count)
5050{
5051 struct workqueue_struct *wq = dev_to_wq(dev);
5052 int val;
5053
5054 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5055 return -EINVAL;
5056
5057 workqueue_set_max_active(wq, val);
5058 return count;
5059}
5060static DEVICE_ATTR_RW(max_active);
5061
5062static struct attribute *wq_sysfs_attrs[] = {
5063 &dev_attr_per_cpu.attr,
5064 &dev_attr_max_active.attr,
5065 NULL,
5066};
5067ATTRIBUTE_GROUPS(wq_sysfs);
5068
5069static ssize_t wq_pool_ids_show(struct device *dev,
5070 struct device_attribute *attr, char *buf)
5071{
5072 struct workqueue_struct *wq = dev_to_wq(dev);
5073 const char *delim = "";
5074 int node, written = 0;
5075
5076 rcu_read_lock_sched();
5077 for_each_node(node) {
5078 written += scnprintf(buf + written, PAGE_SIZE - written,
5079 "%s%d:%d", delim, node,
5080 unbound_pwq_by_node(wq, node)->pool->id);
5081 delim = " ";
5082 }
5083 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5084 rcu_read_unlock_sched();
5085
5086 return written;
5087}
5088
5089static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5090 char *buf)
5091{
5092 struct workqueue_struct *wq = dev_to_wq(dev);
5093 int written;
5094
5095 mutex_lock(&wq->mutex);
5096 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5097 mutex_unlock(&wq->mutex);
5098
5099 return written;
5100}
5101
5102/* prepare workqueue_attrs for sysfs store operations */
5103static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5104{
5105 struct workqueue_attrs *attrs;
5106
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005107 lockdep_assert_held(&wq_pool_mutex);
5108
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005109 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5110 if (!attrs)
5111 return NULL;
5112
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005113 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005114 return attrs;
5115}
5116
5117static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5118 const char *buf, size_t count)
5119{
5120 struct workqueue_struct *wq = dev_to_wq(dev);
5121 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005122 int ret = -ENOMEM;
5123
5124 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005125
5126 attrs = wq_sysfs_prep_attrs(wq);
5127 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005128 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005129
5130 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5131 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005132 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005133 else
5134 ret = -EINVAL;
5135
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005136out_unlock:
5137 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005138 free_workqueue_attrs(attrs);
5139 return ret ?: count;
5140}
5141
5142static ssize_t wq_cpumask_show(struct device *dev,
5143 struct device_attribute *attr, char *buf)
5144{
5145 struct workqueue_struct *wq = dev_to_wq(dev);
5146 int written;
5147
5148 mutex_lock(&wq->mutex);
5149 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5150 cpumask_pr_args(wq->unbound_attrs->cpumask));
5151 mutex_unlock(&wq->mutex);
5152 return written;
5153}
5154
5155static ssize_t wq_cpumask_store(struct device *dev,
5156 struct device_attribute *attr,
5157 const char *buf, size_t count)
5158{
5159 struct workqueue_struct *wq = dev_to_wq(dev);
5160 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005161 int ret = -ENOMEM;
5162
5163 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005164
5165 attrs = wq_sysfs_prep_attrs(wq);
5166 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005167 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005168
5169 ret = cpumask_parse(buf, attrs->cpumask);
5170 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005171 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005172
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005173out_unlock:
5174 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005175 free_workqueue_attrs(attrs);
5176 return ret ?: count;
5177}
5178
5179static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5180 char *buf)
5181{
5182 struct workqueue_struct *wq = dev_to_wq(dev);
5183 int written;
5184
5185 mutex_lock(&wq->mutex);
5186 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5187 !wq->unbound_attrs->no_numa);
5188 mutex_unlock(&wq->mutex);
5189
5190 return written;
5191}
5192
5193static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5194 const char *buf, size_t count)
5195{
5196 struct workqueue_struct *wq = dev_to_wq(dev);
5197 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005198 int v, ret = -ENOMEM;
5199
5200 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005201
5202 attrs = wq_sysfs_prep_attrs(wq);
5203 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005204 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005205
5206 ret = -EINVAL;
5207 if (sscanf(buf, "%d", &v) == 1) {
5208 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005209 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005210 }
5211
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005212out_unlock:
5213 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005214 free_workqueue_attrs(attrs);
5215 return ret ?: count;
5216}
5217
5218static struct device_attribute wq_sysfs_unbound_attrs[] = {
5219 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5220 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5221 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5222 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5223 __ATTR_NULL,
5224};
5225
5226static struct bus_type wq_subsys = {
5227 .name = "workqueue",
5228 .dev_groups = wq_sysfs_groups,
5229};
5230
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005231static ssize_t wq_unbound_cpumask_show(struct device *dev,
5232 struct device_attribute *attr, char *buf)
5233{
5234 int written;
5235
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005236 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005237 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5238 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005239 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005240
5241 return written;
5242}
5243
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005244static ssize_t wq_unbound_cpumask_store(struct device *dev,
5245 struct device_attribute *attr, const char *buf, size_t count)
5246{
5247 cpumask_var_t cpumask;
5248 int ret;
5249
5250 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5251 return -ENOMEM;
5252
5253 ret = cpumask_parse(buf, cpumask);
5254 if (!ret)
5255 ret = workqueue_set_unbound_cpumask(cpumask);
5256
5257 free_cpumask_var(cpumask);
5258 return ret ? ret : count;
5259}
5260
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005261static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005262 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5263 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005264
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005265static int __init wq_sysfs_init(void)
5266{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005267 int err;
5268
5269 err = subsys_virtual_register(&wq_subsys, NULL);
5270 if (err)
5271 return err;
5272
5273 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005274}
5275core_initcall(wq_sysfs_init);
5276
5277static void wq_device_release(struct device *dev)
5278{
5279 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5280
5281 kfree(wq_dev);
5282}
5283
5284/**
5285 * workqueue_sysfs_register - make a workqueue visible in sysfs
5286 * @wq: the workqueue to register
5287 *
5288 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5289 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5290 * which is the preferred method.
5291 *
5292 * Workqueue user should use this function directly iff it wants to apply
5293 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5294 * apply_workqueue_attrs() may race against userland updating the
5295 * attributes.
5296 *
5297 * Return: 0 on success, -errno on failure.
5298 */
5299int workqueue_sysfs_register(struct workqueue_struct *wq)
5300{
5301 struct wq_device *wq_dev;
5302 int ret;
5303
5304 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305305 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005306 * attributes breaks ordering guarantee. Disallow exposing ordered
5307 * workqueues.
5308 */
Tejun Heof9636c92017-07-23 08:36:15 -04005309 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005310 return -EINVAL;
5311
5312 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5313 if (!wq_dev)
5314 return -ENOMEM;
5315
5316 wq_dev->wq = wq;
5317 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005318 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005319 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005320
5321 /*
5322 * unbound_attrs are created separately. Suppress uevent until
5323 * everything is ready.
5324 */
5325 dev_set_uevent_suppress(&wq_dev->dev, true);
5326
5327 ret = device_register(&wq_dev->dev);
5328 if (ret) {
Arvind Yadav30393942018-03-06 15:35:43 +05305329 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005330 wq->wq_dev = NULL;
5331 return ret;
5332 }
5333
5334 if (wq->flags & WQ_UNBOUND) {
5335 struct device_attribute *attr;
5336
5337 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5338 ret = device_create_file(&wq_dev->dev, attr);
5339 if (ret) {
5340 device_unregister(&wq_dev->dev);
5341 wq->wq_dev = NULL;
5342 return ret;
5343 }
5344 }
5345 }
5346
5347 dev_set_uevent_suppress(&wq_dev->dev, false);
5348 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5349 return 0;
5350}
5351
5352/**
5353 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5354 * @wq: the workqueue to unregister
5355 *
5356 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5357 */
5358static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5359{
5360 struct wq_device *wq_dev = wq->wq_dev;
5361
5362 if (!wq->wq_dev)
5363 return;
5364
5365 wq->wq_dev = NULL;
5366 device_unregister(&wq_dev->dev);
5367}
5368#else /* CONFIG_SYSFS */
5369static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5370#endif /* CONFIG_SYSFS */
5371
Tejun Heo82607adc2015-12-08 11:28:04 -05005372/*
5373 * Workqueue watchdog.
5374 *
5375 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5376 * flush dependency, a concurrency managed work item which stays RUNNING
5377 * indefinitely. Workqueue stalls can be very difficult to debug as the
5378 * usual warning mechanisms don't trigger and internal workqueue state is
5379 * largely opaque.
5380 *
5381 * Workqueue watchdog monitors all worker pools periodically and dumps
5382 * state if some pools failed to make forward progress for a while where
5383 * forward progress is defined as the first item on ->worklist changing.
5384 *
5385 * This mechanism is controlled through the kernel parameter
5386 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5387 * corresponding sysfs parameter file.
5388 */
5389#ifdef CONFIG_WQ_WATCHDOG
5390
5391static void wq_watchdog_timer_fn(unsigned long data);
5392
5393static unsigned long wq_watchdog_thresh = 30;
5394static struct timer_list wq_watchdog_timer =
5395 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5396
5397static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5398static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5399
5400static void wq_watchdog_reset_touched(void)
5401{
5402 int cpu;
5403
5404 wq_watchdog_touched = jiffies;
5405 for_each_possible_cpu(cpu)
5406 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5407}
5408
5409static void wq_watchdog_timer_fn(unsigned long data)
5410{
5411 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5412 bool lockup_detected = false;
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005413 unsigned long now = jiffies;
Tejun Heo82607adc2015-12-08 11:28:04 -05005414 struct worker_pool *pool;
5415 int pi;
5416
5417 if (!thresh)
5418 return;
5419
5420 rcu_read_lock();
5421
5422 for_each_pool(pool, pi) {
5423 unsigned long pool_ts, touched, ts;
5424
5425 if (list_empty(&pool->worklist))
5426 continue;
5427
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005428 /*
5429 * If a virtual machine is stopped by the host it can look to
5430 * the watchdog like a stall.
5431 */
5432 kvm_check_and_clear_guest_paused();
5433
Tejun Heo82607adc2015-12-08 11:28:04 -05005434 /* get the latest of pool and touched timestamps */
5435 pool_ts = READ_ONCE(pool->watchdog_ts);
5436 touched = READ_ONCE(wq_watchdog_touched);
5437
5438 if (time_after(pool_ts, touched))
5439 ts = pool_ts;
5440 else
5441 ts = touched;
5442
5443 if (pool->cpu >= 0) {
5444 unsigned long cpu_touched =
5445 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5446 pool->cpu));
5447 if (time_after(cpu_touched, ts))
5448 ts = cpu_touched;
5449 }
5450
5451 /* did we stall? */
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005452 if (time_after(now, ts + thresh)) {
Tejun Heo82607adc2015-12-08 11:28:04 -05005453 lockup_detected = true;
5454 pr_emerg("BUG: workqueue lockup - pool");
5455 pr_cont_pool_info(pool);
5456 pr_cont(" stuck for %us!\n",
Sergey Senozhatskya8f2c7b2021-05-20 19:14:22 +09005457 jiffies_to_msecs(now - pool_ts) / 1000);
Tejun Heo82607adc2015-12-08 11:28:04 -05005458 }
5459 }
5460
5461 rcu_read_unlock();
5462
5463 if (lockup_detected)
5464 show_workqueue_state();
5465
5466 wq_watchdog_reset_touched();
5467 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5468}
5469
5470void wq_watchdog_touch(int cpu)
5471{
5472 if (cpu >= 0)
5473 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5474 else
5475 wq_watchdog_touched = jiffies;
5476}
5477
5478static void wq_watchdog_set_thresh(unsigned long thresh)
5479{
5480 wq_watchdog_thresh = 0;
5481 del_timer_sync(&wq_watchdog_timer);
5482
5483 if (thresh) {
5484 wq_watchdog_thresh = thresh;
5485 wq_watchdog_reset_touched();
5486 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5487 }
5488}
5489
5490static int wq_watchdog_param_set_thresh(const char *val,
5491 const struct kernel_param *kp)
5492{
5493 unsigned long thresh;
5494 int ret;
5495
5496 ret = kstrtoul(val, 0, &thresh);
5497 if (ret)
5498 return ret;
5499
5500 if (system_wq)
5501 wq_watchdog_set_thresh(thresh);
5502 else
5503 wq_watchdog_thresh = thresh;
5504
5505 return 0;
5506}
5507
5508static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5509 .set = wq_watchdog_param_set_thresh,
5510 .get = param_get_ulong,
5511};
5512
5513module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5514 0644);
5515
5516static void wq_watchdog_init(void)
5517{
5518 wq_watchdog_set_thresh(wq_watchdog_thresh);
5519}
5520
5521#else /* CONFIG_WQ_WATCHDOG */
5522
5523static inline void wq_watchdog_init(void) { }
5524
5525#endif /* CONFIG_WQ_WATCHDOG */
5526
Tejun Heobce90382013-04-01 11:23:32 -07005527static void __init wq_numa_init(void)
5528{
5529 cpumask_var_t *tbl;
5530 int node, cpu;
5531
Tejun Heobce90382013-04-01 11:23:32 -07005532 if (num_possible_nodes() <= 1)
5533 return;
5534
Tejun Heod55262c2013-04-01 11:23:38 -07005535 if (wq_disable_numa) {
5536 pr_info("workqueue: NUMA affinity support disabled\n");
5537 return;
5538 }
5539
Tejun Heo4c16bd32013-04-01 11:23:36 -07005540 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5541 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5542
Tejun Heobce90382013-04-01 11:23:32 -07005543 /*
5544 * We want masks of possible CPUs of each node which isn't readily
5545 * available. Build one from cpu_to_node() which should have been
5546 * fully initialized by now.
5547 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005548 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005549 BUG_ON(!tbl);
5550
5551 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005552 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005553 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005554
5555 for_each_possible_cpu(cpu) {
5556 node = cpu_to_node(cpu);
5557 if (WARN_ON(node == NUMA_NO_NODE)) {
5558 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5559 /* happens iff arch is bonkers, let's just proceed */
5560 return;
5561 }
5562 cpumask_set_cpu(cpu, tbl[node]);
5563 }
5564
5565 wq_numa_possible_cpumask = tbl;
5566 wq_numa_enabled = true;
5567}
5568
Tejun Heoac4bbc02016-09-16 15:49:32 -04005569/**
5570 * workqueue_init_early - early init for workqueue subsystem
5571 *
5572 * This is the first half of two-staged workqueue subsystem initialization
5573 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5574 * idr are up. It sets up all the data structures and system workqueues
5575 * and allows early boot code to create workqueues and queue/cancel work
5576 * items. Actual work item execution starts only after kthreads can be
5577 * created and scheduled right before early initcalls.
5578 */
5579int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005580{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005581 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5582 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005583
Tejun Heoe904e6c2013-03-12 11:29:57 -07005584 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5585
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005586 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5587 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5588
Tejun Heoe904e6c2013-03-12 11:29:57 -07005589 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5590
Tejun Heobce90382013-04-01 11:23:32 -07005591 wq_numa_init();
5592
Tejun Heo706026c2013-01-24 11:01:34 -08005593 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005594 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005595 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005596
Tejun Heo7a4e3442013-03-12 11:30:00 -07005597 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005598 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005599 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005600 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005601 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005602 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005603 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005604
Tejun Heo9daf9e62013-01-24 11:01:33 -08005605 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005606 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005607 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005608 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005609 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005610 }
5611
Tejun Heo8a2b7532013-09-05 12:30:04 -04005612 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005613 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5614 struct workqueue_attrs *attrs;
5615
5616 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005617 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005618 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005619
5620 /*
5621 * An ordered wq should have only one pwq as ordering is
5622 * guaranteed by max_active which is enforced by pwqs.
5623 * Turn off NUMA so that dfl_pwq is used for all nodes.
5624 */
5625 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5626 attrs->nice = std_nice[i];
5627 attrs->no_numa = true;
5628 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005629 }
5630
Tejun Heod320c032010-06-29 10:07:14 +02005631 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005632 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005633 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005634 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5635 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005636 system_freezable_wq = alloc_workqueue("events_freezable",
5637 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305638 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5639 WQ_POWER_EFFICIENT, 0);
5640 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5641 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5642 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005643 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305644 !system_unbound_wq || !system_freezable_wq ||
5645 !system_power_efficient_wq ||
5646 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005647
Tejun Heoac4bbc02016-09-16 15:49:32 -04005648 return 0;
5649}
5650
5651/**
5652 * workqueue_init - bring workqueue subsystem fully online
5653 *
5654 * This is the latter half of two-staged workqueue subsystem initialization
5655 * and invoked as soon as kthreads can be created and scheduled.
5656 * Workqueues have been created and work items queued on them, but there
5657 * are no kworkers executing the work items yet. Populate the worker pools
5658 * with the initial workers and enable future kworker creations.
5659 */
5660int __init workqueue_init(void)
5661{
5662 struct worker_pool *pool;
5663 int cpu, bkt;
5664
5665 /* create the initial workers */
5666 for_each_online_cpu(cpu) {
5667 for_each_cpu_worker_pool(pool, cpu) {
5668 pool->flags &= ~POOL_DISASSOCIATED;
5669 BUG_ON(!create_worker(pool));
5670 }
5671 }
5672
5673 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5674 BUG_ON(!create_worker(pool));
5675
5676 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005677 wq_watchdog_init();
5678
Suresh Siddha6ee05782010-07-30 14:57:37 -07005679 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005680}