blob: 4e6fa755ebdc2f34828a7ec862257f6567605069 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
Benjamin Peterson9a261492017-08-06 19:33:22 -070024 * Please read Documentation/core-api/workqueue.rst for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070044#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050045#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070046#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070047#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070048#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070049#include <linux/uaccess.h>
Tal Shorerc98a9802017-11-03 17:27:50 +020050#include <linux/sched/isolation.h>
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +090051#include <linux/nmi.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020052
Tejun Heoea138442013-01-18 14:05:55 -080053#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070056 /*
Tejun Heo24647572013-01-24 11:01:33 -080057 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070058 *
Tejun Heo24647572013-01-24 11:01:33 -080059 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 * While associated (!DISASSOCIATED), all workers are bound to the
61 * CPU and none has %WORKER_UNBOUND set and concurrency management
62 * is in effect.
63 *
64 * While DISASSOCIATED, the cpu may be offline and all workers have
65 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080066 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070067 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070068 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080069 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080070 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070071 */
Tejun Heo692b4822017-10-09 08:04:13 -070072 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
Tejun Heo24647572013-01-24 11:01:33 -080073 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020074
Tejun Heoc8e55f32010-06-29 10:07:12 +020075 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020076 WORKER_DIE = 1 << 1, /* die die die */
77 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020078 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020079 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020080 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020082
Tejun Heoa9ab7752013-03-19 13:45:21 -070083 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
84 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020085
Tejun Heoe34cdddb2013-01-24 11:01:33 -080086 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070087
Tejun Heo29c91e92013-03-12 11:30:03 -070088 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020089 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020090
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
92 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
93
Tejun Heo3233cdb2011-02-16 18:10:19 +010094 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
95 /* call for help after 10ms
96 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020097 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
98 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020099
100 /*
101 * Rescue workers are used only on emergencies and shared by
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200103 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800104 RESCUER_NICE_LEVEL = MIN_NICE,
105 HIGHPRI_NICE_LEVEL = MIN_NICE,
Tejun Heoecf68812013-04-01 11:23:34 -0700106
107 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200108};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200111 * Structure fields follow one of the following exclusion rules.
112 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200113 * I: Modifiable by initialization/destruction paths and read-only for
114 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * P: Preemption protected. Disabling preemption is enough and should
117 * only be modified and accessed from the local cpu.
118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200120 *
Tejun Heod565ed62013-01-24 11:01:33 -0800121 * X: During normal operation, modification requires pool->lock and should
122 * be done only from local cpu. Either disabling preemption on local
123 * cpu or grabbing pool->lock is enough for read access. If
124 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200125 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800126 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700129 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700130 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700131 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800132 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
133 *
134 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
135 * sched-RCU for reads.
136 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700137 * WQ: wq->mutex protected.
138 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700139 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700140 *
141 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200142 */
143
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800144/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200145
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800147 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700148 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700149 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800150 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700151 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700152
Tejun Heo82607adc2015-12-08 11:28:04 -0500153 unsigned long watchdog_ts; /* L: watchdog timestamp */
154
Tejun Heobd7bdd42012-07-12 14:46:37 -0700155 struct list_head worklist; /* L: list of pending works */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700156
Lai Jiangshan5826cc82018-03-20 17:24:05 +0800157 int nr_workers; /* L: total number of workers */
158 int nr_idle; /* L: currently idle workers */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159
160 struct list_head idle_list; /* X: list of idle workers */
161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for workers */
163
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700164 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800165 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
166 /* L: hash of busy workers */
167
Tejun Heo2607d7a2015-03-09 09:22:28 -0400168 struct worker *manager; /* L: purely informational */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800169 struct mutex attach_mutex; /* attach/detach exclusion */
170 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800171 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800172
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800173 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800174
Tejun Heo7a4e3442013-03-12 11:30:00 -0700175 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700176 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
177 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700178
Tejun Heoe19e3972013-01-24 11:39:44 -0800179 /*
180 * The current concurrency level. As it's likely to be accessed
181 * from other CPUs during try_to_wake_up(), put it in a separate
182 * cacheline.
183 */
184 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700185
186 /*
187 * Destruction of pool is sched-RCU protected to allow dereferences
188 * from get_work_pool().
189 */
190 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200191} ____cacheline_aligned_in_smp;
192
193/*
Tejun Heo112202d2013-02-13 19:29:12 -0800194 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
195 * of work_struct->data are used for flags and the remaining high bits
196 * point to the pwq; thus, pwqs need to be aligned at two's power of the
197 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 */
Tejun Heo112202d2013-02-13 19:29:12 -0800199struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700200 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200201 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200202 int work_color; /* L: current color */
203 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700204 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200205 int nr_in_flight[WORK_NR_COLORS];
206 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200207 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200208 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200209 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700210 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700211 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700212
213 /*
214 * Release of unbound pwq is punted to system_wq. See put_pwq()
215 * and pwq_unbound_release_workfn() for details. pool_workqueue
216 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700217 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700218 */
219 struct work_struct unbound_release_work;
220 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700221} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200224 * Structure used to wait for workqueue flush.
225 */
226struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700227 struct list_head list; /* WQ: list of flushers */
228 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200229 struct completion done; /* flush completion */
230};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Tejun Heo226223a2013-03-12 11:30:05 -0700232struct wq_device;
233
Tejun Heo73f53c42010-06-29 10:07:11 +0200234/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700235 * The externally visible workqueue. It relays the issued work items to
236 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
238struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700239 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400240 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200241
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700242 struct mutex mutex; /* protects this wq */
243 int work_color; /* WQ: current work color */
244 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800245 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700246 struct wq_flusher *first_flusher; /* WQ: first flusher */
247 struct list_head flusher_queue; /* WQ: flush waiters */
248 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200249
Tejun Heo2e109a22013-03-13 19:47:40 -0700250 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200251 struct worker *rescuer; /* I: rescue worker */
252
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700253 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700254 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700255
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800256 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
257 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700258
Tejun Heo226223a2013-03-12 11:30:05 -0700259#ifdef CONFIG_SYSFS
260 struct wq_device *wq_dev; /* I: for sysfs interface */
261#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700262#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200263 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700264#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700265 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700266
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400267 /*
268 * Destruction of workqueue_struct is sched-RCU protected to allow
269 * walking the workqueues list without grabbing wq_pool_mutex.
270 * This is used to dump all workqueues from sysrq.
271 */
272 struct rcu_head rcu;
273
Tejun Heo2728fd22013-04-01 11:23:35 -0700274 /* hot fields used during command issue, aligned to cacheline */
275 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
276 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800277 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278};
279
Tejun Heoe904e6c2013-03-12 11:29:57 -0700280static struct kmem_cache *pwq_cache;
281
Tejun Heobce90382013-04-01 11:23:32 -0700282static cpumask_var_t *wq_numa_possible_cpumask;
283 /* possible CPUs of each node */
284
Tejun Heod55262c2013-04-01 11:23:38 -0700285static bool wq_disable_numa;
286module_param_named(disable_numa, wq_disable_numa, bool, 0444);
287
Viresh Kumarcee22a12013-04-08 16:45:40 +0530288/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930289static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530290module_param_named(power_efficient, wq_power_efficient, bool, 0444);
291
Tejun Heo863b7102016-09-16 15:49:34 -0400292static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400293
Tejun Heobce90382013-04-01 11:23:32 -0700294static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
295
Tejun Heo4c16bd32013-04-01 11:23:36 -0700296/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
297static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
298
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700299static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700300static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo692b4822017-10-09 08:04:13 -0700301static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
Tejun Heo5bcab332013-03-13 19:47:40 -0700302
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400303static LIST_HEAD(workqueues); /* PR: list of all workqueues */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700304static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700305
Mike Galbraithef5571802016-02-09 17:59:38 -0500306/* PL: allowable cpus for unbound wqs and work items */
307static cpumask_var_t wq_unbound_cpumask;
308
309/* CPU where unbound work was last round robin scheduled from this CPU */
310static DEFINE_PER_CPU(int, wq_rr_cpu_last);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +0800311
Tejun Heof303fccb2016-02-09 17:59:38 -0500312/*
313 * Local execution of unbound work items is no longer guaranteed. The
314 * following always forces round-robin CPU selection on unbound work items
315 * to uncover usages which depend on it.
316 */
317#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
318static bool wq_debug_force_rr_cpu = true;
319#else
320static bool wq_debug_force_rr_cpu = false;
321#endif
322module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
323
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700324/* the per-cpu worker pools */
Peter Zijlstra25528212016-03-15 14:52:49 -0700325static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700326
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700327static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700328
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700329/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700330static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
331
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700332/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700333static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
334
Tejun Heo8a2b7532013-09-05 12:30:04 -0400335/* I: attributes used when instantiating ordered pools on demand */
336static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
337
Tejun Heod320c032010-06-29 10:07:14 +0200338struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400339EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300340struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900341EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300342struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200343EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300344struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200345EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300346struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100347EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530348struct workqueue_struct *system_power_efficient_wq __read_mostly;
349EXPORT_SYMBOL_GPL(system_power_efficient_wq);
350struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
351EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200352
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700353static int worker_thread(void *__worker);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +0800354static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700355
Tejun Heo97bd2342010-10-05 10:41:14 +0200356#define CREATE_TRACE_POINTS
357#include <trace/events/workqueue.h>
358
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700359#define assert_rcu_or_pool_mutex() \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700360 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
361 !lockdep_is_held(&wq_pool_mutex), \
362 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700363
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700364#define assert_rcu_or_wq_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700365 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
366 !lockdep_is_held(&wq->mutex), \
367 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700368
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800369#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
Paul E. McKenneyf78f5b92015-06-18 15:50:02 -0700370 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
371 !lockdep_is_held(&wq->mutex) && \
372 !lockdep_is_held(&wq_pool_mutex), \
373 "sched RCU, wq->mutex or wq_pool_mutex should be held")
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800374
Tejun Heof02ae732013-03-12 11:30:03 -0700375#define for_each_cpu_worker_pool(pool, cpu) \
376 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
377 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700378 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700379
Tejun Heo49e3cf42013-03-12 11:29:58 -0700380/**
Tejun Heo17116962013-03-12 11:29:58 -0700381 * for_each_pool - iterate through all worker_pools in the system
382 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700383 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700384 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700385 * This must be called either with wq_pool_mutex held or sched RCU read
386 * locked. If the pool needs to be used beyond the locking in effect, the
387 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700388 *
389 * The if/else clause exists only for the lockdep assertion and can be
390 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700391 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700392#define for_each_pool(pool, pi) \
393 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700394 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700395 else
Tejun Heo17116962013-03-12 11:29:58 -0700396
397/**
Tejun Heo822d8402013-03-19 13:45:21 -0700398 * for_each_pool_worker - iterate through all workers of a worker_pool
399 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700400 * @pool: worker_pool to iterate workers of
401 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800402 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700403 *
404 * The if/else clause exists only for the lockdep assertion and can be
405 * ignored.
406 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800407#define for_each_pool_worker(worker, pool) \
408 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800409 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700410 else
411
412/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700413 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
414 * @pwq: iteration cursor
415 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700416 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700417 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700418 * If the pwq needs to be used beyond the locking in effect, the caller is
419 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700420 *
421 * The if/else clause exists only for the lockdep assertion and can be
422 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700423 */
424#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700425 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700426 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700427 else
Tejun Heof3421792010-07-02 10:03:51 +0200428
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900429#ifdef CONFIG_DEBUG_OBJECTS_WORK
430
431static struct debug_obj_descr work_debug_descr;
432
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100433static void *work_debug_hint(void *addr)
434{
435 return ((struct work_struct *) addr)->func;
436}
437
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700438static bool work_is_static_object(void *addr)
439{
440 struct work_struct *work = addr;
441
442 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
443}
444
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900445/*
446 * fixup_init is called when:
447 * - an active object is initialized
448 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700449static bool work_fixup_init(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900450{
451 struct work_struct *work = addr;
452
453 switch (state) {
454 case ODEBUG_STATE_ACTIVE:
455 cancel_work_sync(work);
456 debug_object_init(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700457 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900458 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700459 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900460 }
461}
462
463/*
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900464 * fixup_free is called when:
465 * - an active object is freed
466 */
Du, Changbin02a982a2016-05-19 17:09:26 -0700467static bool work_fixup_free(void *addr, enum debug_obj_state state)
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900468{
469 struct work_struct *work = addr;
470
471 switch (state) {
472 case ODEBUG_STATE_ACTIVE:
473 cancel_work_sync(work);
474 debug_object_free(work, &work_debug_descr);
Du, Changbin02a982a2016-05-19 17:09:26 -0700475 return true;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900476 default:
Du, Changbin02a982a2016-05-19 17:09:26 -0700477 return false;
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900478 }
479}
480
481static struct debug_obj_descr work_debug_descr = {
482 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100483 .debug_hint = work_debug_hint,
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700484 .is_static_object = work_is_static_object,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900485 .fixup_init = work_fixup_init,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900486 .fixup_free = work_fixup_free,
487};
488
489static inline void debug_work_activate(struct work_struct *work)
490{
491 debug_object_activate(work, &work_debug_descr);
492}
493
494static inline void debug_work_deactivate(struct work_struct *work)
495{
496 debug_object_deactivate(work, &work_debug_descr);
497}
498
499void __init_work(struct work_struct *work, int onstack)
500{
501 if (onstack)
502 debug_object_init_on_stack(work, &work_debug_descr);
503 else
504 debug_object_init(work, &work_debug_descr);
505}
506EXPORT_SYMBOL_GPL(__init_work);
507
508void destroy_work_on_stack(struct work_struct *work)
509{
510 debug_object_free(work, &work_debug_descr);
511}
512EXPORT_SYMBOL_GPL(destroy_work_on_stack);
513
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000514void destroy_delayed_work_on_stack(struct delayed_work *work)
515{
516 destroy_timer_on_stack(&work->timer);
517 debug_object_free(&work->work, &work_debug_descr);
518}
519EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
520
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900521#else
522static inline void debug_work_activate(struct work_struct *work) { }
523static inline void debug_work_deactivate(struct work_struct *work) { }
524#endif
525
Li Bin4e8b22b2013-09-10 09:52:35 +0800526/**
527 * worker_pool_assign_id - allocate ID and assing it to @pool
528 * @pool: the pool pointer of interest
529 *
530 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
531 * successfully, -errno on failure.
532 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800533static int worker_pool_assign_id(struct worker_pool *pool)
534{
535 int ret;
536
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700537 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700538
Li Bin4e8b22b2013-09-10 09:52:35 +0800539 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
540 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700541 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700542 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700543 return 0;
544 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800545 return ret;
546}
547
Tejun Heo76af4d92013-03-12 11:30:00 -0700548/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700549 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
550 * @wq: the target workqueue
551 * @node: the node ID
552 *
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800553 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
554 * read locked.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700555 * If the pwq needs to be used beyond the locking in effect, the caller is
556 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700557 *
558 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700559 */
560static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
561 int node)
562{
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800563 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
Tejun Heod6e022f2016-02-03 13:54:25 -0500564
565 /*
566 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
567 * delayed item is pending. The plan is to keep CPU -> NODE
568 * mapping valid and stable across CPU on/offlines. Once that
569 * happens, this workaround can be removed.
570 */
571 if (unlikely(node == NUMA_NO_NODE))
572 return wq->dfl_pwq;
573
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700574 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
575}
576
Tejun Heo73f53c42010-06-29 10:07:11 +0200577static unsigned int work_color_to_flags(int color)
578{
579 return color << WORK_STRUCT_COLOR_SHIFT;
580}
581
582static int get_work_color(struct work_struct *work)
583{
584 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
585 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
586}
587
588static int work_next_color(int color)
589{
590 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700591}
592
David Howells4594bf12006-12-07 11:33:26 +0000593/*
Tejun Heo112202d2013-02-13 19:29:12 -0800594 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
595 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800596 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200597 *
Tejun Heo112202d2013-02-13 19:29:12 -0800598 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
599 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700600 * work->data. These functions should only be called while the work is
601 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 *
Tejun Heo112202d2013-02-13 19:29:12 -0800603 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800604 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800605 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700607 *
608 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
609 * canceled. While being canceled, a work item may have its PENDING set
610 * but stay off timer and worklist for arbitrarily long and nobody should
611 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000612 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200613static inline void set_work_data(struct work_struct *work, unsigned long data,
614 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000615{
Tejun Heo6183c002013-03-12 11:29:57 -0700616 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000618}
David Howells365970a2006-11-22 14:54:49 +0000619
Tejun Heo112202d2013-02-13 19:29:12 -0800620static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200621 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200622{
Tejun Heo112202d2013-02-13 19:29:12 -0800623 set_work_data(work, (unsigned long)pwq,
624 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200625}
626
Lai Jiangshan4468a002013-02-06 18:04:53 -0800627static void set_work_pool_and_keep_pending(struct work_struct *work,
628 int pool_id)
629{
630 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
631 WORK_STRUCT_PENDING);
632}
633
Tejun Heo7c3eed52013-01-24 11:01:33 -0800634static void set_work_pool_and_clear_pending(struct work_struct *work,
635 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000636{
Tejun Heo23657bb2012-08-13 17:08:19 -0700637 /*
638 * The following wmb is paired with the implied mb in
639 * test_and_set_bit(PENDING) and ensures all updates to @work made
640 * here are visible to and precede any updates by the next PENDING
641 * owner.
642 */
643 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800644 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Roman Pen346c09f2016-04-26 13:15:35 +0200645 /*
646 * The following mb guarantees that previous clear of a PENDING bit
647 * will not be reordered with any speculative LOADS or STORES from
648 * work->current_func, which is executed afterwards. This possible
649 * reordering can lead to a missed execution on attempt to qeueue
650 * the same @work. E.g. consider this case:
651 *
652 * CPU#0 CPU#1
653 * ---------------------------- --------------------------------
654 *
655 * 1 STORE event_indicated
656 * 2 queue_work_on() {
657 * 3 test_and_set_bit(PENDING)
658 * 4 } set_..._and_clear_pending() {
659 * 5 set_work_data() # clear bit
660 * 6 smp_mb()
661 * 7 work->current_func() {
662 * 8 LOAD event_indicated
663 * }
664 *
665 * Without an explicit full barrier speculative LOAD on line 8 can
666 * be executed before CPU#0 does STORE on line 1. If that happens,
667 * CPU#0 observes the PENDING bit is still set and new execution of
668 * a @work is not queued in a hope, that CPU#1 will eventually
669 * finish the queued @work. Meanwhile CPU#1 does not see
670 * event_indicated is set, because speculative LOAD was executed
671 * before actual STORE.
672 */
673 smp_mb();
Tejun Heo7a22ad72010-06-29 10:07:13 +0200674}
675
676static void clear_work_data(struct work_struct *work)
677{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800678 smp_wmb(); /* see set_work_pool_and_clear_pending() */
679 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200680}
681
Tejun Heo112202d2013-02-13 19:29:12 -0800682static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200683{
Tejun Heoe1201532010-07-22 14:14:25 +0200684 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200685
Tejun Heo112202d2013-02-13 19:29:12 -0800686 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200687 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
688 else
689 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200690}
691
Tejun Heo7c3eed52013-01-24 11:01:33 -0800692/**
693 * get_work_pool - return the worker_pool a given work was associated with
694 * @work: the work item of interest
695 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700696 * Pools are created and destroyed under wq_pool_mutex, and allows read
697 * access under sched-RCU read lock. As such, this function should be
698 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700699 *
700 * All fields of the returned pool are accessible as long as the above
701 * mentioned locking is in effect. If the returned pool needs to be used
702 * beyond the critical section, the caller is responsible for ensuring the
703 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700704 *
705 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800706 */
707static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200708{
Tejun Heoe1201532010-07-22 14:14:25 +0200709 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800710 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200711
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700712 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700713
Tejun Heo112202d2013-02-13 19:29:12 -0800714 if (data & WORK_STRUCT_PWQ)
715 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800716 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200717
Tejun Heo7c3eed52013-01-24 11:01:33 -0800718 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
719 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200720 return NULL;
721
Tejun Heofa1b54e2013-03-12 11:30:00 -0700722 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800723}
724
725/**
726 * get_work_pool_id - return the worker pool ID a given work is associated with
727 * @work: the work item of interest
728 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700729 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800730 * %WORK_OFFQ_POOL_NONE if none.
731 */
732static int get_work_pool_id(struct work_struct *work)
733{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800734 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800735
Tejun Heo112202d2013-02-13 19:29:12 -0800736 if (data & WORK_STRUCT_PWQ)
737 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800738 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
739
740 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800741}
742
Tejun Heobbb68df2012-08-03 10:30:46 -0700743static void mark_work_canceling(struct work_struct *work)
744{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800745 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700746
Tejun Heo7c3eed52013-01-24 11:01:33 -0800747 pool_id <<= WORK_OFFQ_POOL_SHIFT;
748 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700749}
750
751static bool work_is_canceling(struct work_struct *work)
752{
753 unsigned long data = atomic_long_read(&work->data);
754
Tejun Heo112202d2013-02-13 19:29:12 -0800755 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700756}
757
David Howells365970a2006-11-22 14:54:49 +0000758/*
Tejun Heo32704762012-07-13 22:16:45 -0700759 * Policy functions. These define the policies on how the global worker
760 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800761 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000762 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200763
Tejun Heo63d95a92012-07-12 14:46:37 -0700764static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000765{
Tejun Heoe19e3972013-01-24 11:39:44 -0800766 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000767}
768
Tejun Heoe22bee72010-06-29 10:07:14 +0200769/*
770 * Need to wake up a worker? Called from anything but currently
771 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700772 *
773 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800774 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700775 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200776 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700777static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000778{
Tejun Heo63d95a92012-07-12 14:46:37 -0700779 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000780}
781
Tejun Heoe22bee72010-06-29 10:07:14 +0200782/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700783static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200784{
Tejun Heo63d95a92012-07-12 14:46:37 -0700785 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200786}
787
788/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700789static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200790{
Tejun Heoe19e3972013-01-24 11:39:44 -0800791 return !list_empty(&pool->worklist) &&
792 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200793}
794
795/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700796static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200797{
Tejun Heo63d95a92012-07-12 14:46:37 -0700798 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200799}
800
Tejun Heoe22bee72010-06-29 10:07:14 +0200801/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700802static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200803{
Tejun Heo692b4822017-10-09 08:04:13 -0700804 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
Tejun Heo63d95a92012-07-12 14:46:37 -0700805 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
806 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807
808 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
809}
810
811/*
812 * Wake up functions.
813 */
814
Lai Jiangshan1037de32014-05-22 16:44:07 +0800815/* Return the first idle worker. Safe with preemption disabled */
816static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200817{
Tejun Heo63d95a92012-07-12 14:46:37 -0700818 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200819 return NULL;
820
Tejun Heo63d95a92012-07-12 14:46:37 -0700821 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200822}
823
824/**
825 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700826 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200827 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700828 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200829 *
830 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800831 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200832 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700833static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200834{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800835 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200836
837 if (likely(worker))
838 wake_up_process(worker->task);
839}
840
Tejun Heo4690c4a2010-06-29 10:07:10 +0200841/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 * wq_worker_waking_up - a worker is waking up
843 * @task: task waking up
844 * @cpu: CPU @task is waking up to
845 *
846 * This function is called during try_to_wake_up() when a worker is
847 * being awoken.
848 *
849 * CONTEXT:
850 * spin_lock_irq(rq->lock)
851 */
Tejun Heod84ff052013-03-12 11:29:59 -0700852void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200853{
854 struct worker *worker = kthread_data(task);
855
Joonsoo Kim36576002012-10-26 23:03:49 +0900856 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800857 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800858 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900859 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200860}
861
862/**
863 * wq_worker_sleeping - a worker is going to sleep
864 * @task: task going to sleep
Tejun Heoe22bee72010-06-29 10:07:14 +0200865 *
866 * This function is called during schedule() when a busy worker is
867 * going to sleep. Worker on the same cpu can be woken up by
868 * returning pointer to its task.
869 *
870 * CONTEXT:
871 * spin_lock_irq(rq->lock)
872 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700873 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200874 * Worker task on @cpu to wake up, %NULL if none.
875 */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100876struct task_struct *wq_worker_sleeping(struct task_struct *task)
Tejun Heoe22bee72010-06-29 10:07:14 +0200877{
878 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800879 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200880
Tejun Heo111c2252013-01-17 17:16:24 -0800881 /*
882 * Rescuers, which may not have all the fields set up like normal
883 * workers, also reach here, let's not access anything before
884 * checking NOT_RUNNING.
885 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500886 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200887 return NULL;
888
Tejun Heo111c2252013-01-17 17:16:24 -0800889 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800890
Tejun Heoe22bee72010-06-29 10:07:14 +0200891 /* this can only happen on the local cpu */
Alexander Gordeev9b7f6592016-03-02 12:53:31 +0100892 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
Tejun Heo6183c002013-03-12 11:29:57 -0700893 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200894
895 /*
896 * The counterpart of the following dec_and_test, implied mb,
897 * worklist not empty test sequence is in insert_work().
898 * Please read comment there.
899 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700900 * NOT_RUNNING is clear. This means that we're bound to and
901 * running on the local cpu w/ rq lock held and preemption
902 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800903 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700904 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200905 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800906 if (atomic_dec_and_test(&pool->nr_running) &&
907 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800908 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200909 return to_wakeup ? to_wakeup->task : NULL;
910}
911
912/**
913 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200914 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200915 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200916 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800917 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200918 *
Tejun Heocb444762010-07-02 10:03:50 +0200919 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800920 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200921 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800922static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200923{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700924 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200925
Tejun Heocb444762010-07-02 10:03:50 +0200926 WARN_ON_ONCE(worker->task != current);
927
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800928 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200929 if ((flags & WORKER_NOT_RUNNING) &&
930 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800931 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200932 }
933
Tejun Heod302f012010-06-29 10:07:13 +0200934 worker->flags |= flags;
935}
936
937/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200938 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200939 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200940 * @flags: flags to clear
941 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200942 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200943 *
Tejun Heocb444762010-07-02 10:03:50 +0200944 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800945 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200946 */
947static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
948{
Tejun Heo63d95a92012-07-12 14:46:37 -0700949 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200950 unsigned int oflags = worker->flags;
951
Tejun Heocb444762010-07-02 10:03:50 +0200952 WARN_ON_ONCE(worker->task != current);
953
Tejun Heod302f012010-06-29 10:07:13 +0200954 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200955
Tejun Heo42c025f2011-01-11 15:58:49 +0100956 /*
957 * If transitioning out of NOT_RUNNING, increment nr_running. Note
958 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
959 * of multiple flags, not a single flag.
960 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200961 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
962 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800963 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200964}
965
966/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200967 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800968 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200969 * @work: work to find worker for
970 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800971 * Find a worker which is executing @work on @pool by searching
972 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800973 * to match, its current execution should match the address of @work and
974 * its work function. This is to avoid unwanted dependency between
975 * unrelated work executions through a work item being recycled while still
976 * being executed.
977 *
978 * This is a bit tricky. A work item may be freed once its execution
979 * starts and nothing prevents the freed area from being recycled for
980 * another work item. If the same work item address ends up being reused
981 * before the original execution finishes, workqueue will identify the
982 * recycled work item as currently executing and make it wait until the
983 * current execution finishes, introducing an unwanted dependency.
984 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700985 * This function checks the work item address and work function to avoid
986 * false positives. Note that this isn't complete as one may construct a
987 * work function which can introduce dependency onto itself through a
988 * recycled work item. Well, if somebody wants to shoot oneself in the
989 * foot that badly, there's only so much we can do, and if such deadlock
990 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200991 *
992 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800993 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200994 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700995 * Return:
996 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200997 * otherwise.
998 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800999static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001000 struct work_struct *work)
1001{
Sasha Levin42f85702012-12-17 10:01:23 -05001002 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001003
Sasha Levinb67bfe02013-02-27 17:06:00 -08001004 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001005 (unsigned long)work)
1006 if (worker->current_work == work &&
1007 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001008 return worker;
1009
1010 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001011}
1012
1013/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001014 * move_linked_works - move linked works to a list
1015 * @work: start of series of works to be scheduled
1016 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301017 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001018 *
1019 * Schedule linked works starting from @work to @head. Work series to
1020 * be scheduled starts at @work and includes any consecutive work with
1021 * WORK_STRUCT_LINKED set in its predecessor.
1022 *
1023 * If @nextp is not NULL, it's updated to point to the next work of
1024 * the last scheduled work. This allows move_linked_works() to be
1025 * nested inside outer list_for_each_entry_safe().
1026 *
1027 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001028 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001029 */
1030static void move_linked_works(struct work_struct *work, struct list_head *head,
1031 struct work_struct **nextp)
1032{
1033 struct work_struct *n;
1034
1035 /*
1036 * Linked worklist will always end before the end of the list,
1037 * use NULL for list head.
1038 */
1039 list_for_each_entry_safe_from(work, n, NULL, entry) {
1040 list_move_tail(&work->entry, head);
1041 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1042 break;
1043 }
1044
1045 /*
1046 * If we're already inside safe list traversal and have moved
1047 * multiple works to the scheduled queue, the next position
1048 * needs to be updated.
1049 */
1050 if (nextp)
1051 *nextp = n;
1052}
1053
Tejun Heo8864b4e2013-03-12 11:30:04 -07001054/**
1055 * get_pwq - get an extra reference on the specified pool_workqueue
1056 * @pwq: pool_workqueue to get
1057 *
1058 * Obtain an extra reference on @pwq. The caller should guarantee that
1059 * @pwq has positive refcnt and be holding the matching pool->lock.
1060 */
1061static void get_pwq(struct pool_workqueue *pwq)
1062{
1063 lockdep_assert_held(&pwq->pool->lock);
1064 WARN_ON_ONCE(pwq->refcnt <= 0);
1065 pwq->refcnt++;
1066}
1067
1068/**
1069 * put_pwq - put a pool_workqueue reference
1070 * @pwq: pool_workqueue to put
1071 *
1072 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1073 * destruction. The caller should be holding the matching pool->lock.
1074 */
1075static void put_pwq(struct pool_workqueue *pwq)
1076{
1077 lockdep_assert_held(&pwq->pool->lock);
1078 if (likely(--pwq->refcnt))
1079 return;
1080 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1081 return;
1082 /*
1083 * @pwq can't be released under pool->lock, bounce to
1084 * pwq_unbound_release_workfn(). This never recurses on the same
1085 * pool->lock as this path is taken only for unbound workqueues and
1086 * the release work item is scheduled on a per-cpu workqueue. To
1087 * avoid lockdep warning, unbound pool->locks are given lockdep
1088 * subclass of 1 in get_unbound_pool().
1089 */
1090 schedule_work(&pwq->unbound_release_work);
1091}
1092
Tejun Heodce90d42013-04-01 11:23:35 -07001093/**
1094 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1095 * @pwq: pool_workqueue to put (can be %NULL)
1096 *
1097 * put_pwq() with locking. This function also allows %NULL @pwq.
1098 */
1099static void put_pwq_unlocked(struct pool_workqueue *pwq)
1100{
1101 if (pwq) {
1102 /*
1103 * As both pwqs and pools are sched-RCU protected, the
1104 * following lock operations are safe.
1105 */
1106 spin_lock_irq(&pwq->pool->lock);
1107 put_pwq(pwq);
1108 spin_unlock_irq(&pwq->pool->lock);
1109 }
1110}
1111
Tejun Heo112202d2013-02-13 19:29:12 -08001112static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001113{
Tejun Heo112202d2013-02-13 19:29:12 -08001114 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001115
1116 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001117 if (list_empty(&pwq->pool->worklist))
1118 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001119 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001120 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001121 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001122}
1123
Tejun Heo112202d2013-02-13 19:29:12 -08001124static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001125{
Tejun Heo112202d2013-02-13 19:29:12 -08001126 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001127 struct work_struct, entry);
1128
Tejun Heo112202d2013-02-13 19:29:12 -08001129 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001130}
1131
Tejun Heobf4ede02012-08-03 10:30:46 -07001132/**
Tejun Heo112202d2013-02-13 19:29:12 -08001133 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1134 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001135 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001136 *
1137 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001138 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001139 *
1140 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001141 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001142 */
Tejun Heo112202d2013-02-13 19:29:12 -08001143static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001144{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001145 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001146 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001147 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001148
Tejun Heo112202d2013-02-13 19:29:12 -08001149 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001150
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq->nr_active--;
1152 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001153 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001154 if (pwq->nr_active < pwq->max_active)
1155 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001156 }
1157
1158 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001159 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001160 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001161
1162 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001163 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001164 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001165
Tejun Heo112202d2013-02-13 19:29:12 -08001166 /* this pwq is done, clear flush_color */
1167 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001168
1169 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001170 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001171 * will handle the rest.
1172 */
Tejun Heo112202d2013-02-13 19:29:12 -08001173 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1174 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001175out_put:
1176 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001177}
1178
Tejun Heo36e227d2012-08-03 10:30:46 -07001179/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001180 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001181 * @work: work item to steal
1182 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001183 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001184 *
1185 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001186 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001187 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001188 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001189 * 1 if @work was pending and we successfully stole PENDING
1190 * 0 if @work was idle and we claimed PENDING
1191 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001192 * -ENOENT if someone else is canceling @work, this state may persist
1193 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001194 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001195 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001196 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001197 * interrupted while holding PENDING and @work off queue, irq must be
1198 * disabled on entry. This, combined with delayed_work->timer being
1199 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001200 *
1201 * On successful return, >= 0, irq is disabled and the caller is
1202 * responsible for releasing it using local_irq_restore(*@flags).
1203 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001204 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001205 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001206static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1207 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001208{
Tejun Heod565ed62013-01-24 11:01:33 -08001209 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001210 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001211
Tejun Heobbb68df2012-08-03 10:30:46 -07001212 local_irq_save(*flags);
1213
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 /* try to steal the timer if it exists */
1215 if (is_dwork) {
1216 struct delayed_work *dwork = to_delayed_work(work);
1217
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001218 /*
1219 * dwork->timer is irqsafe. If del_timer() fails, it's
1220 * guaranteed that the timer is not queued anywhere and not
1221 * running on the local CPU.
1222 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001223 if (likely(del_timer(&dwork->timer)))
1224 return 1;
1225 }
1226
1227 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001228 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1229 return 0;
1230
1231 /*
1232 * The queueing is in progress, or it is already queued. Try to
1233 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1234 */
Tejun Heod565ed62013-01-24 11:01:33 -08001235 pool = get_work_pool(work);
1236 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001237 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001238
Tejun Heod565ed62013-01-24 11:01:33 -08001239 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001240 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001241 * work->data is guaranteed to point to pwq only while the work
1242 * item is queued on pwq->wq, and both updating work->data to point
1243 * to pwq on queueing and to pool on dequeueing are done under
1244 * pwq->pool->lock. This in turn guarantees that, if work->data
1245 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001246 * item is currently queued on that pool.
1247 */
Tejun Heo112202d2013-02-13 19:29:12 -08001248 pwq = get_work_pwq(work);
1249 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001250 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001251
Tejun Heo16062832013-02-06 18:04:53 -08001252 /*
1253 * A delayed work item cannot be grabbed directly because
1254 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001255 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001256 * management later on and cause stall. Make sure the work
1257 * item is activated before grabbing.
1258 */
1259 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001260 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001261
Tejun Heo16062832013-02-06 18:04:53 -08001262 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001263 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001264
Tejun Heo112202d2013-02-13 19:29:12 -08001265 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001266 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001267
Tejun Heo16062832013-02-06 18:04:53 -08001268 spin_unlock(&pool->lock);
1269 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001270 }
Tejun Heod565ed62013-01-24 11:01:33 -08001271 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001272fail:
1273 local_irq_restore(*flags);
1274 if (work_is_canceling(work))
1275 return -ENOENT;
1276 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001277 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001278}
1279
1280/**
Tejun Heo706026c2013-01-24 11:01:34 -08001281 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001282 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001283 * @work: work to insert
1284 * @head: insertion point
1285 * @extra_flags: extra WORK_STRUCT_* flags to set
1286 *
Tejun Heo112202d2013-02-13 19:29:12 -08001287 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001288 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001289 *
1290 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001291 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001292 */
Tejun Heo112202d2013-02-13 19:29:12 -08001293static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1294 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001295{
Tejun Heo112202d2013-02-13 19:29:12 -08001296 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001297
Tejun Heo4690c4a2010-06-29 10:07:10 +02001298 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001299 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001300 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001301 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001302
1303 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001304 * Ensure either wq_worker_sleeping() sees the above
1305 * list_add_tail() or we see zero nr_running to avoid workers lying
1306 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001307 */
1308 smp_mb();
1309
Tejun Heo63d95a92012-07-12 14:46:37 -07001310 if (__need_more_worker(pool))
1311 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001312}
1313
Tejun Heoc8efcc22010-12-20 19:32:04 +01001314/*
1315 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001316 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001317 */
1318static bool is_chained_work(struct workqueue_struct *wq)
1319{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001320 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001321
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001322 worker = current_wq_worker();
1323 /*
1324 * Return %true iff I'm a worker execuing a work item on @wq. If
1325 * I'm @worker, it's safe to dereference it without locking.
1326 */
Tejun Heo112202d2013-02-13 19:29:12 -08001327 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001328}
1329
Mike Galbraithef5571802016-02-09 17:59:38 -05001330/*
1331 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1332 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1333 * avoid perturbing sensitive tasks.
1334 */
1335static int wq_select_unbound_cpu(int cpu)
1336{
Tejun Heof303fccb2016-02-09 17:59:38 -05001337 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001338 int new_cpu;
1339
Tejun Heof303fccb2016-02-09 17:59:38 -05001340 if (likely(!wq_debug_force_rr_cpu)) {
1341 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1342 return cpu;
1343 } else if (!printed_dbg_warning) {
1344 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1345 printed_dbg_warning = true;
1346 }
1347
Mike Galbraithef5571802016-02-09 17:59:38 -05001348 if (cpumask_empty(wq_unbound_cpumask))
1349 return cpu;
1350
1351 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1352 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1353 if (unlikely(new_cpu >= nr_cpu_ids)) {
1354 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1355 if (unlikely(new_cpu >= nr_cpu_ids))
1356 return cpu;
1357 }
1358 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1359
1360 return new_cpu;
1361}
1362
Tejun Heod84ff052013-03-12 11:29:59 -07001363static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 struct work_struct *work)
1365{
Tejun Heo112202d2013-02-13 19:29:12 -08001366 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001367 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001368 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001369 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001370 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001371
1372 /*
1373 * While a work item is PENDING && off queue, a task trying to
1374 * steal the PENDING will busy-loop waiting for it to either get
1375 * queued or lose PENDING. Grabbing PENDING and queueing should
1376 * happen with IRQ disabled.
1377 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001378 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001380 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001381
Li Bin9ef28a72013-09-09 13:13:58 +08001382 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001383 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001384 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001385 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001386retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001387 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001388 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001389
Tejun Heoc9178082013-03-12 11:30:04 -07001390 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001391 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001392 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 else
1394 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001395
Tejun Heoc9178082013-03-12 11:30:04 -07001396 /*
1397 * If @work was previously on a different pool, it might still be
1398 * running there, in which case the work needs to be queued on that
1399 * pool to guarantee non-reentrancy.
1400 */
1401 last_pool = get_work_pool(work);
1402 if (last_pool && last_pool != pwq->pool) {
1403 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001404
Tejun Heoc9178082013-03-12 11:30:04 -07001405 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001406
Tejun Heoc9178082013-03-12 11:30:04 -07001407 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001408
Tejun Heoc9178082013-03-12 11:30:04 -07001409 if (worker && worker->current_pwq->wq == wq) {
1410 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001411 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001412 /* meh... not running there, queue here */
1413 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001414 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001415 }
Tejun Heof3421792010-07-02 10:03:51 +02001416 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001417 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001418 }
1419
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001420 /*
1421 * pwq is determined and locked. For unbound pools, we could have
1422 * raced with pwq release and it could already be dead. If its
1423 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001424 * without another pwq replacing it in the numa_pwq_tbl or while
1425 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001426 * make forward-progress.
1427 */
1428 if (unlikely(!pwq->refcnt)) {
1429 if (wq->flags & WQ_UNBOUND) {
1430 spin_unlock(&pwq->pool->lock);
1431 cpu_relax();
1432 goto retry;
1433 }
1434 /* oops */
1435 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1436 wq->name, cpu);
1437 }
1438
Tejun Heo112202d2013-02-13 19:29:12 -08001439 /* pwq determined, queue */
1440 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001441
Dan Carpenterf5b25522012-04-13 22:06:58 +03001442 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001443 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001444 return;
1445 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001446
Tejun Heo112202d2013-02-13 19:29:12 -08001447 pwq->nr_in_flight[pwq->work_color]++;
1448 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001449
Tejun Heo112202d2013-02-13 19:29:12 -08001450 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001451 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001452 pwq->nr_active++;
1453 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001454 if (list_empty(worklist))
1455 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001456 } else {
1457 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001458 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001459 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001460
Tejun Heo112202d2013-02-13 19:29:12 -08001461 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001462
Tejun Heo112202d2013-02-13 19:29:12 -08001463 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001466/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001467 * queue_work_on - queue work on specific cpu
1468 * @cpu: CPU number to execute work on
1469 * @wq: workqueue to use
1470 * @work: work to queue
1471 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001472 * We queue the work to a specific CPU, the caller must ensure it
1473 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001474 *
1475 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001476 */
Tejun Heod4283e92012-08-03 10:30:44 -07001477bool queue_work_on(int cpu, struct workqueue_struct *wq,
1478 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001479{
Tejun Heod4283e92012-08-03 10:30:44 -07001480 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001481 unsigned long flags;
1482
1483 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001484
Tejun Heo22df02b2010-06-29 10:07:10 +02001485 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001486 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001487 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001488 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001489
1490 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001491 return ret;
1492}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001493EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494
Kees Cook8c20feb2017-10-04 16:27:07 -07001495void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
Kees Cook8c20feb2017-10-04 16:27:07 -07001497 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001499 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001500 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001502EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001504static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1505 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001507 struct timer_list *timer = &dwork->timer;
1508 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Tejun Heo637fdba2017-03-06 15:33:42 -05001510 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001511 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001512 WARN_ON_ONCE(timer_pending(timer));
1513 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001514
Tejun Heo8852aac2012-12-01 16:23:42 -08001515 /*
1516 * If @delay is 0, queue @dwork->work immediately. This is for
1517 * both optimization and correctness. The earliest @timer can
1518 * expire is on the closest next tick and delayed_work users depend
1519 * on that there's no such delay when @delay is 0.
1520 */
1521 if (!delay) {
1522 __queue_work(cpu, wq, &dwork->work);
1523 return;
1524 }
1525
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001526 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001527 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001528 timer->expires = jiffies + delay;
1529
Tejun Heo041bd122016-02-09 16:11:26 -05001530 if (unlikely(cpu != WORK_CPU_UNBOUND))
1531 add_timer_on(timer, cpu);
1532 else
1533 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
1535
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001536/**
1537 * queue_delayed_work_on - queue work on specific CPU after delay
1538 * @cpu: CPU number to execute work on
1539 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001540 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001541 * @delay: number of jiffies to wait before queueing
1542 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001543 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001544 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1545 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001546 */
Tejun Heod4283e92012-08-03 10:30:44 -07001547bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1548 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001549{
David Howells52bad642006-11-22 14:54:01 +00001550 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001551 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001552 unsigned long flags;
1553
1554 /* read the comment in __queue_work() */
1555 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001556
Tejun Heo22df02b2010-06-29 10:07:10 +02001557 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001558 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001559 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001560 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001561
1562 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001563 return ret;
1564}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001565EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Tejun Heoc8e55f32010-06-29 10:07:12 +02001567/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001568 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1569 * @cpu: CPU number to execute work on
1570 * @wq: workqueue to use
1571 * @dwork: work to queue
1572 * @delay: number of jiffies to wait before queueing
1573 *
1574 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1575 * modify @dwork's timer so that it expires after @delay. If @delay is
1576 * zero, @work is guaranteed to be scheduled immediately regardless of its
1577 * current state.
1578 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001579 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001580 * pending and its timer was modified.
1581 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001582 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001583 * See try_to_grab_pending() for details.
1584 */
1585bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1586 struct delayed_work *dwork, unsigned long delay)
1587{
1588 unsigned long flags;
1589 int ret;
1590
1591 do {
1592 ret = try_to_grab_pending(&dwork->work, true, &flags);
1593 } while (unlikely(ret == -EAGAIN));
1594
1595 if (likely(ret >= 0)) {
1596 __queue_delayed_work(cpu, wq, dwork, delay);
1597 local_irq_restore(flags);
1598 }
1599
1600 /* -ENOENT from try_to_grab_pending() becomes %true */
1601 return ret;
1602}
1603EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1604
Tejun Heo05f0fe62018-03-14 12:45:13 -07001605static void rcu_work_rcufn(struct rcu_head *rcu)
1606{
1607 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1608
1609 /* read the comment in __queue_work() */
1610 local_irq_disable();
1611 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1612 local_irq_enable();
1613}
1614
1615/**
1616 * queue_rcu_work - queue work after a RCU grace period
1617 * @wq: workqueue to use
1618 * @rwork: work to queue
1619 *
1620 * Return: %false if @rwork was already pending, %true otherwise. Note
1621 * that a full RCU grace period is guaranteed only after a %true return.
1622 * While @rwork is guarnateed to be executed after a %false return, the
1623 * execution may happen before a full RCU grace period has passed.
1624 */
1625bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1626{
1627 struct work_struct *work = &rwork->work;
1628
1629 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1630 rwork->wq = wq;
1631 call_rcu(&rwork->rcu, rcu_work_rcufn);
1632 return true;
1633 }
1634
1635 return false;
1636}
1637EXPORT_SYMBOL(queue_rcu_work);
1638
Tejun Heo8376fe22012-08-03 10:30:47 -07001639/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001640 * worker_enter_idle - enter idle state
1641 * @worker: worker which is entering idle state
1642 *
1643 * @worker is entering idle state. Update stats and idle timer if
1644 * necessary.
1645 *
1646 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001647 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001648 */
1649static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001651 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Tejun Heo6183c002013-03-12 11:29:57 -07001653 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1654 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1655 (worker->hentry.next || worker->hentry.pprev)))
1656 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Lai Jiangshan051e1852014-07-22 13:03:02 +08001658 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001659 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001660 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001661 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001662
Tejun Heoc8e55f32010-06-29 10:07:12 +02001663 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001664 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001665
Tejun Heo628c78e2012-07-17 12:39:27 -07001666 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1667 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001668
Tejun Heo544ecf32012-05-14 15:04:50 -07001669 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001670 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001671 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001672 * nr_running, the warning may trigger spuriously. Check iff
1673 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001674 */
Tejun Heo24647572013-01-24 11:01:33 -08001675 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001676 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001677 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Tejun Heoc8e55f32010-06-29 10:07:12 +02001680/**
1681 * worker_leave_idle - leave idle state
1682 * @worker: worker which is leaving idle state
1683 *
1684 * @worker is leaving idle state. Update stats.
1685 *
1686 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001687 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001688 */
1689static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001691 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Tejun Heo6183c002013-03-12 11:29:57 -07001693 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1694 return;
Tejun Heod302f012010-06-29 10:07:13 +02001695 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001696 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001697 list_del_init(&worker->entry);
1698}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001700static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001701{
1702 struct worker *worker;
1703
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001704 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001705 if (worker) {
1706 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001707 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001708 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001709 /* on creation a worker is in !idle && prep state */
1710 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001711 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001712 return worker;
1713}
1714
1715/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001716 * worker_attach_to_pool() - attach a worker to a pool
1717 * @worker: worker to be attached
1718 * @pool: the target pool
1719 *
1720 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1721 * cpu-binding of @worker are kept coordinated with the pool across
1722 * cpu-[un]hotplugs.
1723 */
1724static void worker_attach_to_pool(struct worker *worker,
1725 struct worker_pool *pool)
1726{
1727 mutex_lock(&pool->attach_mutex);
1728
1729 /*
1730 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1731 * online CPUs. It'll be re-applied when any of the CPUs come up.
1732 */
1733 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1734
1735 /*
1736 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1737 * stable across this function. See the comments above the
1738 * flag definition for details.
1739 */
1740 if (pool->flags & POOL_DISASSOCIATED)
1741 worker->flags |= WORKER_UNBOUND;
1742
1743 list_add_tail(&worker->node, &pool->workers);
1744
1745 mutex_unlock(&pool->attach_mutex);
1746}
1747
1748/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001749 * worker_detach_from_pool() - detach a worker from its pool
1750 * @worker: worker which is attached to its pool
1751 * @pool: the pool @worker is attached to
1752 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001753 * Undo the attaching which had been done in worker_attach_to_pool(). The
1754 * caller worker shouldn't access to the pool after detached except it has
1755 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001756 */
1757static void worker_detach_from_pool(struct worker *worker,
1758 struct worker_pool *pool)
1759{
1760 struct completion *detach_completion = NULL;
1761
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001762 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001763 list_del(&worker->node);
1764 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001765 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001766 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001767
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001768 /* clear leftover flags without pool->lock after it is detached */
1769 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1770
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001771 if (detach_completion)
1772 complete(detach_completion);
1773}
1774
1775/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001776 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001777 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001778 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001779 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 *
1781 * CONTEXT:
1782 * Might sleep. Does GFP_KERNEL allocations.
1783 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001784 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001785 * Pointer to the newly created worker.
1786 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001787static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001788{
Tejun Heoc34056a2010-06-29 10:07:11 +02001789 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001790 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001791 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001792
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001793 /* ID is needed to determine kthread name */
1794 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001795 if (id < 0)
1796 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001797
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001798 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 if (!worker)
1800 goto fail;
1801
Tejun Heobd7bdd42012-07-12 14:46:37 -07001802 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 worker->id = id;
1804
Tejun Heo29c91e92013-03-12 11:30:03 -07001805 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001806 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1807 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001808 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001809 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1810
Tejun Heof3f90ad2013-04-01 11:23:34 -07001811 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001812 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001813 if (IS_ERR(worker->task))
1814 goto fail;
1815
Oleg Nesterov91151222013-11-14 12:56:18 +01001816 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001817 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001818
Lai Jiangshanda028462014-05-20 17:46:31 +08001819 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001820 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001821
Lai Jiangshan051e1852014-07-22 13:03:02 +08001822 /* start the newly created worker */
1823 spin_lock_irq(&pool->lock);
1824 worker->pool->nr_workers++;
1825 worker_enter_idle(worker);
1826 wake_up_process(worker->task);
1827 spin_unlock_irq(&pool->lock);
1828
Tejun Heoc34056a2010-06-29 10:07:11 +02001829 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001830
Tejun Heoc34056a2010-06-29 10:07:11 +02001831fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001832 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001833 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001834 kfree(worker);
1835 return NULL;
1836}
1837
1838/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001839 * destroy_worker - destroy a workqueue worker
1840 * @worker: worker to be destroyed
1841 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001842 * Destroy @worker and adjust @pool stats accordingly. The worker should
1843 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001844 *
1845 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001846 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001847 */
1848static void destroy_worker(struct worker *worker)
1849{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001850 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001851
Tejun Heocd549682013-03-13 19:47:39 -07001852 lockdep_assert_held(&pool->lock);
1853
Tejun Heoc34056a2010-06-29 10:07:11 +02001854 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001855 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001856 WARN_ON(!list_empty(&worker->scheduled)) ||
1857 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001858 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001859
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001860 pool->nr_workers--;
1861 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001862
Tejun Heoc8e55f32010-06-29 10:07:12 +02001863 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001864 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001865 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001866}
1867
Kees Cook32a6c722017-10-16 15:58:25 -07001868static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001869{
Kees Cook32a6c722017-10-16 15:58:25 -07001870 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001871
Tejun Heod565ed62013-01-24 11:01:33 -08001872 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001874 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001875 struct worker *worker;
1876 unsigned long expires;
1877
1878 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1881
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001882 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001883 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001884 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001885 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001886
1887 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001888 }
1889
Tejun Heod565ed62013-01-24 11:01:33 -08001890 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001891}
1892
Tejun Heo493a1722013-03-12 11:29:59 -07001893static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001894{
Tejun Heo112202d2013-02-13 19:29:12 -08001895 struct pool_workqueue *pwq = get_work_pwq(work);
1896 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001897
Tejun Heo2e109a22013-03-13 19:47:40 -07001898 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001899
Tejun Heo493008a2013-03-12 11:30:03 -07001900 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001901 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001902
1903 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001904 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001905 /*
1906 * If @pwq is for an unbound wq, its base ref may be put at
1907 * any time due to an attribute change. Pin @pwq until the
1908 * rescuer is done with it.
1909 */
1910 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001911 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001913 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001914}
1915
Kees Cook32a6c722017-10-16 15:58:25 -07001916static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001917{
Kees Cook32a6c722017-10-16 15:58:25 -07001918 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001919 struct work_struct *work;
1920
Tejun Heob2d82902014-12-08 12:39:16 -05001921 spin_lock_irq(&pool->lock);
1922 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001923
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 /*
1926 * We've been trying to create a new worker but
1927 * haven't been successful. We might be hitting an
1928 * allocation deadlock. Send distress signals to
1929 * rescuers.
1930 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001931 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 send_mayday(work);
1933 }
1934
Tejun Heob2d82902014-12-08 12:39:16 -05001935 spin_unlock(&wq_mayday_lock);
1936 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001937
Tejun Heo63d95a92012-07-12 14:46:37 -07001938 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001939}
1940
1941/**
1942 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001943 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 * have at least one idle worker on return from this function. If
1947 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 * possible allocation deadlock.
1950 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001951 * On return, need_to_create_worker() is guaranteed to be %false and
1952 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001953 *
1954 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001955 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 * multiple times. Does GFP_KERNEL allocations. Called only from
1957 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 */
Tejun Heo29187a92015-01-16 14:21:16 -05001959static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001960__releases(&pool->lock)
1961__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001962{
Tejun Heoe22bee72010-06-29 10:07:14 +02001963restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001964 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001965
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001967 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001968
1969 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001970 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 break;
1972
Lai Jiangshane212f362014-06-03 15:32:17 +08001973 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001974
Tejun Heo63d95a92012-07-12 14:46:37 -07001975 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001976 break;
1977 }
1978
Tejun Heo63d95a92012-07-12 14:46:37 -07001979 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001980 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001981 /*
1982 * This is necessary even after a new worker was just successfully
1983 * created as @pool->lock was dropped and the new worker might have
1984 * already become busy.
1985 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001986 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001987 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001988}
1989
1990/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001991 * manage_workers - manage worker pool
1992 * @worker: self
1993 *
Tejun Heo706026c2013-01-24 11:01:34 -08001994 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001995 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001996 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 *
1998 * The caller can safely start processing works on false return. On
1999 * true return, it's guaranteed that need_to_create_worker() is false
2000 * and may_start_working() is true.
2001 *
2002 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002003 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 * multiple times. Does GFP_KERNEL allocations.
2005 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002006 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002007 * %false if the pool doesn't need management and the caller can safely
2008 * start processing works, %true if management function was performed and
2009 * the conditions that the caller verified before calling the function may
2010 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002011 */
2012static bool manage_workers(struct worker *worker)
2013{
Tejun Heo63d95a92012-07-12 14:46:37 -07002014 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002015
Tejun Heo692b4822017-10-09 08:04:13 -07002016 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002017 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002018
2019 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002020 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002021
Tejun Heo29187a92015-01-16 14:21:16 -05002022 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002023
Tejun Heo2607d7a2015-03-09 09:22:28 -04002024 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002025 pool->flags &= ~POOL_MANAGER_ACTIVE;
2026 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002027 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002028}
2029
Tejun Heoa62428c2010-06-29 10:07:10 +02002030/**
2031 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002032 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002033 * @work: work to process
2034 *
2035 * Process @work. This function contains all the logics necessary to
2036 * process a single work including synchronization against and
2037 * interaction with other workers on the same cpu, queueing and
2038 * flushing. As long as context requirement is met, any worker can
2039 * call this function to process a work.
2040 *
2041 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002042 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002043 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002044static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002045__releases(&pool->lock)
2046__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002047{
Tejun Heo112202d2013-02-13 19:29:12 -08002048 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002049 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002050 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002051 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002052 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002053#ifdef CONFIG_LOCKDEP
2054 /*
2055 * It is permissible to free the struct work_struct from
2056 * inside the function that is called from it, this we need to
2057 * take into account for lockdep too. To avoid bogus "held
2058 * lock freed" warnings as well as problems when looking into
2059 * work->lockdep_map, make a copy and use that here.
2060 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002061 struct lockdep_map lockdep_map;
2062
2063 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002064#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002065 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002066 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002067 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002068
Tejun Heo7e116292010-06-29 10:07:13 +02002069 /*
2070 * A single work shouldn't be executed concurrently by
2071 * multiple workers on a single cpu. Check whether anyone is
2072 * already processing the work. If so, defer the work to the
2073 * currently executing one.
2074 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002075 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002076 if (unlikely(collision)) {
2077 move_linked_works(work, &collision->scheduled, NULL);
2078 return;
2079 }
2080
Tejun Heo8930cab2012-08-03 10:30:45 -07002081 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002082 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002083 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002084 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002085 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002086 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002087 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002088
Tejun Heoa62428c2010-06-29 10:07:10 +02002089 list_del_init(&work->entry);
2090
Tejun Heo649027d2010-06-29 10:07:14 +02002091 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002092 * CPU intensive works don't participate in concurrency management.
2093 * They're the scheduler's responsibility. This takes @worker out
2094 * of concurrency management and the next code block will chain
2095 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002096 */
2097 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002098 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002099
Tejun Heo974271c2012-07-12 14:46:37 -07002100 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002101 * Wake up another worker if necessary. The condition is always
2102 * false for normal per-cpu workers since nr_running would always
2103 * be >= 1 at this point. This is used to chain execution of the
2104 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002105 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002106 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002107 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002108 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002109
Tejun Heo8930cab2012-08-03 10:30:45 -07002110 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002111 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002112 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002113 * PENDING and queued state changes happen together while IRQ is
2114 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002115 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002116 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002117
Tejun Heod565ed62013-01-24 11:01:33 -08002118 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002119
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002120 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002121 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002122 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002123 * Strictly speaking we should mark the invariant state without holding
2124 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002125 *
2126 * However, that would result in:
2127 *
2128 * A(W1)
2129 * WFC(C)
2130 * A(W1)
2131 * C(C)
2132 *
2133 * Which would create W1->C->W1 dependencies, even though there is no
2134 * actual deadlock possible. There are two solutions, using a
2135 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002136 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002137 * these locks.
2138 *
2139 * AFAICT there is no possible deadlock scenario between the
2140 * flush_work() and complete() primitives (except for single-threaded
2141 * workqueues), so hiding them isn't a problem.
2142 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002143 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002144 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002145 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002146 /*
2147 * While we must be careful to not use "work" after this, the trace
2148 * point will only record its address.
2149 */
2150 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002151 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002152 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002153
2154 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002155 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2156 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002157 current->comm, preempt_count(), task_pid_nr(current),
2158 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002159 debug_show_held_locks(current);
2160 dump_stack();
2161 }
2162
Tejun Heob22ce272013-08-28 17:33:37 -04002163 /*
2164 * The following prevents a kworker from hogging CPU on !PREEMPT
2165 * kernels, where a requeueing work item waiting for something to
2166 * happen could deadlock with stop_machine as such work item could
2167 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002168 * stop_machine. At the same time, report a quiescent RCU state so
2169 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002170 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002171 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002172
Tejun Heod565ed62013-01-24 11:01:33 -08002173 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002174
Tejun Heofb0e7be2010-06-29 10:07:15 +02002175 /* clear cpu intensive status */
2176 if (unlikely(cpu_intensive))
2177 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2178
Tejun Heoa62428c2010-06-29 10:07:10 +02002179 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002180 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002181 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002182 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002183 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002184 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002185 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002186}
2187
Tejun Heoaffee4b2010-06-29 10:07:12 +02002188/**
2189 * process_scheduled_works - process scheduled works
2190 * @worker: self
2191 *
2192 * Process all scheduled works. Please note that the scheduled list
2193 * may change while processing a work, so this function repeatedly
2194 * fetches a work from the top and executes it.
2195 *
2196 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002197 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002198 * multiple times.
2199 */
2200static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002202 while (!list_empty(&worker->scheduled)) {
2203 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002205 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207}
2208
Tejun Heo4690c4a2010-06-29 10:07:10 +02002209/**
2210 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002211 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002212 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002213 * The worker thread function. All workers belong to a worker_pool -
2214 * either a per-cpu one or dynamic unbound one. These workers process all
2215 * work items regardless of their specific target workqueue. The only
2216 * exception is work items which belong to workqueues with a rescuer which
2217 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002218 *
2219 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002220 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002221static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222{
Tejun Heoc34056a2010-06-29 10:07:11 +02002223 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002224 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225
Tejun Heoe22bee72010-06-29 10:07:14 +02002226 /* tell the scheduler that this is a workqueue worker */
2227 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002228woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002229 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002230
Tejun Heoa9ab7752013-03-19 13:45:21 -07002231 /* am I supposed to die? */
2232 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002233 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002234 WARN_ON_ONCE(!list_empty(&worker->entry));
2235 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002236
2237 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002238 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002239 worker_detach_from_pool(worker, pool);
2240 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002241 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002243
Tejun Heoc8e55f32010-06-29 10:07:12 +02002244 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002245recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002246 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002247 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002248 goto sleep;
2249
2250 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002251 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002252 goto recheck;
2253
Tejun Heoc8e55f32010-06-29 10:07:12 +02002254 /*
2255 * ->scheduled list can only be filled while a worker is
2256 * preparing to process a work or actually processing it.
2257 * Make sure nobody diddled with it while I was sleeping.
2258 */
Tejun Heo6183c002013-03-12 11:29:57 -07002259 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002260
Tejun Heoe22bee72010-06-29 10:07:14 +02002261 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002262 * Finish PREP stage. We're guaranteed to have at least one idle
2263 * worker or that someone else has already assumed the manager
2264 * role. This is where @worker starts participating in concurrency
2265 * management if applicable and concurrency management is restored
2266 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002267 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002268 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002269
2270 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002271 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002272 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002273 struct work_struct, entry);
2274
Tejun Heo82607adc2015-12-08 11:28:04 -05002275 pool->watchdog_ts = jiffies;
2276
Tejun Heoc8e55f32010-06-29 10:07:12 +02002277 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2278 /* optimization path, not strictly necessary */
2279 process_one_work(worker, work);
2280 if (unlikely(!list_empty(&worker->scheduled)))
2281 process_scheduled_works(worker);
2282 } else {
2283 move_linked_works(work, &worker->scheduled, NULL);
2284 process_scheduled_works(worker);
2285 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002286 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002287
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002288 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002289sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002290 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002291 * pool->lock is held and there's no work to process and no need to
2292 * manage, sleep. Workers are woken up only while holding
2293 * pool->lock or from local cpu, so setting the current state
2294 * before releasing pool->lock is enough to prevent losing any
2295 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002296 */
2297 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002298 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002299 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002300 schedule();
2301 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302}
2303
Tejun Heoe22bee72010-06-29 10:07:14 +02002304/**
2305 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002306 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 *
2308 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002309 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002310 *
Tejun Heo706026c2013-01-24 11:01:34 -08002311 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002312 * worker which uses GFP_KERNEL allocation which has slight chance of
2313 * developing into deadlock if some works currently on the same queue
2314 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2315 * the problem rescuer solves.
2316 *
Tejun Heo706026c2013-01-24 11:01:34 -08002317 * When such condition is possible, the pool summons rescuers of all
2318 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002319 * those works so that forward progress can be guaranteed.
2320 *
2321 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002322 *
2323 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002324 */
Tejun Heo111c2252013-01-17 17:16:24 -08002325static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002326{
Tejun Heo111c2252013-01-17 17:16:24 -08002327 struct worker *rescuer = __rescuer;
2328 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002329 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002330 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002331
2332 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002333
2334 /*
2335 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2336 * doesn't participate in concurrency management.
2337 */
2338 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002339repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002340 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002341
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002342 /*
2343 * By the time the rescuer is requested to stop, the workqueue
2344 * shouldn't have any work pending, but @wq->maydays may still have
2345 * pwq(s) queued. This can happen by non-rescuer workers consuming
2346 * all the work items before the rescuer got to them. Go through
2347 * @wq->maydays processing before acting on should_stop so that the
2348 * list is always empty on exit.
2349 */
2350 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002351
Tejun Heo493a1722013-03-12 11:29:59 -07002352 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002353 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002354
2355 while (!list_empty(&wq->maydays)) {
2356 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2357 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002358 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002359 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002360 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002361
2362 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002363 list_del_init(&pwq->mayday_node);
2364
Tejun Heo2e109a22013-03-13 19:47:40 -07002365 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002366
Lai Jiangshan51697d392014-05-20 17:46:36 +08002367 worker_attach_to_pool(rescuer, pool);
2368
2369 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002370 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002371
2372 /*
2373 * Slurp in all works issued via this workqueue and
2374 * process'em.
2375 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002376 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002377 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2378 if (get_work_pwq(work) == pwq) {
2379 if (first)
2380 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002381 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002382 }
2383 first = false;
2384 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002385
NeilBrown008847f2014-12-08 12:39:16 -05002386 if (!list_empty(scheduled)) {
2387 process_scheduled_works(rescuer);
2388
2389 /*
2390 * The above execution of rescued work items could
2391 * have created more to rescue through
2392 * pwq_activate_first_delayed() or chained
2393 * queueing. Let's put @pwq back on mayday list so
2394 * that such back-to-back work items, which may be
2395 * being used to relieve memory pressure, don't
2396 * incur MAYDAY_INTERVAL delay inbetween.
2397 */
2398 if (need_to_create_worker(pool)) {
2399 spin_lock(&wq_mayday_lock);
2400 get_pwq(pwq);
2401 list_move_tail(&pwq->mayday_node, &wq->maydays);
2402 spin_unlock(&wq_mayday_lock);
2403 }
2404 }
Tejun Heo75769582011-02-14 14:04:46 +01002405
2406 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002407 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002408 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002409 */
2410 put_pwq(pwq);
2411
2412 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002413 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002414 * regular worker; otherwise, we end up with 0 concurrency
2415 * and stalling the execution.
2416 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002417 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002418 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002419
Lai Jiangshanb3104102013-02-19 12:17:02 -08002420 rescuer->pool = NULL;
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002421 spin_unlock_irq(&pool->lock);
2422
2423 worker_detach_from_pool(rescuer, pool);
2424
2425 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002426 }
2427
Tejun Heo2e109a22013-03-13 19:47:40 -07002428 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002429
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002430 if (should_stop) {
2431 __set_current_state(TASK_RUNNING);
2432 rescuer->task->flags &= ~PF_WQ_WORKER;
2433 return 0;
2434 }
2435
Tejun Heo111c2252013-01-17 17:16:24 -08002436 /* rescuers should never participate in concurrency management */
2437 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002438 schedule();
2439 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440}
2441
Tejun Heofca839c2015-12-07 10:58:57 -05002442/**
2443 * check_flush_dependency - check for flush dependency sanity
2444 * @target_wq: workqueue being flushed
2445 * @target_work: work item being flushed (NULL for workqueue flushes)
2446 *
2447 * %current is trying to flush the whole @target_wq or @target_work on it.
2448 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2449 * reclaiming memory or running on a workqueue which doesn't have
2450 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2451 * a deadlock.
2452 */
2453static void check_flush_dependency(struct workqueue_struct *target_wq,
2454 struct work_struct *target_work)
2455{
2456 work_func_t target_func = target_work ? target_work->func : NULL;
2457 struct worker *worker;
2458
2459 if (target_wq->flags & WQ_MEM_RECLAIM)
2460 return;
2461
2462 worker = current_wq_worker();
2463
2464 WARN_ONCE(current->flags & PF_MEMALLOC,
2465 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2466 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002467 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2468 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002469 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2470 worker->current_pwq->wq->name, worker->current_func,
2471 target_wq->name, target_func);
2472}
2473
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002474struct wq_barrier {
2475 struct work_struct work;
2476 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002477 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002478};
2479
2480static void wq_barrier_func(struct work_struct *work)
2481{
2482 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2483 complete(&barr->done);
2484}
2485
Tejun Heo4690c4a2010-06-29 10:07:10 +02002486/**
2487 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002488 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002489 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002490 * @target: target work to attach @barr to
2491 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002492 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002493 * @barr is linked to @target such that @barr is completed only after
2494 * @target finishes execution. Please note that the ordering
2495 * guarantee is observed only with respect to @target and on the local
2496 * cpu.
2497 *
2498 * Currently, a queued barrier can't be canceled. This is because
2499 * try_to_grab_pending() can't determine whether the work to be
2500 * grabbed is at the head of the queue and thus can't clear LINKED
2501 * flag of the previous work while there must be a valid next work
2502 * after a work with LINKED flag set.
2503 *
2504 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002505 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002506 *
2507 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002508 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002509 */
Tejun Heo112202d2013-02-13 19:29:12 -08002510static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002511 struct wq_barrier *barr,
2512 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002513{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002514 struct list_head *head;
2515 unsigned int linked = 0;
2516
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002517 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002518 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002519 * as we know for sure that this will not trigger any of the
2520 * checks and call back into the fixup functions where we
2521 * might deadlock.
2522 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002523 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002524 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002525
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002526 init_completion_map(&barr->done, &target->lockdep_map);
2527
Tejun Heo2607d7a2015-03-09 09:22:28 -04002528 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002529
Tejun Heoaffee4b2010-06-29 10:07:12 +02002530 /*
2531 * If @target is currently being executed, schedule the
2532 * barrier to the worker; otherwise, put it after @target.
2533 */
2534 if (worker)
2535 head = worker->scheduled.next;
2536 else {
2537 unsigned long *bits = work_data_bits(target);
2538
2539 head = target->entry.next;
2540 /* there can already be other linked works, inherit and set */
2541 linked = *bits & WORK_STRUCT_LINKED;
2542 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2543 }
2544
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002545 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002546 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002547 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002548}
2549
Tejun Heo73f53c42010-06-29 10:07:11 +02002550/**
Tejun Heo112202d2013-02-13 19:29:12 -08002551 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002552 * @wq: workqueue being flushed
2553 * @flush_color: new flush color, < 0 for no-op
2554 * @work_color: new work color, < 0 for no-op
2555 *
Tejun Heo112202d2013-02-13 19:29:12 -08002556 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002557 *
Tejun Heo112202d2013-02-13 19:29:12 -08002558 * If @flush_color is non-negative, flush_color on all pwqs should be
2559 * -1. If no pwq has in-flight commands at the specified color, all
2560 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2561 * has in flight commands, its pwq->flush_color is set to
2562 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002563 * wakeup logic is armed and %true is returned.
2564 *
2565 * The caller should have initialized @wq->first_flusher prior to
2566 * calling this function with non-negative @flush_color. If
2567 * @flush_color is negative, no flush color update is done and %false
2568 * is returned.
2569 *
Tejun Heo112202d2013-02-13 19:29:12 -08002570 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002571 * work_color which is previous to @work_color and all will be
2572 * advanced to @work_color.
2573 *
2574 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002575 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002576 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002577 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002578 * %true if @flush_color >= 0 and there's something to flush. %false
2579 * otherwise.
2580 */
Tejun Heo112202d2013-02-13 19:29:12 -08002581static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002582 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583{
Tejun Heo73f53c42010-06-29 10:07:11 +02002584 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002585 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002586
Tejun Heo73f53c42010-06-29 10:07:11 +02002587 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002588 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002589 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002590 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002591
Tejun Heo49e3cf42013-03-12 11:29:58 -07002592 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002593 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002594
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002595 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002596
2597 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002598 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002599
Tejun Heo112202d2013-02-13 19:29:12 -08002600 if (pwq->nr_in_flight[flush_color]) {
2601 pwq->flush_color = flush_color;
2602 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002603 wait = true;
2604 }
2605 }
2606
2607 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002608 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002609 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002610 }
2611
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002612 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002613 }
2614
Tejun Heo112202d2013-02-13 19:29:12 -08002615 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002616 complete(&wq->first_flusher->done);
2617
2618 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619}
2620
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002621/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002623 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002625 * This function sleeps until all work items which were queued on entry
2626 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002628void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629{
Tejun Heo73f53c42010-06-29 10:07:11 +02002630 struct wq_flusher this_flusher = {
2631 .list = LIST_HEAD_INIT(this_flusher.list),
2632 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002633 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002634 };
2635 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002636
Tejun Heo3347fa02016-09-16 15:49:32 -04002637 if (WARN_ON(!wq_online))
2638 return;
2639
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002640 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002641
2642 /*
2643 * Start-to-wait phase
2644 */
2645 next_color = work_next_color(wq->work_color);
2646
2647 if (next_color != wq->flush_color) {
2648 /*
2649 * Color space is not full. The current work_color
2650 * becomes our flush_color and work_color is advanced
2651 * by one.
2652 */
Tejun Heo6183c002013-03-12 11:29:57 -07002653 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002654 this_flusher.flush_color = wq->work_color;
2655 wq->work_color = next_color;
2656
2657 if (!wq->first_flusher) {
2658 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002659 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002660
2661 wq->first_flusher = &this_flusher;
2662
Tejun Heo112202d2013-02-13 19:29:12 -08002663 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002664 wq->work_color)) {
2665 /* nothing to flush, done */
2666 wq->flush_color = next_color;
2667 wq->first_flusher = NULL;
2668 goto out_unlock;
2669 }
2670 } else {
2671 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002672 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002673 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002674 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002675 }
2676 } else {
2677 /*
2678 * Oops, color space is full, wait on overflow queue.
2679 * The next flush completion will assign us
2680 * flush_color and transfer to flusher_queue.
2681 */
2682 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2683 }
2684
Tejun Heofca839c2015-12-07 10:58:57 -05002685 check_flush_dependency(wq, NULL);
2686
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002687 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002688
2689 wait_for_completion(&this_flusher.done);
2690
2691 /*
2692 * Wake-up-and-cascade phase
2693 *
2694 * First flushers are responsible for cascading flushes and
2695 * handling overflow. Non-first flushers can simply return.
2696 */
2697 if (wq->first_flusher != &this_flusher)
2698 return;
2699
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002700 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002701
Tejun Heo4ce48b32010-07-02 10:03:51 +02002702 /* we might have raced, check again with mutex held */
2703 if (wq->first_flusher != &this_flusher)
2704 goto out_unlock;
2705
Tejun Heo73f53c42010-06-29 10:07:11 +02002706 wq->first_flusher = NULL;
2707
Tejun Heo6183c002013-03-12 11:29:57 -07002708 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2709 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002710
2711 while (true) {
2712 struct wq_flusher *next, *tmp;
2713
2714 /* complete all the flushers sharing the current flush color */
2715 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2716 if (next->flush_color != wq->flush_color)
2717 break;
2718 list_del_init(&next->list);
2719 complete(&next->done);
2720 }
2721
Tejun Heo6183c002013-03-12 11:29:57 -07002722 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2723 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002724
2725 /* this flush_color is finished, advance by one */
2726 wq->flush_color = work_next_color(wq->flush_color);
2727
2728 /* one color has been freed, handle overflow queue */
2729 if (!list_empty(&wq->flusher_overflow)) {
2730 /*
2731 * Assign the same color to all overflowed
2732 * flushers, advance work_color and append to
2733 * flusher_queue. This is the start-to-wait
2734 * phase for these overflowed flushers.
2735 */
2736 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2737 tmp->flush_color = wq->work_color;
2738
2739 wq->work_color = work_next_color(wq->work_color);
2740
2741 list_splice_tail_init(&wq->flusher_overflow,
2742 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002743 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002744 }
2745
2746 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002747 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002748 break;
2749 }
2750
2751 /*
2752 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002753 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002754 */
Tejun Heo6183c002013-03-12 11:29:57 -07002755 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2756 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002757
2758 list_del_init(&next->list);
2759 wq->first_flusher = next;
2760
Tejun Heo112202d2013-02-13 19:29:12 -08002761 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002762 break;
2763
2764 /*
2765 * Meh... this color is already done, clear first
2766 * flusher and repeat cascading.
2767 */
2768 wq->first_flusher = NULL;
2769 }
2770
2771out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002772 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002774EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002776/**
2777 * drain_workqueue - drain a workqueue
2778 * @wq: workqueue to drain
2779 *
2780 * Wait until the workqueue becomes empty. While draining is in progress,
2781 * only chain queueing is allowed. IOW, only currently pending or running
2782 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002783 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784 * by the depth of chaining and should be relatively short. Whine if it
2785 * takes too long.
2786 */
2787void drain_workqueue(struct workqueue_struct *wq)
2788{
2789 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002790 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002791
2792 /*
2793 * __queue_work() needs to test whether there are drainers, is much
2794 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002795 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002796 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002797 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002798 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002799 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002800 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002801reflush:
2802 flush_workqueue(wq);
2803
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002804 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002805
Tejun Heo49e3cf42013-03-12 11:29:58 -07002806 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002807 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002808
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002809 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002810 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002811 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002812
2813 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002814 continue;
2815
2816 if (++flush_cnt == 10 ||
2817 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002818 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002819 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002820
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002821 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002822 goto reflush;
2823 }
2824
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002825 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002826 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002827 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002828}
2829EXPORT_SYMBOL_GPL(drain_workqueue);
2830
Tejun Heo606a5022012-08-20 14:51:23 -07002831static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002832{
2833 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002834 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002835 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002836
2837 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002838
Tejun Heofa1b54e2013-03-12 11:30:00 -07002839 local_irq_disable();
2840 pool = get_work_pool(work);
2841 if (!pool) {
2842 local_irq_enable();
2843 return false;
2844 }
2845
2846 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002847 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002848 pwq = get_work_pwq(work);
2849 if (pwq) {
2850 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002851 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002852 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002853 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002854 if (!worker)
2855 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002856 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002857 }
Tejun Heobaf59022010-09-16 10:42:16 +02002858
Tejun Heofca839c2015-12-07 10:58:57 -05002859 check_flush_dependency(pwq->wq, work);
2860
Tejun Heo112202d2013-02-13 19:29:12 -08002861 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002862 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002863
Tejun Heoe159489b2011-01-09 23:32:15 +01002864 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002865 * Force a lock recursion deadlock when using flush_work() inside a
2866 * single-threaded or rescuer equipped workqueue.
2867 *
2868 * For single threaded workqueues the deadlock happens when the work
2869 * is after the work issuing the flush_work(). For rescuer equipped
2870 * workqueues the deadlock happens when the rescuer stalls, blocking
2871 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002872 */
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002873 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
Tejun Heo112202d2013-02-13 19:29:12 -08002874 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002875 lock_map_release(&pwq->wq->lockdep_map);
2876 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002877
Tejun Heobaf59022010-09-16 10:42:16 +02002878 return true;
2879already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002880 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002881 return false;
2882}
2883
Oleg Nesterovdb700892008-07-25 01:47:49 -07002884/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002885 * flush_work - wait for a work to finish executing the last queueing instance
2886 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002887 *
Tejun Heo606a5022012-08-20 14:51:23 -07002888 * Wait until @work has finished execution. @work is guaranteed to be idle
2889 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002890 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002891 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002892 * %true if flush_work() waited for the work to finish execution,
2893 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002894 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002895bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002896{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002897 struct wq_barrier barr;
2898
Tejun Heo3347fa02016-09-16 15:49:32 -04002899 if (WARN_ON(!wq_online))
2900 return false;
2901
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002902 if (start_flush_work(work, &barr)) {
2903 wait_for_completion(&barr.done);
2904 destroy_work_on_stack(&barr.work);
2905 return true;
2906 } else {
2907 return false;
2908 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002909}
2910EXPORT_SYMBOL_GPL(flush_work);
2911
Tejun Heo8603e1b32015-03-05 08:04:13 -05002912struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002913 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002914 struct work_struct *work;
2915};
2916
Ingo Molnarac6424b2017-06-20 12:06:13 +02002917static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002918{
2919 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2920
2921 if (cwait->work != key)
2922 return 0;
2923 return autoremove_wake_function(wait, mode, sync, key);
2924}
2925
Tejun Heo36e227d2012-08-03 10:30:46 -07002926static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002927{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002928 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002929 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002930 int ret;
2931
2932 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002933 ret = try_to_grab_pending(work, is_dwork, &flags);
2934 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002935 * If someone else is already canceling, wait for it to
2936 * finish. flush_work() doesn't work for PREEMPT_NONE
2937 * because we may get scheduled between @work's completion
2938 * and the other canceling task resuming and clearing
2939 * CANCELING - flush_work() will return false immediately
2940 * as @work is no longer busy, try_to_grab_pending() will
2941 * return -ENOENT as @work is still being canceled and the
2942 * other canceling task won't be able to clear CANCELING as
2943 * we're hogging the CPU.
2944 *
2945 * Let's wait for completion using a waitqueue. As this
2946 * may lead to the thundering herd problem, use a custom
2947 * wake function which matches @work along with exclusive
2948 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002949 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002950 if (unlikely(ret == -ENOENT)) {
2951 struct cwt_wait cwait;
2952
2953 init_wait(&cwait.wait);
2954 cwait.wait.func = cwt_wakefn;
2955 cwait.work = work;
2956
2957 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2958 TASK_UNINTERRUPTIBLE);
2959 if (work_is_canceling(work))
2960 schedule();
2961 finish_wait(&cancel_waitq, &cwait.wait);
2962 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002963 } while (unlikely(ret < 0));
2964
Tejun Heobbb68df2012-08-03 10:30:46 -07002965 /* tell other tasks trying to grab @work to back off */
2966 mark_work_canceling(work);
2967 local_irq_restore(flags);
2968
Tejun Heo3347fa02016-09-16 15:49:32 -04002969 /*
2970 * This allows canceling during early boot. We know that @work
2971 * isn't executing.
2972 */
2973 if (wq_online)
2974 flush_work(work);
2975
Tejun Heo7a22ad72010-06-29 10:07:13 +02002976 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05002977
2978 /*
2979 * Paired with prepare_to_wait() above so that either
2980 * waitqueue_active() is visible here or !work_is_canceling() is
2981 * visible there.
2982 */
2983 smp_mb();
2984 if (waitqueue_active(&cancel_waitq))
2985 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2986
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002987 return ret;
2988}
2989
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002990/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002991 * cancel_work_sync - cancel a work and wait for it to finish
2992 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002993 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002994 * Cancel @work and wait for its execution to finish. This function
2995 * can be used even if the work re-queues itself or migrates to
2996 * another workqueue. On return from this function, @work is
2997 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002998 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002999 * cancel_work_sync(&delayed_work->work) must not be used for
3000 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003001 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003002 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003003 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003004 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003005 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003006 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003007 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003008bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003009{
Tejun Heo36e227d2012-08-03 10:30:46 -07003010 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003011}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003012EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003013
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003014/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003015 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3016 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003017 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003018 * Delayed timer is cancelled and the pending work is queued for
3019 * immediate execution. Like flush_work(), this function only
3020 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003021 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003022 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003023 * %true if flush_work() waited for the work to finish execution,
3024 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003025 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003026bool flush_delayed_work(struct delayed_work *dwork)
3027{
Tejun Heo8930cab2012-08-03 10:30:45 -07003028 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003029 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003030 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003031 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003032 return flush_work(&dwork->work);
3033}
3034EXPORT_SYMBOL(flush_delayed_work);
3035
Tejun Heo05f0fe62018-03-14 12:45:13 -07003036/**
3037 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3038 * @rwork: the rcu work to flush
3039 *
3040 * Return:
3041 * %true if flush_rcu_work() waited for the work to finish execution,
3042 * %false if it was already idle.
3043 */
3044bool flush_rcu_work(struct rcu_work *rwork)
3045{
3046 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3047 rcu_barrier();
3048 flush_work(&rwork->work);
3049 return true;
3050 } else {
3051 return flush_work(&rwork->work);
3052 }
3053}
3054EXPORT_SYMBOL(flush_rcu_work);
3055
Jens Axboef72b8792016-08-24 15:51:50 -06003056static bool __cancel_work(struct work_struct *work, bool is_dwork)
3057{
3058 unsigned long flags;
3059 int ret;
3060
3061 do {
3062 ret = try_to_grab_pending(work, is_dwork, &flags);
3063 } while (unlikely(ret == -EAGAIN));
3064
3065 if (unlikely(ret < 0))
3066 return false;
3067
3068 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3069 local_irq_restore(flags);
3070 return ret;
3071}
3072
Tejun Heo401a8d02010-09-16 10:36:00 +02003073/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003074 * cancel_delayed_work - cancel a delayed work
3075 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003076 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003077 * Kill off a pending delayed_work.
3078 *
3079 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3080 * pending.
3081 *
3082 * Note:
3083 * The work callback function may still be running on return, unless
3084 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3085 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003086 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003087 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003088 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003089bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003090{
Jens Axboef72b8792016-08-24 15:51:50 -06003091 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003092}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003093EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003094
3095/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003096 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3097 * @dwork: the delayed work cancel
3098 *
3099 * This is cancel_work_sync() for delayed works.
3100 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003101 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003102 * %true if @dwork was pending, %false otherwise.
3103 */
3104bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003105{
Tejun Heo36e227d2012-08-03 10:30:46 -07003106 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003107}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003108EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003110/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003111 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003112 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003113 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003114 * schedule_on_each_cpu() executes @func on each online CPU using the
3115 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003116 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003117 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003118 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003119 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003120 */
David Howells65f27f32006-11-22 14:55:48 +00003121int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003122{
3123 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003124 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003125
Andrew Mortonb6136772006-06-25 05:47:49 -07003126 works = alloc_percpu(struct work_struct);
3127 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003128 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003129
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003130 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003131
Christoph Lameter15316ba2006-01-08 01:00:43 -08003132 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003133 struct work_struct *work = per_cpu_ptr(works, cpu);
3134
3135 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003136 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003137 }
Tejun Heo93981802009-11-17 14:06:20 -08003138
3139 for_each_online_cpu(cpu)
3140 flush_work(per_cpu_ptr(works, cpu));
3141
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003142 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003143 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003144 return 0;
3145}
3146
Alan Sterneef6a7d2010-02-12 17:39:21 +09003147/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003148 * execute_in_process_context - reliably execute the routine with user context
3149 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003150 * @ew: guaranteed storage for the execute work structure (must
3151 * be available when the work executes)
3152 *
3153 * Executes the function immediately if process context is available,
3154 * otherwise schedules the function for delayed execution.
3155 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003156 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003157 * 1 - function was scheduled for execution
3158 */
David Howells65f27f32006-11-22 14:55:48 +00003159int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003160{
3161 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003162 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003163 return 0;
3164 }
3165
David Howells65f27f32006-11-22 14:55:48 +00003166 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003167 schedule_work(&ew->work);
3168
3169 return 1;
3170}
3171EXPORT_SYMBOL_GPL(execute_in_process_context);
3172
Tejun Heo7a4e3442013-03-12 11:30:00 -07003173/**
3174 * free_workqueue_attrs - free a workqueue_attrs
3175 * @attrs: workqueue_attrs to free
3176 *
3177 * Undo alloc_workqueue_attrs().
3178 */
3179void free_workqueue_attrs(struct workqueue_attrs *attrs)
3180{
3181 if (attrs) {
3182 free_cpumask_var(attrs->cpumask);
3183 kfree(attrs);
3184 }
3185}
3186
3187/**
3188 * alloc_workqueue_attrs - allocate a workqueue_attrs
3189 * @gfp_mask: allocation mask to use
3190 *
3191 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003192 * return it.
3193 *
3194 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003195 */
3196struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3197{
3198 struct workqueue_attrs *attrs;
3199
3200 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3201 if (!attrs)
3202 goto fail;
3203 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3204 goto fail;
3205
Tejun Heo13e2e552013-04-01 11:23:31 -07003206 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003207 return attrs;
3208fail:
3209 free_workqueue_attrs(attrs);
3210 return NULL;
3211}
3212
Tejun Heo29c91e92013-03-12 11:30:03 -07003213static void copy_workqueue_attrs(struct workqueue_attrs *to,
3214 const struct workqueue_attrs *from)
3215{
3216 to->nice = from->nice;
3217 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003218 /*
3219 * Unlike hash and equality test, this function doesn't ignore
3220 * ->no_numa as it is used for both pool and wq attrs. Instead,
3221 * get_unbound_pool() explicitly clears ->no_numa after copying.
3222 */
3223 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003224}
3225
Tejun Heo29c91e92013-03-12 11:30:03 -07003226/* hash value of the content of @attr */
3227static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3228{
3229 u32 hash = 0;
3230
3231 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003232 hash = jhash(cpumask_bits(attrs->cpumask),
3233 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003234 return hash;
3235}
3236
3237/* content equality test */
3238static bool wqattrs_equal(const struct workqueue_attrs *a,
3239 const struct workqueue_attrs *b)
3240{
3241 if (a->nice != b->nice)
3242 return false;
3243 if (!cpumask_equal(a->cpumask, b->cpumask))
3244 return false;
3245 return true;
3246}
3247
Tejun Heo7a4e3442013-03-12 11:30:00 -07003248/**
3249 * init_worker_pool - initialize a newly zalloc'd worker_pool
3250 * @pool: worker_pool to initialize
3251 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303252 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003253 *
3254 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003255 * inside @pool proper are initialized and put_unbound_pool() can be called
3256 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003257 */
3258static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003259{
3260 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003261 pool->id = -1;
3262 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003263 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003264 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003265 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003266 INIT_LIST_HEAD(&pool->worklist);
3267 INIT_LIST_HEAD(&pool->idle_list);
3268 hash_init(pool->busy_hash);
3269
Kees Cook32a6c722017-10-16 15:58:25 -07003270 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003271
Kees Cook32a6c722017-10-16 15:58:25 -07003272 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003273
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003274 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003275 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003276
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003277 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003278 INIT_HLIST_NODE(&pool->hash_node);
3279 pool->refcnt = 1;
3280
3281 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003282 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3283 if (!pool->attrs)
3284 return -ENOMEM;
3285 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003286}
3287
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003288static void rcu_free_wq(struct rcu_head *rcu)
3289{
3290 struct workqueue_struct *wq =
3291 container_of(rcu, struct workqueue_struct, rcu);
3292
3293 if (!(wq->flags & WQ_UNBOUND))
3294 free_percpu(wq->cpu_pwqs);
3295 else
3296 free_workqueue_attrs(wq->unbound_attrs);
3297
3298 kfree(wq->rescuer);
3299 kfree(wq);
3300}
3301
Tejun Heo29c91e92013-03-12 11:30:03 -07003302static void rcu_free_pool(struct rcu_head *rcu)
3303{
3304 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3305
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003306 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003307 free_workqueue_attrs(pool->attrs);
3308 kfree(pool);
3309}
3310
3311/**
3312 * put_unbound_pool - put a worker_pool
3313 * @pool: worker_pool to put
3314 *
3315 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003316 * safe manner. get_unbound_pool() calls this function on its failure path
3317 * and this function should be able to release pools which went through,
3318 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003319 *
3320 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003321 */
3322static void put_unbound_pool(struct worker_pool *pool)
3323{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003324 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003325 struct worker *worker;
3326
Tejun Heoa892cac2013-04-01 11:23:32 -07003327 lockdep_assert_held(&wq_pool_mutex);
3328
3329 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003330 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003331
3332 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003333 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003334 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003335 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003336
3337 /* release id and unhash */
3338 if (pool->id >= 0)
3339 idr_remove(&worker_pool_idr, pool->id);
3340 hash_del(&pool->hash_node);
3341
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003342 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003343 * Become the manager and destroy all workers. This prevents
3344 * @pool's workers from blocking on attach_mutex. We're the last
3345 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003346 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003347 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003348 wait_event_lock_irq(wq_manager_wait,
3349 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3350 pool->flags |= POOL_MANAGER_ACTIVE;
3351
Lai Jiangshan1037de32014-05-22 16:44:07 +08003352 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003353 destroy_worker(worker);
3354 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003355 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003356
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003357 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003358 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003359 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003360 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003361
3362 if (pool->detach_completion)
3363 wait_for_completion(pool->detach_completion);
3364
Tejun Heo29c91e92013-03-12 11:30:03 -07003365 /* shut down the timers */
3366 del_timer_sync(&pool->idle_timer);
3367 del_timer_sync(&pool->mayday_timer);
3368
3369 /* sched-RCU protected to allow dereferences from get_work_pool() */
3370 call_rcu_sched(&pool->rcu, rcu_free_pool);
3371}
3372
3373/**
3374 * get_unbound_pool - get a worker_pool with the specified attributes
3375 * @attrs: the attributes of the worker_pool to get
3376 *
3377 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3378 * reference count and return it. If there already is a matching
3379 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003380 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003381 *
3382 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003383 *
3384 * Return: On success, a worker_pool with the same attributes as @attrs.
3385 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003386 */
3387static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3388{
Tejun Heo29c91e92013-03-12 11:30:03 -07003389 u32 hash = wqattrs_hash(attrs);
3390 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003391 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003392 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003393
Tejun Heoa892cac2013-04-01 11:23:32 -07003394 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003395
3396 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003397 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3398 if (wqattrs_equal(pool->attrs, attrs)) {
3399 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003400 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003401 }
3402 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003403
Xunlei Pange22735842015-10-09 11:53:12 +08003404 /* if cpumask is contained inside a NUMA node, we belong to that node */
3405 if (wq_numa_enabled) {
3406 for_each_node(node) {
3407 if (cpumask_subset(attrs->cpumask,
3408 wq_numa_possible_cpumask[node])) {
3409 target_node = node;
3410 break;
3411 }
3412 }
3413 }
3414
Tejun Heo29c91e92013-03-12 11:30:03 -07003415 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003416 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003417 if (!pool || init_worker_pool(pool) < 0)
3418 goto fail;
3419
Tejun Heo8864b4e2013-03-12 11:30:04 -07003420 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003421 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003422 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003423
Shaohua Li2865a8f2013-08-01 09:56:36 +08003424 /*
3425 * no_numa isn't a worker_pool attribute, always clear it. See
3426 * 'struct workqueue_attrs' comments for detail.
3427 */
3428 pool->attrs->no_numa = false;
3429
Tejun Heo29c91e92013-03-12 11:30:03 -07003430 if (worker_pool_assign_id(pool) < 0)
3431 goto fail;
3432
3433 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003434 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003435 goto fail;
3436
Tejun Heo29c91e92013-03-12 11:30:03 -07003437 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003438 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003439
Tejun Heo29c91e92013-03-12 11:30:03 -07003440 return pool;
3441fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003442 if (pool)
3443 put_unbound_pool(pool);
3444 return NULL;
3445}
3446
Tejun Heo8864b4e2013-03-12 11:30:04 -07003447static void rcu_free_pwq(struct rcu_head *rcu)
3448{
3449 kmem_cache_free(pwq_cache,
3450 container_of(rcu, struct pool_workqueue, rcu));
3451}
3452
3453/*
3454 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3455 * and needs to be destroyed.
3456 */
3457static void pwq_unbound_release_workfn(struct work_struct *work)
3458{
3459 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3460 unbound_release_work);
3461 struct workqueue_struct *wq = pwq->wq;
3462 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003463 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003464
3465 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3466 return;
3467
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003468 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003469 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003470 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003471 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003472
Tejun Heoa892cac2013-04-01 11:23:32 -07003473 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003474 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003475 mutex_unlock(&wq_pool_mutex);
3476
Tejun Heo8864b4e2013-03-12 11:30:04 -07003477 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3478
3479 /*
3480 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003481 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003482 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003483 if (is_last)
3484 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003485}
3486
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003487/**
Tejun Heo699ce092013-03-13 16:51:35 -07003488 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003489 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003490 *
Tejun Heo699ce092013-03-13 16:51:35 -07003491 * If @pwq isn't freezing, set @pwq->max_active to the associated
3492 * workqueue's saved_max_active and activate delayed work items
3493 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003494 */
Tejun Heo699ce092013-03-13 16:51:35 -07003495static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003496{
Tejun Heo699ce092013-03-13 16:51:35 -07003497 struct workqueue_struct *wq = pwq->wq;
3498 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003499 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003500
Tejun Heo699ce092013-03-13 16:51:35 -07003501 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003502 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003503
3504 /* fast exit for non-freezable wqs */
3505 if (!freezable && pwq->max_active == wq->saved_max_active)
3506 return;
3507
Tejun Heo3347fa02016-09-16 15:49:32 -04003508 /* this function can be called during early boot w/ irq disabled */
3509 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003510
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003511 /*
3512 * During [un]freezing, the caller is responsible for ensuring that
3513 * this function is called at least once after @workqueue_freezing
3514 * is updated and visible.
3515 */
3516 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003517 pwq->max_active = wq->saved_max_active;
3518
3519 while (!list_empty(&pwq->delayed_works) &&
3520 pwq->nr_active < pwq->max_active)
3521 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003522
3523 /*
3524 * Need to kick a worker after thawed or an unbound wq's
3525 * max_active is bumped. It's a slow path. Do it always.
3526 */
3527 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003528 } else {
3529 pwq->max_active = 0;
3530 }
3531
Tejun Heo3347fa02016-09-16 15:49:32 -04003532 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003533}
3534
Tejun Heoe50aba92013-04-01 11:23:35 -07003535/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003536static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3537 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003538{
3539 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3540
Tejun Heoe50aba92013-04-01 11:23:35 -07003541 memset(pwq, 0, sizeof(*pwq));
3542
Tejun Heod2c1d402013-03-12 11:30:04 -07003543 pwq->pool = pool;
3544 pwq->wq = wq;
3545 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003546 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003547 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003548 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003549 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003550 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003551}
Tejun Heod2c1d402013-03-12 11:30:04 -07003552
Tejun Heof147f292013-04-01 11:23:35 -07003553/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003554static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003555{
3556 struct workqueue_struct *wq = pwq->wq;
3557
3558 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003559
Tejun Heo1befcf32013-04-01 11:23:35 -07003560 /* may be called multiple times, ignore if already linked */
3561 if (!list_empty(&pwq->pwqs_node))
3562 return;
3563
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003564 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003565 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003566
3567 /* sync max_active to the current setting */
3568 pwq_adjust_max_active(pwq);
3569
3570 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003571 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003572}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003573
Tejun Heof147f292013-04-01 11:23:35 -07003574/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3575static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3576 const struct workqueue_attrs *attrs)
3577{
3578 struct worker_pool *pool;
3579 struct pool_workqueue *pwq;
3580
3581 lockdep_assert_held(&wq_pool_mutex);
3582
3583 pool = get_unbound_pool(attrs);
3584 if (!pool)
3585 return NULL;
3586
Tejun Heoe50aba92013-04-01 11:23:35 -07003587 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003588 if (!pwq) {
3589 put_unbound_pool(pool);
3590 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003591 }
Tejun Heo6029a912013-04-01 11:23:34 -07003592
Tejun Heof147f292013-04-01 11:23:35 -07003593 init_pwq(pwq, wq, pool);
3594 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003595}
3596
Tejun Heo4c16bd32013-04-01 11:23:36 -07003597/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003598 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003599 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003600 * @node: the target NUMA node
3601 * @cpu_going_down: if >= 0, the CPU to consider as offline
3602 * @cpumask: outarg, the resulting cpumask
3603 *
3604 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3605 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003606 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003607 *
3608 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3609 * enabled and @node has online CPUs requested by @attrs, the returned
3610 * cpumask is the intersection of the possible CPUs of @node and
3611 * @attrs->cpumask.
3612 *
3613 * The caller is responsible for ensuring that the cpumask of @node stays
3614 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003615 *
3616 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3617 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003618 */
3619static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3620 int cpu_going_down, cpumask_t *cpumask)
3621{
Tejun Heod55262c2013-04-01 11:23:38 -07003622 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003623 goto use_dfl;
3624
3625 /* does @node have any online CPUs @attrs wants? */
3626 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3627 if (cpu_going_down >= 0)
3628 cpumask_clear_cpu(cpu_going_down, cpumask);
3629
3630 if (cpumask_empty(cpumask))
3631 goto use_dfl;
3632
3633 /* yeap, return possible CPUs in @node that @attrs wants */
3634 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003635
3636 if (cpumask_empty(cpumask)) {
3637 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3638 "possible intersect\n");
3639 return false;
3640 }
3641
Tejun Heo4c16bd32013-04-01 11:23:36 -07003642 return !cpumask_equal(cpumask, attrs->cpumask);
3643
3644use_dfl:
3645 cpumask_copy(cpumask, attrs->cpumask);
3646 return false;
3647}
3648
Tejun Heo1befcf32013-04-01 11:23:35 -07003649/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3650static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3651 int node,
3652 struct pool_workqueue *pwq)
3653{
3654 struct pool_workqueue *old_pwq;
3655
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003656 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003657 lockdep_assert_held(&wq->mutex);
3658
3659 /* link_pwq() can handle duplicate calls */
3660 link_pwq(pwq);
3661
3662 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3663 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3664 return old_pwq;
3665}
3666
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003667/* context to store the prepared attrs & pwqs before applying */
3668struct apply_wqattrs_ctx {
3669 struct workqueue_struct *wq; /* target workqueue */
3670 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003671 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003672 struct pool_workqueue *dfl_pwq;
3673 struct pool_workqueue *pwq_tbl[];
3674};
3675
3676/* free the resources after success or abort */
3677static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3678{
3679 if (ctx) {
3680 int node;
3681
3682 for_each_node(node)
3683 put_pwq_unlocked(ctx->pwq_tbl[node]);
3684 put_pwq_unlocked(ctx->dfl_pwq);
3685
3686 free_workqueue_attrs(ctx->attrs);
3687
3688 kfree(ctx);
3689 }
3690}
3691
3692/* allocate the attrs and pwqs for later installation */
3693static struct apply_wqattrs_ctx *
3694apply_wqattrs_prepare(struct workqueue_struct *wq,
3695 const struct workqueue_attrs *attrs)
3696{
3697 struct apply_wqattrs_ctx *ctx;
3698 struct workqueue_attrs *new_attrs, *tmp_attrs;
3699 int node;
3700
3701 lockdep_assert_held(&wq_pool_mutex);
3702
3703 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3704 GFP_KERNEL);
3705
3706 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3707 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3708 if (!ctx || !new_attrs || !tmp_attrs)
3709 goto out_free;
3710
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003711 /*
3712 * Calculate the attrs of the default pwq.
3713 * If the user configured cpumask doesn't overlap with the
3714 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3715 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003716 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003717 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003718 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3719 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003720
3721 /*
3722 * We may create multiple pwqs with differing cpumasks. Make a
3723 * copy of @new_attrs which will be modified and used to obtain
3724 * pools.
3725 */
3726 copy_workqueue_attrs(tmp_attrs, new_attrs);
3727
3728 /*
3729 * If something goes wrong during CPU up/down, we'll fall back to
3730 * the default pwq covering whole @attrs->cpumask. Always create
3731 * it even if we don't use it immediately.
3732 */
3733 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3734 if (!ctx->dfl_pwq)
3735 goto out_free;
3736
3737 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003738 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003739 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3740 if (!ctx->pwq_tbl[node])
3741 goto out_free;
3742 } else {
3743 ctx->dfl_pwq->refcnt++;
3744 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3745 }
3746 }
3747
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003748 /* save the user configured attrs and sanitize it. */
3749 copy_workqueue_attrs(new_attrs, attrs);
3750 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003751 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003752
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003753 ctx->wq = wq;
3754 free_workqueue_attrs(tmp_attrs);
3755 return ctx;
3756
3757out_free:
3758 free_workqueue_attrs(tmp_attrs);
3759 free_workqueue_attrs(new_attrs);
3760 apply_wqattrs_cleanup(ctx);
3761 return NULL;
3762}
3763
3764/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3765static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3766{
3767 int node;
3768
3769 /* all pwqs have been created successfully, let's install'em */
3770 mutex_lock(&ctx->wq->mutex);
3771
3772 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3773
3774 /* save the previous pwq and install the new one */
3775 for_each_node(node)
3776 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3777 ctx->pwq_tbl[node]);
3778
3779 /* @dfl_pwq might not have been used, ensure it's linked */
3780 link_pwq(ctx->dfl_pwq);
3781 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3782
3783 mutex_unlock(&ctx->wq->mutex);
3784}
3785
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003786static void apply_wqattrs_lock(void)
3787{
3788 /* CPUs should stay stable across pwq creations and installations */
3789 get_online_cpus();
3790 mutex_lock(&wq_pool_mutex);
3791}
3792
3793static void apply_wqattrs_unlock(void)
3794{
3795 mutex_unlock(&wq_pool_mutex);
3796 put_online_cpus();
3797}
3798
3799static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3800 const struct workqueue_attrs *attrs)
3801{
3802 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003803
3804 /* only unbound workqueues can change attributes */
3805 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3806 return -EINVAL;
3807
3808 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003809 if (!list_empty(&wq->pwqs)) {
3810 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3811 return -EINVAL;
3812
3813 wq->flags &= ~__WQ_ORDERED;
3814 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003815
3816 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003817 if (!ctx)
3818 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003819
3820 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003821 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003822 apply_wqattrs_cleanup(ctx);
3823
wanghaibin62011712016-01-07 20:38:59 +08003824 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003825}
3826
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003827/**
3828 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3829 * @wq: the target workqueue
3830 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3831 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003832 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3833 * machines, this function maps a separate pwq to each NUMA node with
3834 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3835 * NUMA node it was issued on. Older pwqs are released as in-flight work
3836 * items finish. Note that a work item which repeatedly requeues itself
3837 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003838 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003839 * Performs GFP_KERNEL allocations.
3840 *
3841 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003842 */
3843int apply_workqueue_attrs(struct workqueue_struct *wq,
3844 const struct workqueue_attrs *attrs)
3845{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003846 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003847
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003848 apply_wqattrs_lock();
3849 ret = apply_workqueue_attrs_locked(wq, attrs);
3850 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003851
Tejun Heo48621252013-04-01 11:23:31 -07003852 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003853}
NeilBrown6106c0f2018-01-11 15:06:40 +11003854EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003855
Tejun Heo4c16bd32013-04-01 11:23:36 -07003856/**
3857 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3858 * @wq: the target workqueue
3859 * @cpu: the CPU coming up or going down
3860 * @online: whether @cpu is coming up or going down
3861 *
3862 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3863 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3864 * @wq accordingly.
3865 *
3866 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3867 * falls back to @wq->dfl_pwq which may not be optimal but is always
3868 * correct.
3869 *
3870 * Note that when the last allowed CPU of a NUMA node goes offline for a
3871 * workqueue with a cpumask spanning multiple nodes, the workers which were
3872 * already executing the work items for the workqueue will lose their CPU
3873 * affinity and may execute on any CPU. This is similar to how per-cpu
3874 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3875 * affinity, it's the user's responsibility to flush the work item from
3876 * CPU_DOWN_PREPARE.
3877 */
3878static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3879 bool online)
3880{
3881 int node = cpu_to_node(cpu);
3882 int cpu_off = online ? -1 : cpu;
3883 struct pool_workqueue *old_pwq = NULL, *pwq;
3884 struct workqueue_attrs *target_attrs;
3885 cpumask_t *cpumask;
3886
3887 lockdep_assert_held(&wq_pool_mutex);
3888
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003889 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3890 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003891 return;
3892
3893 /*
3894 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3895 * Let's use a preallocated one. The following buf is protected by
3896 * CPU hotplug exclusion.
3897 */
3898 target_attrs = wq_update_unbound_numa_attrs_buf;
3899 cpumask = target_attrs->cpumask;
3900
Tejun Heo4c16bd32013-04-01 11:23:36 -07003901 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3902 pwq = unbound_pwq_by_node(wq, node);
3903
3904 /*
3905 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003906 * different from the default pwq's, we need to compare it to @pwq's
3907 * and create a new one if they don't match. If the target cpumask
3908 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003909 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003910 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003911 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003912 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003913 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003914 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003915 }
3916
Tejun Heo4c16bd32013-04-01 11:23:36 -07003917 /* create a new pwq */
3918 pwq = alloc_unbound_pwq(wq, target_attrs);
3919 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003920 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3921 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003922 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003923 }
3924
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003925 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003926 mutex_lock(&wq->mutex);
3927 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3928 goto out_unlock;
3929
3930use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003931 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003932 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3933 get_pwq(wq->dfl_pwq);
3934 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3935 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3936out_unlock:
3937 mutex_unlock(&wq->mutex);
3938 put_pwq_unlocked(old_pwq);
3939}
3940
Tejun Heo30cdf2492013-03-12 11:29:57 -07003941static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003942{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003943 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003944 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003945
Tejun Heo30cdf2492013-03-12 11:29:57 -07003946 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003947 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3948 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003949 return -ENOMEM;
3950
3951 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003952 struct pool_workqueue *pwq =
3953 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003954 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003955 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003956
Tejun Heof147f292013-04-01 11:23:35 -07003957 init_pwq(pwq, wq, &cpu_pools[highpri]);
3958
3959 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003960 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003961 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003962 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003963 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003964 } else if (wq->flags & __WQ_ORDERED) {
3965 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3966 /* there should only be single pwq for ordering guarantee */
3967 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3968 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3969 "ordering guarantee broken for workqueue %s\n", wq->name);
3970 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07003971 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003972 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003973 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003974}
3975
Tejun Heof3421792010-07-02 10:03:51 +02003976static int wq_clamp_max_active(int max_active, unsigned int flags,
3977 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003978{
Tejun Heof3421792010-07-02 10:03:51 +02003979 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3980
3981 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003982 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3983 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003984
Tejun Heof3421792010-07-02 10:03:51 +02003985 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003986}
3987
Tejun Heo983c7512018-01-08 05:38:32 -08003988/*
3989 * Workqueues which may be used during memory reclaim should have a rescuer
3990 * to guarantee forward progress.
3991 */
3992static int init_rescuer(struct workqueue_struct *wq)
3993{
3994 struct worker *rescuer;
3995 int ret;
3996
3997 if (!(wq->flags & WQ_MEM_RECLAIM))
3998 return 0;
3999
4000 rescuer = alloc_worker(NUMA_NO_NODE);
4001 if (!rescuer)
4002 return -ENOMEM;
4003
4004 rescuer->rescue_wq = wq;
4005 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4006 ret = PTR_ERR_OR_ZERO(rescuer->task);
4007 if (ret) {
4008 kfree(rescuer);
4009 return ret;
4010 }
4011
4012 wq->rescuer = rescuer;
4013 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4014 wake_up_process(rescuer->task);
4015
4016 return 0;
4017}
4018
Tejun Heob196be82012-01-10 15:11:35 -08004019struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004020 unsigned int flags,
4021 int max_active,
4022 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004023 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004024{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004025 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004026 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004027 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004028 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004029
Tejun Heo5c0338c2017-07-18 18:41:52 -04004030 /*
4031 * Unbound && max_active == 1 used to imply ordered, which is no
4032 * longer the case on NUMA machines due to per-node pools. While
4033 * alloc_ordered_workqueue() is the right way to create an ordered
4034 * workqueue, keep the previous behavior to avoid subtle breakages
4035 * on NUMA.
4036 */
4037 if ((flags & WQ_UNBOUND) && max_active == 1)
4038 flags |= __WQ_ORDERED;
4039
Viresh Kumarcee22a12013-04-08 16:45:40 +05304040 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4041 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4042 flags |= WQ_UNBOUND;
4043
Tejun Heoecf68812013-04-01 11:23:34 -07004044 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004045 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004046 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004047
4048 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004049 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004050 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004051
Tejun Heo6029a912013-04-01 11:23:34 -07004052 if (flags & WQ_UNBOUND) {
4053 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4054 if (!wq->unbound_attrs)
4055 goto err_free_wq;
4056 }
4057
Tejun Heoecf68812013-04-01 11:23:34 -07004058 va_start(args, lock_name);
4059 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004060 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004061
Tejun Heod320c032010-06-29 10:07:14 +02004062 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004063 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004064
Tejun Heob196be82012-01-10 15:11:35 -08004065 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004066 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004067 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004068 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004069 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004070 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004071 INIT_LIST_HEAD(&wq->flusher_queue);
4072 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004073 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004074
Johannes Bergeb13ba82008-01-16 09:51:58 +01004075 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004076 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004077
Tejun Heo30cdf2492013-03-12 11:29:57 -07004078 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004079 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004080
Tejun Heo40c17f72018-01-08 05:38:37 -08004081 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004082 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004083
Tejun Heo226223a2013-03-12 11:30:05 -07004084 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4085 goto err_destroy;
4086
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004087 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004088 * wq_pool_mutex protects global freeze state and workqueues list.
4089 * Grab it, adjust max_active and add the new @wq to workqueues
4090 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004091 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004092 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004093
Lai Jiangshana357fc02013-03-25 16:57:19 -07004094 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004095 for_each_pwq(pwq, wq)
4096 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004097 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004098
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004099 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004100
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004101 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004102
Oleg Nesterov3af244332007-05-09 02:34:09 -07004103 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004104
4105err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004106 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004107 kfree(wq);
4108 return NULL;
4109err_destroy:
4110 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004111 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004112}
Tejun Heod320c032010-06-29 10:07:14 +02004113EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004114
4115/**
4116 * destroy_workqueue - safely terminate a workqueue
4117 * @wq: target workqueue
4118 *
4119 * Safely destroy a workqueue. All work currently pending will be done first.
4120 */
4121void destroy_workqueue(struct workqueue_struct *wq)
4122{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004123 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004124 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004125
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004126 /* drain it before proceeding with destruction */
4127 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004128
Tejun Heo6183c002013-03-12 11:29:57 -07004129 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004130 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004131 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004132 int i;
4133
Tejun Heo76af4d92013-03-12 11:30:00 -07004134 for (i = 0; i < WORK_NR_COLORS; i++) {
4135 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004136 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004137 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004138 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004139 }
4140 }
4141
Lai Jiangshan5c529592013-04-04 10:05:38 +08004142 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004143 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004144 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004145 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004146 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004147 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004148 }
Tejun Heo6183c002013-03-12 11:29:57 -07004149 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004150 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004151
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004152 /*
4153 * wq list is used to freeze wq, remove from list after
4154 * flushing is complete in case freeze races us.
4155 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004156 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004157 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004158 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004159
Tejun Heo226223a2013-03-12 11:30:05 -07004160 workqueue_sysfs_unregister(wq);
4161
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004162 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004163 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004164
Tejun Heo8864b4e2013-03-12 11:30:04 -07004165 if (!(wq->flags & WQ_UNBOUND)) {
4166 /*
4167 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004168 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004169 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004170 call_rcu_sched(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004171 } else {
4172 /*
4173 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004174 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4175 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004176 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004177 for_each_node(node) {
4178 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4179 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4180 put_pwq_unlocked(pwq);
4181 }
4182
4183 /*
4184 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4185 * put. Don't access it afterwards.
4186 */
4187 pwq = wq->dfl_pwq;
4188 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004189 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004190 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004191}
4192EXPORT_SYMBOL_GPL(destroy_workqueue);
4193
Tejun Heodcd989c2010-06-29 10:07:14 +02004194/**
4195 * workqueue_set_max_active - adjust max_active of a workqueue
4196 * @wq: target workqueue
4197 * @max_active: new max_active value.
4198 *
4199 * Set max_active of @wq to @max_active.
4200 *
4201 * CONTEXT:
4202 * Don't call from IRQ context.
4203 */
4204void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4205{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004206 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004207
Tejun Heo8719dce2013-03-12 11:30:04 -07004208 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004209 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004210 return;
4211
Tejun Heof3421792010-07-02 10:03:51 +02004212 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004213
Lai Jiangshana357fc02013-03-25 16:57:19 -07004214 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004215
Tejun Heo0a94efb2017-07-23 08:36:15 -04004216 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004217 wq->saved_max_active = max_active;
4218
Tejun Heo699ce092013-03-13 16:51:35 -07004219 for_each_pwq(pwq, wq)
4220 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004221
Lai Jiangshana357fc02013-03-25 16:57:19 -07004222 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004223}
4224EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4225
4226/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004227 * current_work - retrieve %current task's work struct
4228 *
4229 * Determine if %current task is a workqueue worker and what it's working on.
4230 * Useful to find out the context that the %current task is running in.
4231 *
4232 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4233 */
4234struct work_struct *current_work(void)
4235{
4236 struct worker *worker = current_wq_worker();
4237
4238 return worker ? worker->current_work : NULL;
4239}
4240EXPORT_SYMBOL(current_work);
4241
4242/**
Tejun Heoe62676162013-03-12 17:41:37 -07004243 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4244 *
4245 * Determine whether %current is a workqueue rescuer. Can be used from
4246 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004247 *
4248 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004249 */
4250bool current_is_workqueue_rescuer(void)
4251{
4252 struct worker *worker = current_wq_worker();
4253
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004254 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004255}
4256
4257/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004258 * workqueue_congested - test whether a workqueue is congested
4259 * @cpu: CPU in question
4260 * @wq: target workqueue
4261 *
4262 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4263 * no synchronization around this function and the test result is
4264 * unreliable and only useful as advisory hints or for debugging.
4265 *
Tejun Heod3251852013-05-10 11:10:17 -07004266 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4267 * Note that both per-cpu and unbound workqueues may be associated with
4268 * multiple pool_workqueues which have separate congested states. A
4269 * workqueue being congested on one CPU doesn't mean the workqueue is also
4270 * contested on other CPUs / NUMA nodes.
4271 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004272 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004273 * %true if congested, %false otherwise.
4274 */
Tejun Heod84ff052013-03-12 11:29:59 -07004275bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004276{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004277 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004278 bool ret;
4279
Lai Jiangshan88109452013-03-20 03:28:10 +08004280 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004281
Tejun Heod3251852013-05-10 11:10:17 -07004282 if (cpu == WORK_CPU_UNBOUND)
4283 cpu = smp_processor_id();
4284
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004285 if (!(wq->flags & WQ_UNBOUND))
4286 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4287 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004288 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004289
Tejun Heo76af4d92013-03-12 11:30:00 -07004290 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004291 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004292
4293 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004294}
4295EXPORT_SYMBOL_GPL(workqueue_congested);
4296
4297/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004298 * work_busy - test whether a work is currently pending or running
4299 * @work: the work to be tested
4300 *
4301 * Test whether @work is currently pending or running. There is no
4302 * synchronization around this function and the test result is
4303 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004304 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004305 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004306 * OR'd bitmask of WORK_BUSY_* bits.
4307 */
4308unsigned int work_busy(struct work_struct *work)
4309{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004310 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004311 unsigned long flags;
4312 unsigned int ret = 0;
4313
Tejun Heodcd989c2010-06-29 10:07:14 +02004314 if (work_pending(work))
4315 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004316
Tejun Heofa1b54e2013-03-12 11:30:00 -07004317 local_irq_save(flags);
4318 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004319 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004320 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004321 if (find_worker_executing_work(pool, work))
4322 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004323 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004324 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004325 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004326
4327 return ret;
4328}
4329EXPORT_SYMBOL_GPL(work_busy);
4330
Tejun Heo3d1cb202013-04-30 15:27:22 -07004331/**
4332 * set_worker_desc - set description for the current work item
4333 * @fmt: printf-style format string
4334 * @...: arguments for the format string
4335 *
4336 * This function can be called by a running work function to describe what
4337 * the work item is about. If the worker task gets dumped, this
4338 * information will be printed out together to help debugging. The
4339 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4340 */
4341void set_worker_desc(const char *fmt, ...)
4342{
4343 struct worker *worker = current_wq_worker();
4344 va_list args;
4345
4346 if (worker) {
4347 va_start(args, fmt);
4348 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4349 va_end(args);
4350 worker->desc_valid = true;
4351 }
4352}
Steffen Maier5c750d52018-05-17 19:14:57 +02004353EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004354
4355/**
4356 * print_worker_info - print out worker information and description
4357 * @log_lvl: the log level to use when printing
4358 * @task: target task
4359 *
4360 * If @task is a worker and currently executing a work item, print out the
4361 * name of the workqueue being serviced and worker description set with
4362 * set_worker_desc() by the currently executing work item.
4363 *
4364 * This function can be safely called on any task as long as the
4365 * task_struct itself is accessible. While safe, this function isn't
4366 * synchronized and may print out mixups or garbages of limited length.
4367 */
4368void print_worker_info(const char *log_lvl, struct task_struct *task)
4369{
4370 work_func_t *fn = NULL;
4371 char name[WQ_NAME_LEN] = { };
4372 char desc[WORKER_DESC_LEN] = { };
4373 struct pool_workqueue *pwq = NULL;
4374 struct workqueue_struct *wq = NULL;
4375 bool desc_valid = false;
4376 struct worker *worker;
4377
4378 if (!(task->flags & PF_WQ_WORKER))
4379 return;
4380
4381 /*
4382 * This function is called without any synchronization and @task
4383 * could be in any state. Be careful with dereferences.
4384 */
Petr Mladeke7005912016-10-11 13:55:17 -07004385 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004386
4387 /*
4388 * Carefully copy the associated workqueue's workfn and name. Keep
4389 * the original last '\0' in case the original contains garbage.
4390 */
4391 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4392 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4393 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4394 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4395
4396 /* copy worker description */
4397 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4398 if (desc_valid)
4399 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4400
4401 if (fn || name[0] || desc[0]) {
4402 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4403 if (desc[0])
4404 pr_cont(" (%s)", desc);
4405 pr_cont("\n");
4406 }
4407}
4408
Tejun Heo3494fc32015-03-09 09:22:28 -04004409static void pr_cont_pool_info(struct worker_pool *pool)
4410{
4411 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4412 if (pool->node != NUMA_NO_NODE)
4413 pr_cont(" node=%d", pool->node);
4414 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4415}
4416
4417static void pr_cont_work(bool comma, struct work_struct *work)
4418{
4419 if (work->func == wq_barrier_func) {
4420 struct wq_barrier *barr;
4421
4422 barr = container_of(work, struct wq_barrier, work);
4423
4424 pr_cont("%s BAR(%d)", comma ? "," : "",
4425 task_pid_nr(barr->task));
4426 } else {
4427 pr_cont("%s %pf", comma ? "," : "", work->func);
4428 }
4429}
4430
4431static void show_pwq(struct pool_workqueue *pwq)
4432{
4433 struct worker_pool *pool = pwq->pool;
4434 struct work_struct *work;
4435 struct worker *worker;
4436 bool has_in_flight = false, has_pending = false;
4437 int bkt;
4438
4439 pr_info(" pwq %d:", pool->id);
4440 pr_cont_pool_info(pool);
4441
4442 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4443 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4444
4445 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4446 if (worker->current_pwq == pwq) {
4447 has_in_flight = true;
4448 break;
4449 }
4450 }
4451 if (has_in_flight) {
4452 bool comma = false;
4453
4454 pr_info(" in-flight:");
4455 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4456 if (worker->current_pwq != pwq)
4457 continue;
4458
4459 pr_cont("%s %d%s:%pf", comma ? "," : "",
4460 task_pid_nr(worker->task),
4461 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4462 worker->current_func);
4463 list_for_each_entry(work, &worker->scheduled, entry)
4464 pr_cont_work(false, work);
4465 comma = true;
4466 }
4467 pr_cont("\n");
4468 }
4469
4470 list_for_each_entry(work, &pool->worklist, entry) {
4471 if (get_work_pwq(work) == pwq) {
4472 has_pending = true;
4473 break;
4474 }
4475 }
4476 if (has_pending) {
4477 bool comma = false;
4478
4479 pr_info(" pending:");
4480 list_for_each_entry(work, &pool->worklist, entry) {
4481 if (get_work_pwq(work) != pwq)
4482 continue;
4483
4484 pr_cont_work(comma, work);
4485 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4486 }
4487 pr_cont("\n");
4488 }
4489
4490 if (!list_empty(&pwq->delayed_works)) {
4491 bool comma = false;
4492
4493 pr_info(" delayed:");
4494 list_for_each_entry(work, &pwq->delayed_works, entry) {
4495 pr_cont_work(comma, work);
4496 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4497 }
4498 pr_cont("\n");
4499 }
4500}
4501
4502/**
4503 * show_workqueue_state - dump workqueue state
4504 *
Roger Lu7b776af2016-07-01 11:05:02 +08004505 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4506 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004507 */
4508void show_workqueue_state(void)
4509{
4510 struct workqueue_struct *wq;
4511 struct worker_pool *pool;
4512 unsigned long flags;
4513 int pi;
4514
4515 rcu_read_lock_sched();
4516
4517 pr_info("Showing busy workqueues and worker pools:\n");
4518
4519 list_for_each_entry_rcu(wq, &workqueues, list) {
4520 struct pool_workqueue *pwq;
4521 bool idle = true;
4522
4523 for_each_pwq(pwq, wq) {
4524 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4525 idle = false;
4526 break;
4527 }
4528 }
4529 if (idle)
4530 continue;
4531
4532 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4533
4534 for_each_pwq(pwq, wq) {
4535 spin_lock_irqsave(&pwq->pool->lock, flags);
4536 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4537 show_pwq(pwq);
4538 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004539 /*
4540 * We could be printing a lot from atomic context, e.g.
4541 * sysrq-t -> show_workqueue_state(). Avoid triggering
4542 * hard lockup.
4543 */
4544 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004545 }
4546 }
4547
4548 for_each_pool(pool, pi) {
4549 struct worker *worker;
4550 bool first = true;
4551
4552 spin_lock_irqsave(&pool->lock, flags);
4553 if (pool->nr_workers == pool->nr_idle)
4554 goto next_pool;
4555
4556 pr_info("pool %d:", pool->id);
4557 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004558 pr_cont(" hung=%us workers=%d",
4559 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4560 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004561 if (pool->manager)
4562 pr_cont(" manager: %d",
4563 task_pid_nr(pool->manager->task));
4564 list_for_each_entry(worker, &pool->idle_list, entry) {
4565 pr_cont(" %s%d", first ? "idle: " : "",
4566 task_pid_nr(worker->task));
4567 first = false;
4568 }
4569 pr_cont("\n");
4570 next_pool:
4571 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004572 /*
4573 * We could be printing a lot from atomic context, e.g.
4574 * sysrq-t -> show_workqueue_state(). Avoid triggering
4575 * hard lockup.
4576 */
4577 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004578 }
4579
4580 rcu_read_unlock_sched();
4581}
4582
Tejun Heodb7bccf2010-06-29 10:07:12 +02004583/*
4584 * CPU hotplug.
4585 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004586 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004587 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004588 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004589 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004590 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004591 * blocked draining impractical.
4592 *
Tejun Heo24647572013-01-24 11:01:33 -08004593 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004594 * running as an unbound one and allowing it to be reattached later if the
4595 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004596 */
4597
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004598static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004599{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004600 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004601 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004602
Tejun Heof02ae732013-03-12 11:30:03 -07004603 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004604 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004605 spin_lock_irq(&pool->lock);
4606
4607 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004608 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004609 * unbound and set DISASSOCIATED. Before this, all workers
4610 * except for the ones which are still executing works from
4611 * before the last CPU down must be on the cpu. After
4612 * this, they may become diasporas.
4613 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004614 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004615 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004616
Tejun Heo24647572013-01-24 11:01:33 -08004617 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004618
Tejun Heo94cf58b2013-01-24 11:01:33 -08004619 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004620 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004621
Lai Jiangshaneb283422013-03-08 15:18:28 -08004622 /*
4623 * Call schedule() so that we cross rq->lock and thus can
4624 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4625 * This is necessary as scheduler callbacks may be invoked
4626 * from other cpus.
4627 */
4628 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004629
Lai Jiangshaneb283422013-03-08 15:18:28 -08004630 /*
4631 * Sched callbacks are disabled now. Zap nr_running.
4632 * After this, nr_running stays zero and need_more_worker()
4633 * and keep_working() are always true as long as the
4634 * worklist is not empty. This pool now behaves as an
4635 * unbound (in terms of concurrency management) pool which
4636 * are served by workers tied to the pool.
4637 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004638 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004639
4640 /*
4641 * With concurrency management just turned off, a busy
4642 * worker blocking could lead to lengthy stalls. Kick off
4643 * unbound chain execution of currently pending work items.
4644 */
4645 spin_lock_irq(&pool->lock);
4646 wake_up_worker(pool);
4647 spin_unlock_irq(&pool->lock);
4648 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004649}
4650
Tejun Heobd7c0892013-03-19 13:45:21 -07004651/**
4652 * rebind_workers - rebind all workers of a pool to the associated CPU
4653 * @pool: pool of interest
4654 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004655 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004656 */
4657static void rebind_workers(struct worker_pool *pool)
4658{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004659 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004660
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004661 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004662
Tejun Heoa9ab7752013-03-19 13:45:21 -07004663 /*
4664 * Restore CPU affinity of all workers. As all idle workers should
4665 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304666 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004667 * of all workers first and then clear UNBOUND. As we're called
4668 * from CPU_ONLINE, the following shouldn't fail.
4669 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004670 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004671 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4672 pool->attrs->cpumask) < 0);
4673
4674 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004675
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004676 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004677
Lai Jiangshanda028462014-05-20 17:46:31 +08004678 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004679 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004680
4681 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004682 * A bound idle worker should actually be on the runqueue
4683 * of the associated CPU for local wake-ups targeting it to
4684 * work. Kick all idle workers so that they migrate to the
4685 * associated CPU. Doing this in the same loop as
4686 * replacing UNBOUND with REBOUND is safe as no worker will
4687 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004688 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004689 if (worker_flags & WORKER_IDLE)
4690 wake_up_process(worker->task);
4691
4692 /*
4693 * We want to clear UNBOUND but can't directly call
4694 * worker_clr_flags() or adjust nr_running. Atomically
4695 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4696 * @worker will clear REBOUND using worker_clr_flags() when
4697 * it initiates the next execution cycle thus restoring
4698 * concurrency management. Note that when or whether
4699 * @worker clears REBOUND doesn't affect correctness.
4700 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004701 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004702 * tested without holding any lock in
4703 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4704 * fail incorrectly leading to premature concurrency
4705 * management operations.
4706 */
4707 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4708 worker_flags |= WORKER_REBOUND;
4709 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004710 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004711 }
4712
Tejun Heoa9ab7752013-03-19 13:45:21 -07004713 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004714}
4715
Tejun Heo7dbc7252013-03-19 13:45:21 -07004716/**
4717 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4718 * @pool: unbound pool of interest
4719 * @cpu: the CPU which is coming up
4720 *
4721 * An unbound pool may end up with a cpumask which doesn't have any online
4722 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4723 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4724 * online CPU before, cpus_allowed of all its workers should be restored.
4725 */
4726static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4727{
4728 static cpumask_t cpumask;
4729 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004730
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004731 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004732
4733 /* is @cpu allowed for @pool? */
4734 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4735 return;
4736
Tejun Heo7dbc7252013-03-19 13:45:21 -07004737 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004738
4739 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004740 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004741 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004742}
4743
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004744int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004745{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004746 struct worker_pool *pool;
4747
4748 for_each_cpu_worker_pool(pool, cpu) {
4749 if (pool->nr_workers)
4750 continue;
4751 if (!create_worker(pool))
4752 return -ENOMEM;
4753 }
4754 return 0;
4755}
4756
4757int workqueue_online_cpu(unsigned int cpu)
4758{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004759 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004760 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004761 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004762
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004763 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004764
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004765 for_each_pool(pool, pi) {
4766 mutex_lock(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004767
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004768 if (pool->cpu == cpu)
4769 rebind_workers(pool);
4770 else if (pool->cpu < 0)
4771 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004772
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004773 mutex_unlock(&pool->attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004774 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004775
4776 /* update NUMA affinity of unbound workqueues */
4777 list_for_each_entry(wq, &workqueues, list)
4778 wq_update_unbound_numa(wq, cpu, true);
4779
4780 mutex_unlock(&wq_pool_mutex);
4781 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004782}
4783
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004784int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004785{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004786 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004787
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004788 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004789 if (WARN_ON(cpu != smp_processor_id()))
4790 return -1;
4791
4792 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004793
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004794 /* update NUMA affinity of unbound workqueues */
4795 mutex_lock(&wq_pool_mutex);
4796 list_for_each_entry(wq, &workqueues, list)
4797 wq_update_unbound_numa(wq, cpu, false);
4798 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004799
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004800 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004801}
4802
Rusty Russell2d3854a2008-11-05 13:39:10 +11004803#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004804
Rusty Russell2d3854a2008-11-05 13:39:10 +11004805struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004806 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004807 long (*fn)(void *);
4808 void *arg;
4809 long ret;
4810};
4811
Tejun Heoed48ece2012-09-18 12:48:43 -07004812static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004813{
Tejun Heoed48ece2012-09-18 12:48:43 -07004814 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4815
Rusty Russell2d3854a2008-11-05 13:39:10 +11004816 wfc->ret = wfc->fn(wfc->arg);
4817}
4818
4819/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004820 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004821 * @cpu: the cpu to run on
4822 * @fn: the function to run
4823 * @arg: the function arg
4824 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004825 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004826 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004827 *
4828 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004829 */
Tejun Heod84ff052013-03-12 11:29:59 -07004830long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004831{
Tejun Heoed48ece2012-09-18 12:48:43 -07004832 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004833
Tejun Heoed48ece2012-09-18 12:48:43 -07004834 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4835 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004836 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004837 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004838 return wfc.ret;
4839}
4840EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004841
4842/**
4843 * work_on_cpu_safe - run a function in thread context on a particular cpu
4844 * @cpu: the cpu to run on
4845 * @fn: the function to run
4846 * @arg: the function argument
4847 *
4848 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4849 * any locks which would prevent @fn from completing.
4850 *
4851 * Return: The value @fn returns.
4852 */
4853long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4854{
4855 long ret = -ENODEV;
4856
4857 get_online_cpus();
4858 if (cpu_online(cpu))
4859 ret = work_on_cpu(cpu, fn, arg);
4860 put_online_cpus();
4861 return ret;
4862}
4863EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004864#endif /* CONFIG_SMP */
4865
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004866#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304867
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004868/**
4869 * freeze_workqueues_begin - begin freezing workqueues
4870 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004871 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004872 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004873 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004874 *
4875 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004876 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004877 */
4878void freeze_workqueues_begin(void)
4879{
Tejun Heo24b8a842013-03-12 11:29:58 -07004880 struct workqueue_struct *wq;
4881 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004882
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004883 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004884
Tejun Heo6183c002013-03-12 11:29:57 -07004885 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004886 workqueue_freezing = true;
4887
Tejun Heo24b8a842013-03-12 11:29:58 -07004888 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004889 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004890 for_each_pwq(pwq, wq)
4891 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004892 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004893 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004894
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004895 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004896}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004897
4898/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004899 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004900 *
4901 * Check whether freezing is complete. This function must be called
4902 * between freeze_workqueues_begin() and thaw_workqueues().
4903 *
4904 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004905 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004906 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004907 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004908 * %true if some freezable workqueues are still busy. %false if freezing
4909 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004910 */
4911bool freeze_workqueues_busy(void)
4912{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004913 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004914 struct workqueue_struct *wq;
4915 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004916
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004917 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004918
Tejun Heo6183c002013-03-12 11:29:57 -07004919 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004920
Tejun Heo24b8a842013-03-12 11:29:58 -07004921 list_for_each_entry(wq, &workqueues, list) {
4922 if (!(wq->flags & WQ_FREEZABLE))
4923 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004924 /*
4925 * nr_active is monotonically decreasing. It's safe
4926 * to peek without lock.
4927 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004928 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004929 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004930 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004931 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004932 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004933 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004934 goto out_unlock;
4935 }
4936 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004937 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004938 }
4939out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004940 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004941 return busy;
4942}
4943
4944/**
4945 * thaw_workqueues - thaw workqueues
4946 *
4947 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004948 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004949 *
4950 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004951 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004952 */
4953void thaw_workqueues(void)
4954{
Tejun Heo24b8a842013-03-12 11:29:58 -07004955 struct workqueue_struct *wq;
4956 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004957
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004958 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004959
4960 if (!workqueue_freezing)
4961 goto out_unlock;
4962
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004963 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004964
Tejun Heo24b8a842013-03-12 11:29:58 -07004965 /* restore max_active and repopulate worklist */
4966 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004967 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004968 for_each_pwq(pwq, wq)
4969 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004970 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004971 }
4972
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004973out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004974 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004975}
4976#endif /* CONFIG_FREEZER */
4977
Lai Jiangshan042f7df2015-04-30 17:16:12 +08004978static int workqueue_apply_unbound_cpumask(void)
4979{
4980 LIST_HEAD(ctxs);
4981 int ret = 0;
4982 struct workqueue_struct *wq;
4983 struct apply_wqattrs_ctx *ctx, *n;
4984
4985 lockdep_assert_held(&wq_pool_mutex);
4986
4987 list_for_each_entry(wq, &workqueues, list) {
4988 if (!(wq->flags & WQ_UNBOUND))
4989 continue;
4990 /* creating multiple pwqs breaks ordering guarantee */
4991 if (wq->flags & __WQ_ORDERED)
4992 continue;
4993
4994 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4995 if (!ctx) {
4996 ret = -ENOMEM;
4997 break;
4998 }
4999
5000 list_add_tail(&ctx->list, &ctxs);
5001 }
5002
5003 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5004 if (!ret)
5005 apply_wqattrs_commit(ctx);
5006 apply_wqattrs_cleanup(ctx);
5007 }
5008
5009 return ret;
5010}
5011
5012/**
5013 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5014 * @cpumask: the cpumask to set
5015 *
5016 * The low-level workqueues cpumask is a global cpumask that limits
5017 * the affinity of all unbound workqueues. This function check the @cpumask
5018 * and apply it to all unbound workqueues and updates all pwqs of them.
5019 *
5020 * Retun: 0 - Success
5021 * -EINVAL - Invalid @cpumask
5022 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5023 */
5024int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5025{
5026 int ret = -EINVAL;
5027 cpumask_var_t saved_cpumask;
5028
5029 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5030 return -ENOMEM;
5031
Tal Shorerc98a9802017-11-03 17:27:50 +02005032 /*
5033 * Not excluding isolated cpus on purpose.
5034 * If the user wishes to include them, we allow that.
5035 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005036 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5037 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005038 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005039
5040 /* save the old wq_unbound_cpumask. */
5041 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5042
5043 /* update wq_unbound_cpumask at first and apply it to wqs. */
5044 cpumask_copy(wq_unbound_cpumask, cpumask);
5045 ret = workqueue_apply_unbound_cpumask();
5046
5047 /* restore the wq_unbound_cpumask when failed. */
5048 if (ret < 0)
5049 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5050
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005051 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005052 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005053
5054 free_cpumask_var(saved_cpumask);
5055 return ret;
5056}
5057
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005058#ifdef CONFIG_SYSFS
5059/*
5060 * Workqueues with WQ_SYSFS flag set is visible to userland via
5061 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5062 * following attributes.
5063 *
5064 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5065 * max_active RW int : maximum number of in-flight work items
5066 *
5067 * Unbound workqueues have the following extra attributes.
5068 *
Wang Long9a19b462017-11-02 23:05:12 -04005069 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005070 * nice RW int : nice value of the workers
5071 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005072 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005073 */
5074struct wq_device {
5075 struct workqueue_struct *wq;
5076 struct device dev;
5077};
5078
5079static struct workqueue_struct *dev_to_wq(struct device *dev)
5080{
5081 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5082
5083 return wq_dev->wq;
5084}
5085
5086static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5087 char *buf)
5088{
5089 struct workqueue_struct *wq = dev_to_wq(dev);
5090
5091 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5092}
5093static DEVICE_ATTR_RO(per_cpu);
5094
5095static ssize_t max_active_show(struct device *dev,
5096 struct device_attribute *attr, char *buf)
5097{
5098 struct workqueue_struct *wq = dev_to_wq(dev);
5099
5100 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5101}
5102
5103static ssize_t max_active_store(struct device *dev,
5104 struct device_attribute *attr, const char *buf,
5105 size_t count)
5106{
5107 struct workqueue_struct *wq = dev_to_wq(dev);
5108 int val;
5109
5110 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5111 return -EINVAL;
5112
5113 workqueue_set_max_active(wq, val);
5114 return count;
5115}
5116static DEVICE_ATTR_RW(max_active);
5117
5118static struct attribute *wq_sysfs_attrs[] = {
5119 &dev_attr_per_cpu.attr,
5120 &dev_attr_max_active.attr,
5121 NULL,
5122};
5123ATTRIBUTE_GROUPS(wq_sysfs);
5124
5125static ssize_t wq_pool_ids_show(struct device *dev,
5126 struct device_attribute *attr, char *buf)
5127{
5128 struct workqueue_struct *wq = dev_to_wq(dev);
5129 const char *delim = "";
5130 int node, written = 0;
5131
5132 rcu_read_lock_sched();
5133 for_each_node(node) {
5134 written += scnprintf(buf + written, PAGE_SIZE - written,
5135 "%s%d:%d", delim, node,
5136 unbound_pwq_by_node(wq, node)->pool->id);
5137 delim = " ";
5138 }
5139 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5140 rcu_read_unlock_sched();
5141
5142 return written;
5143}
5144
5145static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5146 char *buf)
5147{
5148 struct workqueue_struct *wq = dev_to_wq(dev);
5149 int written;
5150
5151 mutex_lock(&wq->mutex);
5152 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5153 mutex_unlock(&wq->mutex);
5154
5155 return written;
5156}
5157
5158/* prepare workqueue_attrs for sysfs store operations */
5159static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5160{
5161 struct workqueue_attrs *attrs;
5162
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005163 lockdep_assert_held(&wq_pool_mutex);
5164
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005165 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5166 if (!attrs)
5167 return NULL;
5168
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005169 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005170 return attrs;
5171}
5172
5173static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5174 const char *buf, size_t count)
5175{
5176 struct workqueue_struct *wq = dev_to_wq(dev);
5177 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005178 int ret = -ENOMEM;
5179
5180 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005181
5182 attrs = wq_sysfs_prep_attrs(wq);
5183 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005184 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005185
5186 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5187 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005188 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005189 else
5190 ret = -EINVAL;
5191
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005192out_unlock:
5193 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005194 free_workqueue_attrs(attrs);
5195 return ret ?: count;
5196}
5197
5198static ssize_t wq_cpumask_show(struct device *dev,
5199 struct device_attribute *attr, char *buf)
5200{
5201 struct workqueue_struct *wq = dev_to_wq(dev);
5202 int written;
5203
5204 mutex_lock(&wq->mutex);
5205 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5206 cpumask_pr_args(wq->unbound_attrs->cpumask));
5207 mutex_unlock(&wq->mutex);
5208 return written;
5209}
5210
5211static ssize_t wq_cpumask_store(struct device *dev,
5212 struct device_attribute *attr,
5213 const char *buf, size_t count)
5214{
5215 struct workqueue_struct *wq = dev_to_wq(dev);
5216 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005217 int ret = -ENOMEM;
5218
5219 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005220
5221 attrs = wq_sysfs_prep_attrs(wq);
5222 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005223 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005224
5225 ret = cpumask_parse(buf, attrs->cpumask);
5226 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005227 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005228
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005229out_unlock:
5230 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005231 free_workqueue_attrs(attrs);
5232 return ret ?: count;
5233}
5234
5235static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5236 char *buf)
5237{
5238 struct workqueue_struct *wq = dev_to_wq(dev);
5239 int written;
5240
5241 mutex_lock(&wq->mutex);
5242 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5243 !wq->unbound_attrs->no_numa);
5244 mutex_unlock(&wq->mutex);
5245
5246 return written;
5247}
5248
5249static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5250 const char *buf, size_t count)
5251{
5252 struct workqueue_struct *wq = dev_to_wq(dev);
5253 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005254 int v, ret = -ENOMEM;
5255
5256 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005257
5258 attrs = wq_sysfs_prep_attrs(wq);
5259 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005260 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005261
5262 ret = -EINVAL;
5263 if (sscanf(buf, "%d", &v) == 1) {
5264 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005265 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005266 }
5267
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005268out_unlock:
5269 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005270 free_workqueue_attrs(attrs);
5271 return ret ?: count;
5272}
5273
5274static struct device_attribute wq_sysfs_unbound_attrs[] = {
5275 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5276 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5277 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5278 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5279 __ATTR_NULL,
5280};
5281
5282static struct bus_type wq_subsys = {
5283 .name = "workqueue",
5284 .dev_groups = wq_sysfs_groups,
5285};
5286
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005287static ssize_t wq_unbound_cpumask_show(struct device *dev,
5288 struct device_attribute *attr, char *buf)
5289{
5290 int written;
5291
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005292 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005293 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5294 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005295 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005296
5297 return written;
5298}
5299
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005300static ssize_t wq_unbound_cpumask_store(struct device *dev,
5301 struct device_attribute *attr, const char *buf, size_t count)
5302{
5303 cpumask_var_t cpumask;
5304 int ret;
5305
5306 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5307 return -ENOMEM;
5308
5309 ret = cpumask_parse(buf, cpumask);
5310 if (!ret)
5311 ret = workqueue_set_unbound_cpumask(cpumask);
5312
5313 free_cpumask_var(cpumask);
5314 return ret ? ret : count;
5315}
5316
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005317static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005318 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5319 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005320
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005321static int __init wq_sysfs_init(void)
5322{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005323 int err;
5324
5325 err = subsys_virtual_register(&wq_subsys, NULL);
5326 if (err)
5327 return err;
5328
5329 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005330}
5331core_initcall(wq_sysfs_init);
5332
5333static void wq_device_release(struct device *dev)
5334{
5335 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5336
5337 kfree(wq_dev);
5338}
5339
5340/**
5341 * workqueue_sysfs_register - make a workqueue visible in sysfs
5342 * @wq: the workqueue to register
5343 *
5344 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5345 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5346 * which is the preferred method.
5347 *
5348 * Workqueue user should use this function directly iff it wants to apply
5349 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5350 * apply_workqueue_attrs() may race against userland updating the
5351 * attributes.
5352 *
5353 * Return: 0 on success, -errno on failure.
5354 */
5355int workqueue_sysfs_register(struct workqueue_struct *wq)
5356{
5357 struct wq_device *wq_dev;
5358 int ret;
5359
5360 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305361 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005362 * attributes breaks ordering guarantee. Disallow exposing ordered
5363 * workqueues.
5364 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005365 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005366 return -EINVAL;
5367
5368 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5369 if (!wq_dev)
5370 return -ENOMEM;
5371
5372 wq_dev->wq = wq;
5373 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005374 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005375 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005376
5377 /*
5378 * unbound_attrs are created separately. Suppress uevent until
5379 * everything is ready.
5380 */
5381 dev_set_uevent_suppress(&wq_dev->dev, true);
5382
5383 ret = device_register(&wq_dev->dev);
5384 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305385 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005386 wq->wq_dev = NULL;
5387 return ret;
5388 }
5389
5390 if (wq->flags & WQ_UNBOUND) {
5391 struct device_attribute *attr;
5392
5393 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5394 ret = device_create_file(&wq_dev->dev, attr);
5395 if (ret) {
5396 device_unregister(&wq_dev->dev);
5397 wq->wq_dev = NULL;
5398 return ret;
5399 }
5400 }
5401 }
5402
5403 dev_set_uevent_suppress(&wq_dev->dev, false);
5404 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5405 return 0;
5406}
5407
5408/**
5409 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5410 * @wq: the workqueue to unregister
5411 *
5412 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5413 */
5414static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5415{
5416 struct wq_device *wq_dev = wq->wq_dev;
5417
5418 if (!wq->wq_dev)
5419 return;
5420
5421 wq->wq_dev = NULL;
5422 device_unregister(&wq_dev->dev);
5423}
5424#else /* CONFIG_SYSFS */
5425static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5426#endif /* CONFIG_SYSFS */
5427
Tejun Heo82607adc2015-12-08 11:28:04 -05005428/*
5429 * Workqueue watchdog.
5430 *
5431 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5432 * flush dependency, a concurrency managed work item which stays RUNNING
5433 * indefinitely. Workqueue stalls can be very difficult to debug as the
5434 * usual warning mechanisms don't trigger and internal workqueue state is
5435 * largely opaque.
5436 *
5437 * Workqueue watchdog monitors all worker pools periodically and dumps
5438 * state if some pools failed to make forward progress for a while where
5439 * forward progress is defined as the first item on ->worklist changing.
5440 *
5441 * This mechanism is controlled through the kernel parameter
5442 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5443 * corresponding sysfs parameter file.
5444 */
5445#ifdef CONFIG_WQ_WATCHDOG
5446
Tejun Heo82607adc2015-12-08 11:28:04 -05005447static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005448static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005449
5450static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5451static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5452
5453static void wq_watchdog_reset_touched(void)
5454{
5455 int cpu;
5456
5457 wq_watchdog_touched = jiffies;
5458 for_each_possible_cpu(cpu)
5459 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5460}
5461
Kees Cook5cd79d62017-10-04 16:27:00 -07005462static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005463{
5464 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5465 bool lockup_detected = false;
5466 struct worker_pool *pool;
5467 int pi;
5468
5469 if (!thresh)
5470 return;
5471
5472 rcu_read_lock();
5473
5474 for_each_pool(pool, pi) {
5475 unsigned long pool_ts, touched, ts;
5476
5477 if (list_empty(&pool->worklist))
5478 continue;
5479
5480 /* get the latest of pool and touched timestamps */
5481 pool_ts = READ_ONCE(pool->watchdog_ts);
5482 touched = READ_ONCE(wq_watchdog_touched);
5483
5484 if (time_after(pool_ts, touched))
5485 ts = pool_ts;
5486 else
5487 ts = touched;
5488
5489 if (pool->cpu >= 0) {
5490 unsigned long cpu_touched =
5491 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5492 pool->cpu));
5493 if (time_after(cpu_touched, ts))
5494 ts = cpu_touched;
5495 }
5496
5497 /* did we stall? */
5498 if (time_after(jiffies, ts + thresh)) {
5499 lockup_detected = true;
5500 pr_emerg("BUG: workqueue lockup - pool");
5501 pr_cont_pool_info(pool);
5502 pr_cont(" stuck for %us!\n",
5503 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5504 }
5505 }
5506
5507 rcu_read_unlock();
5508
5509 if (lockup_detected)
5510 show_workqueue_state();
5511
5512 wq_watchdog_reset_touched();
5513 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5514}
5515
5516void wq_watchdog_touch(int cpu)
5517{
5518 if (cpu >= 0)
5519 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5520 else
5521 wq_watchdog_touched = jiffies;
5522}
5523
5524static void wq_watchdog_set_thresh(unsigned long thresh)
5525{
5526 wq_watchdog_thresh = 0;
5527 del_timer_sync(&wq_watchdog_timer);
5528
5529 if (thresh) {
5530 wq_watchdog_thresh = thresh;
5531 wq_watchdog_reset_touched();
5532 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5533 }
5534}
5535
5536static int wq_watchdog_param_set_thresh(const char *val,
5537 const struct kernel_param *kp)
5538{
5539 unsigned long thresh;
5540 int ret;
5541
5542 ret = kstrtoul(val, 0, &thresh);
5543 if (ret)
5544 return ret;
5545
5546 if (system_wq)
5547 wq_watchdog_set_thresh(thresh);
5548 else
5549 wq_watchdog_thresh = thresh;
5550
5551 return 0;
5552}
5553
5554static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5555 .set = wq_watchdog_param_set_thresh,
5556 .get = param_get_ulong,
5557};
5558
5559module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5560 0644);
5561
5562static void wq_watchdog_init(void)
5563{
Kees Cook5cd79d62017-10-04 16:27:00 -07005564 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005565 wq_watchdog_set_thresh(wq_watchdog_thresh);
5566}
5567
5568#else /* CONFIG_WQ_WATCHDOG */
5569
5570static inline void wq_watchdog_init(void) { }
5571
5572#endif /* CONFIG_WQ_WATCHDOG */
5573
Tejun Heobce90382013-04-01 11:23:32 -07005574static void __init wq_numa_init(void)
5575{
5576 cpumask_var_t *tbl;
5577 int node, cpu;
5578
Tejun Heobce90382013-04-01 11:23:32 -07005579 if (num_possible_nodes() <= 1)
5580 return;
5581
Tejun Heod55262c2013-04-01 11:23:38 -07005582 if (wq_disable_numa) {
5583 pr_info("workqueue: NUMA affinity support disabled\n");
5584 return;
5585 }
5586
Tejun Heo4c16bd32013-04-01 11:23:36 -07005587 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5588 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5589
Tejun Heobce90382013-04-01 11:23:32 -07005590 /*
5591 * We want masks of possible CPUs of each node which isn't readily
5592 * available. Build one from cpu_to_node() which should have been
5593 * fully initialized by now.
5594 */
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08005595 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005596 BUG_ON(!tbl);
5597
5598 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005599 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005600 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005601
5602 for_each_possible_cpu(cpu) {
5603 node = cpu_to_node(cpu);
5604 if (WARN_ON(node == NUMA_NO_NODE)) {
5605 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5606 /* happens iff arch is bonkers, let's just proceed */
5607 return;
5608 }
5609 cpumask_set_cpu(cpu, tbl[node]);
5610 }
5611
5612 wq_numa_possible_cpumask = tbl;
5613 wq_numa_enabled = true;
5614}
5615
Tejun Heo3347fa02016-09-16 15:49:32 -04005616/**
5617 * workqueue_init_early - early init for workqueue subsystem
5618 *
5619 * This is the first half of two-staged workqueue subsystem initialization
5620 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5621 * idr are up. It sets up all the data structures and system workqueues
5622 * and allows early boot code to create workqueues and queue/cancel work
5623 * items. Actual work item execution starts only after kthreads can be
5624 * created and scheduled right before early initcalls.
5625 */
5626int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005627{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005628 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005629 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005630 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005631
Tejun Heoe904e6c2013-03-12 11:29:57 -07005632 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5633
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005634 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005635 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005636
Tejun Heoe904e6c2013-03-12 11:29:57 -07005637 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5638
Tejun Heo706026c2013-01-24 11:01:34 -08005639 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005640 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005641 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005642
Tejun Heo7a4e3442013-03-12 11:30:00 -07005643 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005644 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005645 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005646 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005647 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005648 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005649 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005650
Tejun Heo9daf9e62013-01-24 11:01:33 -08005651 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005652 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005653 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005654 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005655 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005656 }
5657
Tejun Heo8a2b7532013-09-05 12:30:04 -04005658 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005659 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5660 struct workqueue_attrs *attrs;
5661
5662 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005663 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005664 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005665
5666 /*
5667 * An ordered wq should have only one pwq as ordering is
5668 * guaranteed by max_active which is enforced by pwqs.
5669 * Turn off NUMA so that dfl_pwq is used for all nodes.
5670 */
5671 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5672 attrs->nice = std_nice[i];
5673 attrs->no_numa = true;
5674 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005675 }
5676
Tejun Heod320c032010-06-29 10:07:14 +02005677 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005678 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005679 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005680 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5681 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005682 system_freezable_wq = alloc_workqueue("events_freezable",
5683 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305684 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5685 WQ_POWER_EFFICIENT, 0);
5686 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5687 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5688 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005689 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305690 !system_unbound_wq || !system_freezable_wq ||
5691 !system_power_efficient_wq ||
5692 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005693
Tejun Heo3347fa02016-09-16 15:49:32 -04005694 return 0;
5695}
5696
5697/**
5698 * workqueue_init - bring workqueue subsystem fully online
5699 *
5700 * This is the latter half of two-staged workqueue subsystem initialization
5701 * and invoked as soon as kthreads can be created and scheduled.
5702 * Workqueues have been created and work items queued on them, but there
5703 * are no kworkers executing the work items yet. Populate the worker pools
5704 * with the initial workers and enable future kworker creations.
5705 */
5706int __init workqueue_init(void)
5707{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005708 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005709 struct worker_pool *pool;
5710 int cpu, bkt;
5711
Tejun Heo2186d9f2016-10-19 12:01:27 -04005712 /*
5713 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5714 * CPU to node mapping may not be available that early on some
5715 * archs such as power and arm64. As per-cpu pools created
5716 * previously could be missing node hint and unbound pools NUMA
5717 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005718 *
5719 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005720 */
5721 wq_numa_init();
5722
5723 mutex_lock(&wq_pool_mutex);
5724
5725 for_each_possible_cpu(cpu) {
5726 for_each_cpu_worker_pool(pool, cpu) {
5727 pool->node = cpu_to_node(cpu);
5728 }
5729 }
5730
Tejun Heo40c17f72018-01-08 05:38:37 -08005731 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005732 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005733 WARN(init_rescuer(wq),
5734 "workqueue: failed to create early rescuer for %s",
5735 wq->name);
5736 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005737
5738 mutex_unlock(&wq_pool_mutex);
5739
Tejun Heo3347fa02016-09-16 15:49:32 -04005740 /* create the initial workers */
5741 for_each_online_cpu(cpu) {
5742 for_each_cpu_worker_pool(pool, cpu) {
5743 pool->flags &= ~POOL_DISASSOCIATED;
5744 BUG_ON(!create_worker(pool));
5745 }
5746 }
5747
5748 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5749 BUG_ON(!create_worker(pool));
5750
5751 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005752 wq_watchdog_init();
5753
Suresh Siddha6ee05782010-07-30 14:57:37 -07005754 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005755}