blob: fc5d23d752a574d3c03487c8c817352a5972f83c [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
Tejun Heo1258fae2018-05-18 08:47:13 -070069 * wq_pool_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 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700126 * A: wq_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 list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800170 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800171
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800172 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800173
Tejun Heo7a4e3442013-03-12 11:30:00 -0700174 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700175 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
176 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700177
Tejun Heoe19e3972013-01-24 11:39:44 -0800178 /*
179 * The current concurrency level. As it's likely to be accessed
180 * from other CPUs during try_to_wake_up(), put it in a separate
181 * cacheline.
182 */
183 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700184
185 /*
186 * Destruction of pool is sched-RCU protected to allow dereferences
187 * from get_work_pool().
188 */
189 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200190} ____cacheline_aligned_in_smp;
191
192/*
Tejun Heo112202d2013-02-13 19:29:12 -0800193 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
194 * of work_struct->data are used for flags and the remaining high bits
195 * point to the pwq; thus, pwqs need to be aligned at two's power of the
196 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
Tejun Heo112202d2013-02-13 19:29:12 -0800198struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700199 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200200 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200201 int work_color; /* L: current color */
202 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700203 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 int nr_in_flight[WORK_NR_COLORS];
205 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200206 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200207 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200208 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700209 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700210 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211
212 /*
213 * Release of unbound pwq is punted to system_wq. See put_pwq()
214 * and pwq_unbound_release_workfn() for details. pool_workqueue
215 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700216 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700217 */
218 struct work_struct unbound_release_work;
219 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700220} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 * Structure used to wait for workqueue flush.
224 */
225struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700226 struct list_head list; /* WQ: list of flushers */
227 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200228 struct completion done; /* flush completion */
229};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Tejun Heo226223a2013-03-12 11:30:05 -0700231struct wq_device;
232
Tejun Heo73f53c42010-06-29 10:07:11 +0200233/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700234 * The externally visible workqueue. It relays the issued work items to
235 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 */
237struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700238 struct list_head pwqs; /* WR: all pwqs of this wq */
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400239 struct list_head list; /* PR: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200240
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700241 struct mutex mutex; /* protects this wq */
242 int work_color; /* WQ: current work color */
243 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800244 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700245 struct wq_flusher *first_flusher; /* WQ: first flusher */
246 struct list_head flusher_queue; /* WQ: flush waiters */
247 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200248
Tejun Heo2e109a22013-03-13 19:47:40 -0700249 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200250 struct worker *rescuer; /* I: rescue worker */
251
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700252 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700253 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700254
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800255 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
256 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700257
Tejun Heo226223a2013-03-12 11:30:05 -0700258#ifdef CONFIG_SYSFS
259 struct wq_device *wq_dev; /* I: for sysfs interface */
260#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700261#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200262 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700264 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700265
Tejun Heoe2dca7a2015-03-09 09:22:28 -0400266 /*
267 * Destruction of workqueue_struct is sched-RCU protected to allow
268 * walking the workqueues list without grabbing wq_pool_mutex.
269 * This is used to dump all workqueues from sysrq.
270 */
271 struct rcu_head rcu;
272
Tejun Heo2728fd22013-04-01 11:23:35 -0700273 /* hot fields used during command issue, aligned to cacheline */
274 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
275 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +0800276 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277};
278
Tejun Heoe904e6c2013-03-12 11:29:57 -0700279static struct kmem_cache *pwq_cache;
280
Tejun Heobce90382013-04-01 11:23:32 -0700281static cpumask_var_t *wq_numa_possible_cpumask;
282 /* possible CPUs of each node */
283
Tejun Heod55262c2013-04-01 11:23:38 -0700284static bool wq_disable_numa;
285module_param_named(disable_numa, wq_disable_numa, bool, 0444);
286
Viresh Kumarcee22a12013-04-08 16:45:40 +0530287/* see the comment above the definition of WQ_POWER_EFFICIENT */
Luis R. Rodriguez552f5302015-05-27 11:09:39 +0930288static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
Viresh Kumarcee22a12013-04-08 16:45:40 +0530289module_param_named(power_efficient, wq_power_efficient, bool, 0444);
290
Tejun Heo863b7102016-09-16 15:49:34 -0400291static bool wq_online; /* can kworkers be created yet? */
Tejun Heo3347fa02016-09-16 15:49:32 -0400292
Tejun Heobce90382013-04-01 11:23:32 -0700293static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
294
Tejun Heo4c16bd32013-04-01 11:23:36 -0700295/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
296static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
297
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700298static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo1258fae2018-05-18 08:47:13 -0700299static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
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 *
Tejun Heo1258fae2018-05-18 08:47:13 -0700402 * This must be called with wq_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) \
Tejun Heo1258fae2018-05-18 08:47:13 -0700409 if (({ lockdep_assert_held(&wq_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/**
Johannes Weiner1b69ac62019-02-01 14:20:42 -0800913 * wq_worker_last_func - retrieve worker's last work function
914 *
915 * Determine the last function a worker executed. This is called from
916 * the scheduler to get a worker's last known identity.
917 *
918 * CONTEXT:
919 * spin_lock_irq(rq->lock)
920 *
921 * Return:
922 * The last work function %current executed as a worker, NULL if it
923 * hasn't executed any work yet.
924 */
925work_func_t wq_worker_last_func(struct task_struct *task)
926{
927 struct worker *worker = kthread_data(task);
928
929 return worker->last_func;
930}
931
932/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200933 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200934 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200935 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200936 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800937 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200938 *
Tejun Heocb444762010-07-02 10:03:50 +0200939 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800940 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200941 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800942static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200943{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700944 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200945
Tejun Heocb444762010-07-02 10:03:50 +0200946 WARN_ON_ONCE(worker->task != current);
947
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800948 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200949 if ((flags & WORKER_NOT_RUNNING) &&
950 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800951 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200952 }
953
Tejun Heod302f012010-06-29 10:07:13 +0200954 worker->flags |= flags;
955}
956
957/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200958 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200959 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200960 * @flags: flags to clear
961 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200962 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200963 *
Tejun Heocb444762010-07-02 10:03:50 +0200964 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800965 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200966 */
967static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
968{
Tejun Heo63d95a92012-07-12 14:46:37 -0700969 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200970 unsigned int oflags = worker->flags;
971
Tejun Heocb444762010-07-02 10:03:50 +0200972 WARN_ON_ONCE(worker->task != current);
973
Tejun Heod302f012010-06-29 10:07:13 +0200974 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200975
Tejun Heo42c025f2011-01-11 15:58:49 +0100976 /*
977 * If transitioning out of NOT_RUNNING, increment nr_running. Note
978 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
979 * of multiple flags, not a single flag.
980 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200981 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
982 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800983 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200984}
985
986/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200987 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800988 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200989 * @work: work to find worker for
990 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800991 * Find a worker which is executing @work on @pool by searching
992 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800993 * to match, its current execution should match the address of @work and
994 * its work function. This is to avoid unwanted dependency between
995 * unrelated work executions through a work item being recycled while still
996 * being executed.
997 *
998 * This is a bit tricky. A work item may be freed once its execution
999 * starts and nothing prevents the freed area from being recycled for
1000 * another work item. If the same work item address ends up being reused
1001 * before the original execution finishes, workqueue will identify the
1002 * recycled work item as currently executing and make it wait until the
1003 * current execution finishes, introducing an unwanted dependency.
1004 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001005 * This function checks the work item address and work function to avoid
1006 * false positives. Note that this isn't complete as one may construct a
1007 * work function which can introduce dependency onto itself through a
1008 * recycled work item. Well, if somebody wants to shoot oneself in the
1009 * foot that badly, there's only so much we can do, and if such deadlock
1010 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001011 *
1012 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001013 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001014 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001015 * Return:
1016 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001017 * otherwise.
1018 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001019static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001020 struct work_struct *work)
1021{
Sasha Levin42f85702012-12-17 10:01:23 -05001022 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001023
Sasha Levinb67bfe02013-02-27 17:06:00 -08001024 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001025 (unsigned long)work)
1026 if (worker->current_work == work &&
1027 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001028 return worker;
1029
1030 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001031}
1032
1033/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001034 * move_linked_works - move linked works to a list
1035 * @work: start of series of works to be scheduled
1036 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301037 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001038 *
1039 * Schedule linked works starting from @work to @head. Work series to
1040 * be scheduled starts at @work and includes any consecutive work with
1041 * WORK_STRUCT_LINKED set in its predecessor.
1042 *
1043 * If @nextp is not NULL, it's updated to point to the next work of
1044 * the last scheduled work. This allows move_linked_works() to be
1045 * nested inside outer list_for_each_entry_safe().
1046 *
1047 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001048 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001049 */
1050static void move_linked_works(struct work_struct *work, struct list_head *head,
1051 struct work_struct **nextp)
1052{
1053 struct work_struct *n;
1054
1055 /*
1056 * Linked worklist will always end before the end of the list,
1057 * use NULL for list head.
1058 */
1059 list_for_each_entry_safe_from(work, n, NULL, entry) {
1060 list_move_tail(&work->entry, head);
1061 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1062 break;
1063 }
1064
1065 /*
1066 * If we're already inside safe list traversal and have moved
1067 * multiple works to the scheduled queue, the next position
1068 * needs to be updated.
1069 */
1070 if (nextp)
1071 *nextp = n;
1072}
1073
Tejun Heo8864b4e2013-03-12 11:30:04 -07001074/**
1075 * get_pwq - get an extra reference on the specified pool_workqueue
1076 * @pwq: pool_workqueue to get
1077 *
1078 * Obtain an extra reference on @pwq. The caller should guarantee that
1079 * @pwq has positive refcnt and be holding the matching pool->lock.
1080 */
1081static void get_pwq(struct pool_workqueue *pwq)
1082{
1083 lockdep_assert_held(&pwq->pool->lock);
1084 WARN_ON_ONCE(pwq->refcnt <= 0);
1085 pwq->refcnt++;
1086}
1087
1088/**
1089 * put_pwq - put a pool_workqueue reference
1090 * @pwq: pool_workqueue to put
1091 *
1092 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1093 * destruction. The caller should be holding the matching pool->lock.
1094 */
1095static void put_pwq(struct pool_workqueue *pwq)
1096{
1097 lockdep_assert_held(&pwq->pool->lock);
1098 if (likely(--pwq->refcnt))
1099 return;
1100 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1101 return;
1102 /*
1103 * @pwq can't be released under pool->lock, bounce to
1104 * pwq_unbound_release_workfn(). This never recurses on the same
1105 * pool->lock as this path is taken only for unbound workqueues and
1106 * the release work item is scheduled on a per-cpu workqueue. To
1107 * avoid lockdep warning, unbound pool->locks are given lockdep
1108 * subclass of 1 in get_unbound_pool().
1109 */
1110 schedule_work(&pwq->unbound_release_work);
1111}
1112
Tejun Heodce90d42013-04-01 11:23:35 -07001113/**
1114 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1115 * @pwq: pool_workqueue to put (can be %NULL)
1116 *
1117 * put_pwq() with locking. This function also allows %NULL @pwq.
1118 */
1119static void put_pwq_unlocked(struct pool_workqueue *pwq)
1120{
1121 if (pwq) {
1122 /*
1123 * As both pwqs and pools are sched-RCU protected, the
1124 * following lock operations are safe.
1125 */
1126 spin_lock_irq(&pwq->pool->lock);
1127 put_pwq(pwq);
1128 spin_unlock_irq(&pwq->pool->lock);
1129 }
1130}
1131
Tejun Heo112202d2013-02-13 19:29:12 -08001132static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001133{
Tejun Heo112202d2013-02-13 19:29:12 -08001134 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001135
1136 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001137 if (list_empty(&pwq->pool->worklist))
1138 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001139 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001140 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001141 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001142}
1143
Tejun Heo112202d2013-02-13 19:29:12 -08001144static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001145{
Tejun Heo112202d2013-02-13 19:29:12 -08001146 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001147 struct work_struct, entry);
1148
Tejun Heo112202d2013-02-13 19:29:12 -08001149 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001150}
1151
Tejun Heobf4ede02012-08-03 10:30:46 -07001152/**
Tejun Heo112202d2013-02-13 19:29:12 -08001153 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1154 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001155 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001156 *
1157 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001158 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001159 *
1160 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001161 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001162 */
Tejun Heo112202d2013-02-13 19:29:12 -08001163static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001164{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001165 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001166 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001167 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001168
Tejun Heo112202d2013-02-13 19:29:12 -08001169 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001170
Tejun Heo112202d2013-02-13 19:29:12 -08001171 pwq->nr_active--;
1172 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001173 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001174 if (pwq->nr_active < pwq->max_active)
1175 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001176 }
1177
1178 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001179 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001180 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001181
1182 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001183 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001184 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001185
Tejun Heo112202d2013-02-13 19:29:12 -08001186 /* this pwq is done, clear flush_color */
1187 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001188
1189 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001190 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001191 * will handle the rest.
1192 */
Tejun Heo112202d2013-02-13 19:29:12 -08001193 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1194 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001195out_put:
1196 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001197}
1198
Tejun Heo36e227d2012-08-03 10:30:46 -07001199/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001200 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001201 * @work: work item to steal
1202 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001203 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001204 *
1205 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001206 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001207 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001208 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001209 * 1 if @work was pending and we successfully stole PENDING
1210 * 0 if @work was idle and we claimed PENDING
1211 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001212 * -ENOENT if someone else is canceling @work, this state may persist
1213 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001215 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001216 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001217 * interrupted while holding PENDING and @work off queue, irq must be
1218 * disabled on entry. This, combined with delayed_work->timer being
1219 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001220 *
1221 * On successful return, >= 0, irq is disabled and the caller is
1222 * responsible for releasing it using local_irq_restore(*@flags).
1223 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001224 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001225 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001226static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1227 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001228{
Tejun Heod565ed62013-01-24 11:01:33 -08001229 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001230 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001231
Tejun Heobbb68df2012-08-03 10:30:46 -07001232 local_irq_save(*flags);
1233
Tejun Heo36e227d2012-08-03 10:30:46 -07001234 /* try to steal the timer if it exists */
1235 if (is_dwork) {
1236 struct delayed_work *dwork = to_delayed_work(work);
1237
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001238 /*
1239 * dwork->timer is irqsafe. If del_timer() fails, it's
1240 * guaranteed that the timer is not queued anywhere and not
1241 * running on the local CPU.
1242 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001243 if (likely(del_timer(&dwork->timer)))
1244 return 1;
1245 }
1246
1247 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001248 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1249 return 0;
1250
1251 /*
1252 * The queueing is in progress, or it is already queued. Try to
1253 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1254 */
Tejun Heod565ed62013-01-24 11:01:33 -08001255 pool = get_work_pool(work);
1256 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001257 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001258
Tejun Heod565ed62013-01-24 11:01:33 -08001259 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001260 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001261 * work->data is guaranteed to point to pwq only while the work
1262 * item is queued on pwq->wq, and both updating work->data to point
1263 * to pwq on queueing and to pool on dequeueing are done under
1264 * pwq->pool->lock. This in turn guarantees that, if work->data
1265 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001266 * item is currently queued on that pool.
1267 */
Tejun Heo112202d2013-02-13 19:29:12 -08001268 pwq = get_work_pwq(work);
1269 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001270 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001271
Tejun Heo16062832013-02-06 18:04:53 -08001272 /*
1273 * A delayed work item cannot be grabbed directly because
1274 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001275 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001276 * management later on and cause stall. Make sure the work
1277 * item is activated before grabbing.
1278 */
1279 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001280 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001281
Tejun Heo16062832013-02-06 18:04:53 -08001282 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001283 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001284
Tejun Heo112202d2013-02-13 19:29:12 -08001285 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001286 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001287
Tejun Heo16062832013-02-06 18:04:53 -08001288 spin_unlock(&pool->lock);
1289 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001290 }
Tejun Heod565ed62013-01-24 11:01:33 -08001291 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001292fail:
1293 local_irq_restore(*flags);
1294 if (work_is_canceling(work))
1295 return -ENOENT;
1296 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001297 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001298}
1299
1300/**
Tejun Heo706026c2013-01-24 11:01:34 -08001301 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001302 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001303 * @work: work to insert
1304 * @head: insertion point
1305 * @extra_flags: extra WORK_STRUCT_* flags to set
1306 *
Tejun Heo112202d2013-02-13 19:29:12 -08001307 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001308 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001309 *
1310 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001311 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001312 */
Tejun Heo112202d2013-02-13 19:29:12 -08001313static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1314 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001315{
Tejun Heo112202d2013-02-13 19:29:12 -08001316 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001317
Tejun Heo4690c4a2010-06-29 10:07:10 +02001318 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001319 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001320 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001321 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001322
1323 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001324 * Ensure either wq_worker_sleeping() sees the above
1325 * list_add_tail() or we see zero nr_running to avoid workers lying
1326 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001327 */
1328 smp_mb();
1329
Tejun Heo63d95a92012-07-12 14:46:37 -07001330 if (__need_more_worker(pool))
1331 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001332}
1333
Tejun Heoc8efcc22010-12-20 19:32:04 +01001334/*
1335 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001336 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001337 */
1338static bool is_chained_work(struct workqueue_struct *wq)
1339{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001340 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001341
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001342 worker = current_wq_worker();
1343 /*
1344 * Return %true iff I'm a worker execuing a work item on @wq. If
1345 * I'm @worker, it's safe to dereference it without locking.
1346 */
Tejun Heo112202d2013-02-13 19:29:12 -08001347 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001348}
1349
Mike Galbraithef5571802016-02-09 17:59:38 -05001350/*
1351 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1352 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1353 * avoid perturbing sensitive tasks.
1354 */
1355static int wq_select_unbound_cpu(int cpu)
1356{
Tejun Heof303fccb2016-02-09 17:59:38 -05001357 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001358 int new_cpu;
1359
Tejun Heof303fccb2016-02-09 17:59:38 -05001360 if (likely(!wq_debug_force_rr_cpu)) {
1361 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1362 return cpu;
1363 } else if (!printed_dbg_warning) {
1364 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1365 printed_dbg_warning = true;
1366 }
1367
Mike Galbraithef5571802016-02-09 17:59:38 -05001368 if (cpumask_empty(wq_unbound_cpumask))
1369 return cpu;
1370
1371 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1372 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1373 if (unlikely(new_cpu >= nr_cpu_ids)) {
1374 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1375 if (unlikely(new_cpu >= nr_cpu_ids))
1376 return cpu;
1377 }
1378 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1379
1380 return new_cpu;
1381}
1382
Tejun Heod84ff052013-03-12 11:29:59 -07001383static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 struct work_struct *work)
1385{
Tejun Heo112202d2013-02-13 19:29:12 -08001386 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001387 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001388 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001389 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001390 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001391
1392 /*
1393 * While a work item is PENDING && off queue, a task trying to
1394 * steal the PENDING will busy-loop waiting for it to either get
1395 * queued or lose PENDING. Grabbing PENDING and queueing should
1396 * happen with IRQ disabled.
1397 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001398 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001400 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001401
Li Bin9ef28a72013-09-09 13:13:58 +08001402 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001403 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001404 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001405 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001406retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001407 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001408 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001409
Tejun Heoc9178082013-03-12 11:30:04 -07001410 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001411 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001412 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001413 else
1414 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001415
Tejun Heoc9178082013-03-12 11:30:04 -07001416 /*
1417 * If @work was previously on a different pool, it might still be
1418 * running there, in which case the work needs to be queued on that
1419 * pool to guarantee non-reentrancy.
1420 */
1421 last_pool = get_work_pool(work);
1422 if (last_pool && last_pool != pwq->pool) {
1423 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001424
Tejun Heoc9178082013-03-12 11:30:04 -07001425 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001426
Tejun Heoc9178082013-03-12 11:30:04 -07001427 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001428
Tejun Heoc9178082013-03-12 11:30:04 -07001429 if (worker && worker->current_pwq->wq == wq) {
1430 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001431 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001432 /* meh... not running there, queue here */
1433 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001434 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001435 }
Tejun Heof3421792010-07-02 10:03:51 +02001436 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001437 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001438 }
1439
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001440 /*
1441 * pwq is determined and locked. For unbound pools, we could have
1442 * raced with pwq release and it could already be dead. If its
1443 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001444 * without another pwq replacing it in the numa_pwq_tbl or while
1445 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001446 * make forward-progress.
1447 */
1448 if (unlikely(!pwq->refcnt)) {
1449 if (wq->flags & WQ_UNBOUND) {
1450 spin_unlock(&pwq->pool->lock);
1451 cpu_relax();
1452 goto retry;
1453 }
1454 /* oops */
1455 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1456 wq->name, cpu);
1457 }
1458
Tejun Heo112202d2013-02-13 19:29:12 -08001459 /* pwq determined, queue */
1460 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001461
Dan Carpenterf5b25522012-04-13 22:06:58 +03001462 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001463 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001464 return;
1465 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001466
Tejun Heo112202d2013-02-13 19:29:12 -08001467 pwq->nr_in_flight[pwq->work_color]++;
1468 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001469
Tejun Heo112202d2013-02-13 19:29:12 -08001470 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001471 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001472 pwq->nr_active++;
1473 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001474 if (list_empty(worklist))
1475 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001476 } else {
1477 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001478 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001479 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001480
Tejun Heo112202d2013-02-13 19:29:12 -08001481 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001482
Tejun Heo112202d2013-02-13 19:29:12 -08001483 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484}
1485
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001486/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001487 * queue_work_on - queue work on specific cpu
1488 * @cpu: CPU number to execute work on
1489 * @wq: workqueue to use
1490 * @work: work to queue
1491 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001492 * We queue the work to a specific CPU, the caller must ensure it
1493 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001494 *
1495 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001496 */
Tejun Heod4283e92012-08-03 10:30:44 -07001497bool queue_work_on(int cpu, struct workqueue_struct *wq,
1498 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001499{
Tejun Heod4283e92012-08-03 10:30:44 -07001500 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001501 unsigned long flags;
1502
1503 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001504
Tejun Heo22df02b2010-06-29 10:07:10 +02001505 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001506 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001507 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001508 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001509
1510 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001511 return ret;
1512}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001513EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001514
Kees Cook8c20feb2017-10-04 16:27:07 -07001515void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516{
Kees Cook8c20feb2017-10-04 16:27:07 -07001517 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001519 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001520 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001522EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001524static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1525 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001527 struct timer_list *timer = &dwork->timer;
1528 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Tejun Heo637fdba2017-03-06 15:33:42 -05001530 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001531 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001532 WARN_ON_ONCE(timer_pending(timer));
1533 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001534
Tejun Heo8852aac2012-12-01 16:23:42 -08001535 /*
1536 * If @delay is 0, queue @dwork->work immediately. This is for
1537 * both optimization and correctness. The earliest @timer can
1538 * expire is on the closest next tick and delayed_work users depend
1539 * on that there's no such delay when @delay is 0.
1540 */
1541 if (!delay) {
1542 __queue_work(cpu, wq, &dwork->work);
1543 return;
1544 }
1545
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001546 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001547 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001548 timer->expires = jiffies + delay;
1549
Tejun Heo041bd122016-02-09 16:11:26 -05001550 if (unlikely(cpu != WORK_CPU_UNBOUND))
1551 add_timer_on(timer, cpu);
1552 else
1553 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554}
1555
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001556/**
1557 * queue_delayed_work_on - queue work on specific CPU after delay
1558 * @cpu: CPU number to execute work on
1559 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001560 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001561 * @delay: number of jiffies to wait before queueing
1562 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001563 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001564 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1565 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001566 */
Tejun Heod4283e92012-08-03 10:30:44 -07001567bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1568 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001569{
David Howells52bad642006-11-22 14:54:01 +00001570 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001571 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001572 unsigned long flags;
1573
1574 /* read the comment in __queue_work() */
1575 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001576
Tejun Heo22df02b2010-06-29 10:07:10 +02001577 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001578 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001579 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001580 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001581
1582 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001583 return ret;
1584}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001585EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Tejun Heoc8e55f32010-06-29 10:07:12 +02001587/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001588 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1589 * @cpu: CPU number to execute work on
1590 * @wq: workqueue to use
1591 * @dwork: work to queue
1592 * @delay: number of jiffies to wait before queueing
1593 *
1594 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1595 * modify @dwork's timer so that it expires after @delay. If @delay is
1596 * zero, @work is guaranteed to be scheduled immediately regardless of its
1597 * current state.
1598 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001599 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001600 * pending and its timer was modified.
1601 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001602 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001603 * See try_to_grab_pending() for details.
1604 */
1605bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1606 struct delayed_work *dwork, unsigned long delay)
1607{
1608 unsigned long flags;
1609 int ret;
1610
1611 do {
1612 ret = try_to_grab_pending(&dwork->work, true, &flags);
1613 } while (unlikely(ret == -EAGAIN));
1614
1615 if (likely(ret >= 0)) {
1616 __queue_delayed_work(cpu, wq, dwork, delay);
1617 local_irq_restore(flags);
1618 }
1619
1620 /* -ENOENT from try_to_grab_pending() becomes %true */
1621 return ret;
1622}
1623EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1624
Tejun Heo05f0fe62018-03-14 12:45:13 -07001625static void rcu_work_rcufn(struct rcu_head *rcu)
1626{
1627 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1628
1629 /* read the comment in __queue_work() */
1630 local_irq_disable();
1631 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1632 local_irq_enable();
1633}
1634
1635/**
1636 * queue_rcu_work - queue work after a RCU grace period
1637 * @wq: workqueue to use
1638 * @rwork: work to queue
1639 *
1640 * Return: %false if @rwork was already pending, %true otherwise. Note
1641 * that a full RCU grace period is guaranteed only after a %true return.
1642 * While @rwork is guarnateed to be executed after a %false return, the
1643 * execution may happen before a full RCU grace period has passed.
1644 */
1645bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1646{
1647 struct work_struct *work = &rwork->work;
1648
1649 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1650 rwork->wq = wq;
1651 call_rcu(&rwork->rcu, rcu_work_rcufn);
1652 return true;
1653 }
1654
1655 return false;
1656}
1657EXPORT_SYMBOL(queue_rcu_work);
1658
Tejun Heo8376fe22012-08-03 10:30:47 -07001659/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001660 * worker_enter_idle - enter idle state
1661 * @worker: worker which is entering idle state
1662 *
1663 * @worker is entering idle state. Update stats and idle timer if
1664 * necessary.
1665 *
1666 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001667 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001668 */
1669static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001671 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672
Tejun Heo6183c002013-03-12 11:29:57 -07001673 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1674 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1675 (worker->hentry.next || worker->hentry.pprev)))
1676 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Lai Jiangshan051e1852014-07-22 13:03:02 +08001678 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001679 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001680 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001681 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001682
Tejun Heoc8e55f32010-06-29 10:07:12 +02001683 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001684 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001685
Tejun Heo628c78e2012-07-17 12:39:27 -07001686 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1687 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001688
Tejun Heo544ecf32012-05-14 15:04:50 -07001689 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001690 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001691 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001692 * nr_running, the warning may trigger spuriously. Check iff
1693 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001694 */
Tejun Heo24647572013-01-24 11:01:33 -08001695 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001696 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001697 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698}
1699
Tejun Heoc8e55f32010-06-29 10:07:12 +02001700/**
1701 * worker_leave_idle - leave idle state
1702 * @worker: worker which is leaving idle state
1703 *
1704 * @worker is leaving idle state. Update stats.
1705 *
1706 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001707 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001708 */
1709static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001711 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712
Tejun Heo6183c002013-03-12 11:29:57 -07001713 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1714 return;
Tejun Heod302f012010-06-29 10:07:13 +02001715 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001716 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001717 list_del_init(&worker->entry);
1718}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001720static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001721{
1722 struct worker *worker;
1723
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001724 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001725 if (worker) {
1726 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001727 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001728 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001729 /* on creation a worker is in !idle && prep state */
1730 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001731 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001732 return worker;
1733}
1734
1735/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001736 * worker_attach_to_pool() - attach a worker to a pool
1737 * @worker: worker to be attached
1738 * @pool: the target pool
1739 *
1740 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1741 * cpu-binding of @worker are kept coordinated with the pool across
1742 * cpu-[un]hotplugs.
1743 */
1744static void worker_attach_to_pool(struct worker *worker,
1745 struct worker_pool *pool)
1746{
Tejun Heo1258fae2018-05-18 08:47:13 -07001747 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001748
1749 /*
1750 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1751 * online CPUs. It'll be re-applied when any of the CPUs come up.
1752 */
1753 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1754
1755 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001756 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1757 * stable across this function. See the comments above the flag
1758 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001759 */
1760 if (pool->flags & POOL_DISASSOCIATED)
1761 worker->flags |= WORKER_UNBOUND;
1762
1763 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001764 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001765
Tejun Heo1258fae2018-05-18 08:47:13 -07001766 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001767}
1768
1769/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001770 * worker_detach_from_pool() - detach a worker from its pool
1771 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001772 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001773 * Undo the attaching which had been done in worker_attach_to_pool(). The
1774 * caller worker shouldn't access to the pool after detached except it has
1775 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001776 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001777static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001778{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001779 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001780 struct completion *detach_completion = NULL;
1781
Tejun Heo1258fae2018-05-18 08:47:13 -07001782 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001783
Lai Jiangshanda028462014-05-20 17:46:31 +08001784 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001785 worker->pool = NULL;
1786
Lai Jiangshanda028462014-05-20 17:46:31 +08001787 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001788 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001789 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001790
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001791 /* clear leftover flags without pool->lock after it is detached */
1792 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1793
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001794 if (detach_completion)
1795 complete(detach_completion);
1796}
1797
1798/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001800 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001802 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 *
1804 * CONTEXT:
1805 * Might sleep. Does GFP_KERNEL allocations.
1806 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001807 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001808 * Pointer to the newly created worker.
1809 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001810static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001811{
Tejun Heoc34056a2010-06-29 10:07:11 +02001812 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001813 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001814 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001815
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001816 /* ID is needed to determine kthread name */
1817 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001818 if (id < 0)
1819 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001820
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001821 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001822 if (!worker)
1823 goto fail;
1824
Tejun Heoc34056a2010-06-29 10:07:11 +02001825 worker->id = id;
1826
Tejun Heo29c91e92013-03-12 11:30:03 -07001827 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001828 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1829 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001830 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001831 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1832
Tejun Heof3f90ad2013-04-01 11:23:34 -07001833 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001834 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001835 if (IS_ERR(worker->task))
1836 goto fail;
1837
Oleg Nesterov91151222013-11-14 12:56:18 +01001838 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001839 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001840
Lai Jiangshanda028462014-05-20 17:46:31 +08001841 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001842 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001843
Lai Jiangshan051e1852014-07-22 13:03:02 +08001844 /* start the newly created worker */
1845 spin_lock_irq(&pool->lock);
1846 worker->pool->nr_workers++;
1847 worker_enter_idle(worker);
1848 wake_up_process(worker->task);
1849 spin_unlock_irq(&pool->lock);
1850
Tejun Heoc34056a2010-06-29 10:07:11 +02001851 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001852
Tejun Heoc34056a2010-06-29 10:07:11 +02001853fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001854 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001855 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001856 kfree(worker);
1857 return NULL;
1858}
1859
1860/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001861 * destroy_worker - destroy a workqueue worker
1862 * @worker: worker to be destroyed
1863 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001864 * Destroy @worker and adjust @pool stats accordingly. The worker should
1865 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001866 *
1867 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001868 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001869 */
1870static void destroy_worker(struct worker *worker)
1871{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001872 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001873
Tejun Heocd549682013-03-13 19:47:39 -07001874 lockdep_assert_held(&pool->lock);
1875
Tejun Heoc34056a2010-06-29 10:07:11 +02001876 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001877 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001878 WARN_ON(!list_empty(&worker->scheduled)) ||
1879 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001880 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001881
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001882 pool->nr_workers--;
1883 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001884
Tejun Heoc8e55f32010-06-29 10:07:12 +02001885 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001886 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001887 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001888}
1889
Kees Cook32a6c722017-10-16 15:58:25 -07001890static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001891{
Kees Cook32a6c722017-10-16 15:58:25 -07001892 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001893
Tejun Heod565ed62013-01-24 11:01:33 -08001894 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001895
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001896 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001897 struct worker *worker;
1898 unsigned long expires;
1899
1900 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001901 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001902 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1903
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001904 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001905 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001906 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001907 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001908
1909 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 }
1911
Tejun Heod565ed62013-01-24 11:01:33 -08001912 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001913}
1914
Tejun Heo493a1722013-03-12 11:29:59 -07001915static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001916{
Tejun Heo112202d2013-02-13 19:29:12 -08001917 struct pool_workqueue *pwq = get_work_pwq(work);
1918 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001919
Tejun Heo2e109a22013-03-13 19:47:40 -07001920 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001921
Tejun Heo493008a2013-03-12 11:30:03 -07001922 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001923 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001924
1925 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001926 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001927 /*
1928 * If @pwq is for an unbound wq, its base ref may be put at
1929 * any time due to an attribute change. Pin @pwq until the
1930 * rescuer is done with it.
1931 */
1932 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001933 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001934 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001935 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001936}
1937
Kees Cook32a6c722017-10-16 15:58:25 -07001938static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001939{
Kees Cook32a6c722017-10-16 15:58:25 -07001940 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001941 struct work_struct *work;
1942
Tejun Heob2d82902014-12-08 12:39:16 -05001943 spin_lock_irq(&pool->lock);
1944 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001945
Tejun Heo63d95a92012-07-12 14:46:37 -07001946 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 /*
1948 * We've been trying to create a new worker but
1949 * haven't been successful. We might be hitting an
1950 * allocation deadlock. Send distress signals to
1951 * rescuers.
1952 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001953 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 send_mayday(work);
1955 }
1956
Tejun Heob2d82902014-12-08 12:39:16 -05001957 spin_unlock(&wq_mayday_lock);
1958 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001959
Tejun Heo63d95a92012-07-12 14:46:37 -07001960 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001961}
1962
1963/**
1964 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001965 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001967 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 * have at least one idle worker on return from this function. If
1969 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001970 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 * possible allocation deadlock.
1972 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001973 * On return, need_to_create_worker() is guaranteed to be %false and
1974 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 *
1976 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001977 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 * multiple times. Does GFP_KERNEL allocations. Called only from
1979 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 */
Tejun Heo29187a92015-01-16 14:21:16 -05001981static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001982__releases(&pool->lock)
1983__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001984{
Tejun Heoe22bee72010-06-29 10:07:14 +02001985restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001986 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001987
Tejun Heoe22bee72010-06-29 10:07:14 +02001988 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001989 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001990
1991 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001992 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 break;
1994
Lai Jiangshane212f362014-06-03 15:32:17 +08001995 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001996
Tejun Heo63d95a92012-07-12 14:46:37 -07001997 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 break;
1999 }
2000
Tejun Heo63d95a92012-07-12 14:46:37 -07002001 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08002002 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08002003 /*
2004 * This is necessary even after a new worker was just successfully
2005 * created as @pool->lock was dropped and the new worker might have
2006 * already become busy.
2007 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02002010}
2011
2012/**
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 * manage_workers - manage worker pool
2014 * @worker: self
2015 *
Tejun Heo706026c2013-01-24 11:01:34 -08002016 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002017 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002018 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002019 *
2020 * The caller can safely start processing works on false return. On
2021 * true return, it's guaranteed that need_to_create_worker() is false
2022 * and may_start_working() is true.
2023 *
2024 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002025 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 * multiple times. Does GFP_KERNEL allocations.
2027 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002028 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002029 * %false if the pool doesn't need management and the caller can safely
2030 * start processing works, %true if management function was performed and
2031 * the conditions that the caller verified before calling the function may
2032 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 */
2034static bool manage_workers(struct worker *worker)
2035{
Tejun Heo63d95a92012-07-12 14:46:37 -07002036 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002037
Tejun Heo692b4822017-10-09 08:04:13 -07002038 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002039 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002040
2041 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002042 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002043
Tejun Heo29187a92015-01-16 14:21:16 -05002044 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002045
Tejun Heo2607d7a2015-03-09 09:22:28 -04002046 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002047 pool->flags &= ~POOL_MANAGER_ACTIVE;
2048 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002049 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002050}
2051
Tejun Heoa62428c2010-06-29 10:07:10 +02002052/**
2053 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002054 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002055 * @work: work to process
2056 *
2057 * Process @work. This function contains all the logics necessary to
2058 * process a single work including synchronization against and
2059 * interaction with other workers on the same cpu, queueing and
2060 * flushing. As long as context requirement is met, any worker can
2061 * call this function to process a work.
2062 *
2063 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002064 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002065 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002066static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002067__releases(&pool->lock)
2068__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002069{
Tejun Heo112202d2013-02-13 19:29:12 -08002070 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002071 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002072 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002073 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002074 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002075#ifdef CONFIG_LOCKDEP
2076 /*
2077 * It is permissible to free the struct work_struct from
2078 * inside the function that is called from it, this we need to
2079 * take into account for lockdep too. To avoid bogus "held
2080 * lock freed" warnings as well as problems when looking into
2081 * work->lockdep_map, make a copy and use that here.
2082 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002083 struct lockdep_map lockdep_map;
2084
2085 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002086#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002087 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002088 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002089 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002090
Tejun Heo7e116292010-06-29 10:07:13 +02002091 /*
2092 * A single work shouldn't be executed concurrently by
2093 * multiple workers on a single cpu. Check whether anyone is
2094 * already processing the work. If so, defer the work to the
2095 * currently executing one.
2096 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002097 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002098 if (unlikely(collision)) {
2099 move_linked_works(work, &collision->scheduled, NULL);
2100 return;
2101 }
2102
Tejun Heo8930cab2012-08-03 10:30:45 -07002103 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002104 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002105 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002106 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002107 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002108 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002109 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002110
Tejun Heo8bf89592018-05-18 08:47:13 -07002111 /*
2112 * Record wq name for cmdline and debug reporting, may get
2113 * overridden through set_worker_desc().
2114 */
2115 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2116
Tejun Heoa62428c2010-06-29 10:07:10 +02002117 list_del_init(&work->entry);
2118
Tejun Heo649027d2010-06-29 10:07:14 +02002119 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002120 * CPU intensive works don't participate in concurrency management.
2121 * They're the scheduler's responsibility. This takes @worker out
2122 * of concurrency management and the next code block will chain
2123 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002124 */
2125 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002126 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002127
Tejun Heo974271c2012-07-12 14:46:37 -07002128 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002129 * Wake up another worker if necessary. The condition is always
2130 * false for normal per-cpu workers since nr_running would always
2131 * be >= 1 at this point. This is used to chain execution of the
2132 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002133 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002134 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002135 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002136 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002137
Tejun Heo8930cab2012-08-03 10:30:45 -07002138 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002139 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002140 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002141 * PENDING and queued state changes happen together while IRQ is
2142 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002143 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002144 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002145
Tejun Heod565ed62013-01-24 11:01:33 -08002146 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002147
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002148 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002149 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002150 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002151 * Strictly speaking we should mark the invariant state without holding
2152 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002153 *
2154 * However, that would result in:
2155 *
2156 * A(W1)
2157 * WFC(C)
2158 * A(W1)
2159 * C(C)
2160 *
2161 * Which would create W1->C->W1 dependencies, even though there is no
2162 * actual deadlock possible. There are two solutions, using a
2163 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002164 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002165 * these locks.
2166 *
2167 * AFAICT there is no possible deadlock scenario between the
2168 * flush_work() and complete() primitives (except for single-threaded
2169 * workqueues), so hiding them isn't a problem.
2170 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002171 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002172 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002173 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002174 /*
2175 * While we must be careful to not use "work" after this, the trace
2176 * point will only record its address.
2177 */
2178 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002179 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002180 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002181
2182 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002183 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2184 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002185 current->comm, preempt_count(), task_pid_nr(current),
2186 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002187 debug_show_held_locks(current);
2188 dump_stack();
2189 }
2190
Tejun Heob22ce272013-08-28 17:33:37 -04002191 /*
2192 * The following prevents a kworker from hogging CPU on !PREEMPT
2193 * kernels, where a requeueing work item waiting for something to
2194 * happen could deadlock with stop_machine as such work item could
2195 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002196 * stop_machine. At the same time, report a quiescent RCU state so
2197 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002198 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002199 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002200
Tejun Heod565ed62013-01-24 11:01:33 -08002201 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002202
Tejun Heofb0e7be2010-06-29 10:07:15 +02002203 /* clear cpu intensive status */
2204 if (unlikely(cpu_intensive))
2205 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2206
Johannes Weiner1b69ac62019-02-01 14:20:42 -08002207 /* tag the worker for identification in schedule() */
2208 worker->last_func = worker->current_func;
2209
Tejun Heoa62428c2010-06-29 10:07:10 +02002210 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002211 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002212 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002213 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002214 worker->current_pwq = NULL;
2215 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002216}
2217
Tejun Heoaffee4b2010-06-29 10:07:12 +02002218/**
2219 * process_scheduled_works - process scheduled works
2220 * @worker: self
2221 *
2222 * Process all scheduled works. Please note that the scheduled list
2223 * may change while processing a work, so this function repeatedly
2224 * fetches a work from the top and executes it.
2225 *
2226 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002227 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002228 * multiple times.
2229 */
2230static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002232 while (!list_empty(&worker->scheduled)) {
2233 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002235 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237}
2238
Tejun Heo197f6ac2018-05-21 08:04:35 -07002239static void set_pf_worker(bool val)
2240{
2241 mutex_lock(&wq_pool_attach_mutex);
2242 if (val)
2243 current->flags |= PF_WQ_WORKER;
2244 else
2245 current->flags &= ~PF_WQ_WORKER;
2246 mutex_unlock(&wq_pool_attach_mutex);
2247}
2248
Tejun Heo4690c4a2010-06-29 10:07:10 +02002249/**
2250 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002251 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002252 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002253 * The worker thread function. All workers belong to a worker_pool -
2254 * either a per-cpu one or dynamic unbound one. These workers process all
2255 * work items regardless of their specific target workqueue. The only
2256 * exception is work items which belong to workqueues with a rescuer which
2257 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002258 *
2259 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002260 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002261static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262{
Tejun Heoc34056a2010-06-29 10:07:11 +02002263 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002264 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265
Tejun Heoe22bee72010-06-29 10:07:14 +02002266 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002267 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002268woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002269 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002270
Tejun Heoa9ab7752013-03-19 13:45:21 -07002271 /* am I supposed to die? */
2272 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002273 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002274 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002275 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002276
2277 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002278 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002279 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002280 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002281 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002283
Tejun Heoc8e55f32010-06-29 10:07:12 +02002284 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002285recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002286 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002287 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002288 goto sleep;
2289
2290 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002291 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002292 goto recheck;
2293
Tejun Heoc8e55f32010-06-29 10:07:12 +02002294 /*
2295 * ->scheduled list can only be filled while a worker is
2296 * preparing to process a work or actually processing it.
2297 * Make sure nobody diddled with it while I was sleeping.
2298 */
Tejun Heo6183c002013-03-12 11:29:57 -07002299 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002300
Tejun Heoe22bee72010-06-29 10:07:14 +02002301 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002302 * Finish PREP stage. We're guaranteed to have at least one idle
2303 * worker or that someone else has already assumed the manager
2304 * role. This is where @worker starts participating in concurrency
2305 * management if applicable and concurrency management is restored
2306 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002308 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002309
2310 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002311 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002312 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002313 struct work_struct, entry);
2314
Tejun Heo82607adc2015-12-08 11:28:04 -05002315 pool->watchdog_ts = jiffies;
2316
Tejun Heoc8e55f32010-06-29 10:07:12 +02002317 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2318 /* optimization path, not strictly necessary */
2319 process_one_work(worker, work);
2320 if (unlikely(!list_empty(&worker->scheduled)))
2321 process_scheduled_works(worker);
2322 } else {
2323 move_linked_works(work, &worker->scheduled, NULL);
2324 process_scheduled_works(worker);
2325 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002326 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002327
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002328 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002329sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002330 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002331 * pool->lock is held and there's no work to process and no need to
2332 * manage, sleep. Workers are woken up only while holding
2333 * pool->lock or from local cpu, so setting the current state
2334 * before releasing pool->lock is enough to prevent losing any
2335 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002336 */
2337 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002338 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002339 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002340 schedule();
2341 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342}
2343
Tejun Heoe22bee72010-06-29 10:07:14 +02002344/**
2345 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002346 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002347 *
2348 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002349 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002350 *
Tejun Heo706026c2013-01-24 11:01:34 -08002351 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002352 * worker which uses GFP_KERNEL allocation which has slight chance of
2353 * developing into deadlock if some works currently on the same queue
2354 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2355 * the problem rescuer solves.
2356 *
Tejun Heo706026c2013-01-24 11:01:34 -08002357 * When such condition is possible, the pool summons rescuers of all
2358 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002359 * those works so that forward progress can be guaranteed.
2360 *
2361 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002362 *
2363 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002364 */
Tejun Heo111c2252013-01-17 17:16:24 -08002365static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002366{
Tejun Heo111c2252013-01-17 17:16:24 -08002367 struct worker *rescuer = __rescuer;
2368 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002369 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002370 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002371
2372 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002373
2374 /*
2375 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2376 * doesn't participate in concurrency management.
2377 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002378 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002379repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002380 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002381
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002382 /*
2383 * By the time the rescuer is requested to stop, the workqueue
2384 * shouldn't have any work pending, but @wq->maydays may still have
2385 * pwq(s) queued. This can happen by non-rescuer workers consuming
2386 * all the work items before the rescuer got to them. Go through
2387 * @wq->maydays processing before acting on should_stop so that the
2388 * list is always empty on exit.
2389 */
2390 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002391
Tejun Heo493a1722013-03-12 11:29:59 -07002392 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002393 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002394
2395 while (!list_empty(&wq->maydays)) {
2396 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2397 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002398 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002399 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002400 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002401
2402 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002403 list_del_init(&pwq->mayday_node);
2404
Tejun Heo2e109a22013-03-13 19:47:40 -07002405 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002406
Lai Jiangshan51697d392014-05-20 17:46:36 +08002407 worker_attach_to_pool(rescuer, pool);
2408
2409 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002410
2411 /*
2412 * Slurp in all works issued via this workqueue and
2413 * process'em.
2414 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002415 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002416 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2417 if (get_work_pwq(work) == pwq) {
2418 if (first)
2419 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002420 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002421 }
2422 first = false;
2423 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002424
NeilBrown008847f2014-12-08 12:39:16 -05002425 if (!list_empty(scheduled)) {
2426 process_scheduled_works(rescuer);
2427
2428 /*
2429 * The above execution of rescued work items could
2430 * have created more to rescue through
2431 * pwq_activate_first_delayed() or chained
2432 * queueing. Let's put @pwq back on mayday list so
2433 * that such back-to-back work items, which may be
2434 * being used to relieve memory pressure, don't
2435 * incur MAYDAY_INTERVAL delay inbetween.
2436 */
2437 if (need_to_create_worker(pool)) {
2438 spin_lock(&wq_mayday_lock);
2439 get_pwq(pwq);
2440 list_move_tail(&pwq->mayday_node, &wq->maydays);
2441 spin_unlock(&wq_mayday_lock);
2442 }
2443 }
Tejun Heo75769582011-02-14 14:04:46 +01002444
2445 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002446 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002447 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002448 */
2449 put_pwq(pwq);
2450
2451 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002452 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002453 * regular worker; otherwise, we end up with 0 concurrency
2454 * and stalling the execution.
2455 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002456 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002457 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002458
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002459 spin_unlock_irq(&pool->lock);
2460
Tejun Heoa2d812a2018-05-18 08:47:13 -07002461 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002462
2463 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002464 }
2465
Tejun Heo2e109a22013-03-13 19:47:40 -07002466 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002467
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002468 if (should_stop) {
2469 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002470 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002471 return 0;
2472 }
2473
Tejun Heo111c2252013-01-17 17:16:24 -08002474 /* rescuers should never participate in concurrency management */
2475 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002476 schedule();
2477 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478}
2479
Tejun Heofca839c2015-12-07 10:58:57 -05002480/**
2481 * check_flush_dependency - check for flush dependency sanity
2482 * @target_wq: workqueue being flushed
2483 * @target_work: work item being flushed (NULL for workqueue flushes)
2484 *
2485 * %current is trying to flush the whole @target_wq or @target_work on it.
2486 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2487 * reclaiming memory or running on a workqueue which doesn't have
2488 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2489 * a deadlock.
2490 */
2491static void check_flush_dependency(struct workqueue_struct *target_wq,
2492 struct work_struct *target_work)
2493{
2494 work_func_t target_func = target_work ? target_work->func : NULL;
2495 struct worker *worker;
2496
2497 if (target_wq->flags & WQ_MEM_RECLAIM)
2498 return;
2499
2500 worker = current_wq_worker();
2501
2502 WARN_ONCE(current->flags & PF_MEMALLOC,
2503 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2504 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002505 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2506 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002507 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2508 worker->current_pwq->wq->name, worker->current_func,
2509 target_wq->name, target_func);
2510}
2511
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002512struct wq_barrier {
2513 struct work_struct work;
2514 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002515 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002516};
2517
2518static void wq_barrier_func(struct work_struct *work)
2519{
2520 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2521 complete(&barr->done);
2522}
2523
Tejun Heo4690c4a2010-06-29 10:07:10 +02002524/**
2525 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002526 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002527 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002528 * @target: target work to attach @barr to
2529 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002530 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002531 * @barr is linked to @target such that @barr is completed only after
2532 * @target finishes execution. Please note that the ordering
2533 * guarantee is observed only with respect to @target and on the local
2534 * cpu.
2535 *
2536 * Currently, a queued barrier can't be canceled. This is because
2537 * try_to_grab_pending() can't determine whether the work to be
2538 * grabbed is at the head of the queue and thus can't clear LINKED
2539 * flag of the previous work while there must be a valid next work
2540 * after a work with LINKED flag set.
2541 *
2542 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002543 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002544 *
2545 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002546 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002547 */
Tejun Heo112202d2013-02-13 19:29:12 -08002548static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002549 struct wq_barrier *barr,
2550 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002551{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002552 struct list_head *head;
2553 unsigned int linked = 0;
2554
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002555 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002556 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002557 * as we know for sure that this will not trigger any of the
2558 * checks and call back into the fixup functions where we
2559 * might deadlock.
2560 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002561 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002562 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002563
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002564 init_completion_map(&barr->done, &target->lockdep_map);
2565
Tejun Heo2607d7a2015-03-09 09:22:28 -04002566 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002567
Tejun Heoaffee4b2010-06-29 10:07:12 +02002568 /*
2569 * If @target is currently being executed, schedule the
2570 * barrier to the worker; otherwise, put it after @target.
2571 */
2572 if (worker)
2573 head = worker->scheduled.next;
2574 else {
2575 unsigned long *bits = work_data_bits(target);
2576
2577 head = target->entry.next;
2578 /* there can already be other linked works, inherit and set */
2579 linked = *bits & WORK_STRUCT_LINKED;
2580 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2581 }
2582
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002583 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002584 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002585 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002586}
2587
Tejun Heo73f53c42010-06-29 10:07:11 +02002588/**
Tejun Heo112202d2013-02-13 19:29:12 -08002589 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002590 * @wq: workqueue being flushed
2591 * @flush_color: new flush color, < 0 for no-op
2592 * @work_color: new work color, < 0 for no-op
2593 *
Tejun Heo112202d2013-02-13 19:29:12 -08002594 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002595 *
Tejun Heo112202d2013-02-13 19:29:12 -08002596 * If @flush_color is non-negative, flush_color on all pwqs should be
2597 * -1. If no pwq has in-flight commands at the specified color, all
2598 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2599 * has in flight commands, its pwq->flush_color is set to
2600 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002601 * wakeup logic is armed and %true is returned.
2602 *
2603 * The caller should have initialized @wq->first_flusher prior to
2604 * calling this function with non-negative @flush_color. If
2605 * @flush_color is negative, no flush color update is done and %false
2606 * is returned.
2607 *
Tejun Heo112202d2013-02-13 19:29:12 -08002608 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002609 * work_color which is previous to @work_color and all will be
2610 * advanced to @work_color.
2611 *
2612 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002613 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002614 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002615 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002616 * %true if @flush_color >= 0 and there's something to flush. %false
2617 * otherwise.
2618 */
Tejun Heo112202d2013-02-13 19:29:12 -08002619static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002620 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621{
Tejun Heo73f53c42010-06-29 10:07:11 +02002622 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002623 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002624
Tejun Heo73f53c42010-06-29 10:07:11 +02002625 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002626 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002627 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002628 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002629
Tejun Heo49e3cf42013-03-12 11:29:58 -07002630 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002631 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002632
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002633 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002634
2635 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002636 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002637
Tejun Heo112202d2013-02-13 19:29:12 -08002638 if (pwq->nr_in_flight[flush_color]) {
2639 pwq->flush_color = flush_color;
2640 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002641 wait = true;
2642 }
2643 }
2644
2645 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002646 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002647 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002648 }
2649
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002650 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002651 }
2652
Tejun Heo112202d2013-02-13 19:29:12 -08002653 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002654 complete(&wq->first_flusher->done);
2655
2656 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657}
2658
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002659/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002661 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002663 * This function sleeps until all work items which were queued on entry
2664 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002666void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667{
Tejun Heo73f53c42010-06-29 10:07:11 +02002668 struct wq_flusher this_flusher = {
2669 .list = LIST_HEAD_INIT(this_flusher.list),
2670 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002671 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002672 };
2673 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002674
Tejun Heo3347fa02016-09-16 15:49:32 -04002675 if (WARN_ON(!wq_online))
2676 return;
2677
Johannes Berg87915ad2018-08-22 11:49:04 +02002678 lock_map_acquire(&wq->lockdep_map);
2679 lock_map_release(&wq->lockdep_map);
2680
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002681 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002682
2683 /*
2684 * Start-to-wait phase
2685 */
2686 next_color = work_next_color(wq->work_color);
2687
2688 if (next_color != wq->flush_color) {
2689 /*
2690 * Color space is not full. The current work_color
2691 * becomes our flush_color and work_color is advanced
2692 * by one.
2693 */
Tejun Heo6183c002013-03-12 11:29:57 -07002694 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002695 this_flusher.flush_color = wq->work_color;
2696 wq->work_color = next_color;
2697
2698 if (!wq->first_flusher) {
2699 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002700 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002701
2702 wq->first_flusher = &this_flusher;
2703
Tejun Heo112202d2013-02-13 19:29:12 -08002704 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002705 wq->work_color)) {
2706 /* nothing to flush, done */
2707 wq->flush_color = next_color;
2708 wq->first_flusher = NULL;
2709 goto out_unlock;
2710 }
2711 } else {
2712 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002713 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002714 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002715 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002716 }
2717 } else {
2718 /*
2719 * Oops, color space is full, wait on overflow queue.
2720 * The next flush completion will assign us
2721 * flush_color and transfer to flusher_queue.
2722 */
2723 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2724 }
2725
Tejun Heofca839c2015-12-07 10:58:57 -05002726 check_flush_dependency(wq, NULL);
2727
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002728 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002729
2730 wait_for_completion(&this_flusher.done);
2731
2732 /*
2733 * Wake-up-and-cascade phase
2734 *
2735 * First flushers are responsible for cascading flushes and
2736 * handling overflow. Non-first flushers can simply return.
2737 */
2738 if (wq->first_flusher != &this_flusher)
2739 return;
2740
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002741 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002742
Tejun Heo4ce48b32010-07-02 10:03:51 +02002743 /* we might have raced, check again with mutex held */
2744 if (wq->first_flusher != &this_flusher)
2745 goto out_unlock;
2746
Tejun Heo73f53c42010-06-29 10:07:11 +02002747 wq->first_flusher = NULL;
2748
Tejun Heo6183c002013-03-12 11:29:57 -07002749 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2750 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002751
2752 while (true) {
2753 struct wq_flusher *next, *tmp;
2754
2755 /* complete all the flushers sharing the current flush color */
2756 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2757 if (next->flush_color != wq->flush_color)
2758 break;
2759 list_del_init(&next->list);
2760 complete(&next->done);
2761 }
2762
Tejun Heo6183c002013-03-12 11:29:57 -07002763 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2764 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002765
2766 /* this flush_color is finished, advance by one */
2767 wq->flush_color = work_next_color(wq->flush_color);
2768
2769 /* one color has been freed, handle overflow queue */
2770 if (!list_empty(&wq->flusher_overflow)) {
2771 /*
2772 * Assign the same color to all overflowed
2773 * flushers, advance work_color and append to
2774 * flusher_queue. This is the start-to-wait
2775 * phase for these overflowed flushers.
2776 */
2777 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2778 tmp->flush_color = wq->work_color;
2779
2780 wq->work_color = work_next_color(wq->work_color);
2781
2782 list_splice_tail_init(&wq->flusher_overflow,
2783 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002784 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002785 }
2786
2787 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002788 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002789 break;
2790 }
2791
2792 /*
2793 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002794 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002795 */
Tejun Heo6183c002013-03-12 11:29:57 -07002796 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2797 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002798
2799 list_del_init(&next->list);
2800 wq->first_flusher = next;
2801
Tejun Heo112202d2013-02-13 19:29:12 -08002802 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002803 break;
2804
2805 /*
2806 * Meh... this color is already done, clear first
2807 * flusher and repeat cascading.
2808 */
2809 wq->first_flusher = NULL;
2810 }
2811
2812out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002813 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002815EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002817/**
2818 * drain_workqueue - drain a workqueue
2819 * @wq: workqueue to drain
2820 *
2821 * Wait until the workqueue becomes empty. While draining is in progress,
2822 * only chain queueing is allowed. IOW, only currently pending or running
2823 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002824 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002825 * by the depth of chaining and should be relatively short. Whine if it
2826 * takes too long.
2827 */
2828void drain_workqueue(struct workqueue_struct *wq)
2829{
2830 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002831 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002832
2833 /*
2834 * __queue_work() needs to test whether there are drainers, is much
2835 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002836 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002837 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002838 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002839 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002840 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002841 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002842reflush:
2843 flush_workqueue(wq);
2844
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002845 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002846
Tejun Heo49e3cf42013-03-12 11:29:58 -07002847 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002848 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002849
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002850 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002851 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002852 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002853
2854 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002855 continue;
2856
2857 if (++flush_cnt == 10 ||
2858 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002859 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002860 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002861
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002862 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002863 goto reflush;
2864 }
2865
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002866 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002867 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002868 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002869}
2870EXPORT_SYMBOL_GPL(drain_workqueue);
2871
Johannes Bergd6e89782018-08-22 11:49:03 +02002872static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2873 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002874{
2875 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002876 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002877 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002878
2879 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002880
Tejun Heofa1b54e2013-03-12 11:30:00 -07002881 local_irq_disable();
2882 pool = get_work_pool(work);
2883 if (!pool) {
2884 local_irq_enable();
2885 return false;
2886 }
2887
2888 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002889 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002890 pwq = get_work_pwq(work);
2891 if (pwq) {
2892 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002893 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002894 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002895 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002896 if (!worker)
2897 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002898 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002899 }
Tejun Heobaf59022010-09-16 10:42:16 +02002900
Tejun Heofca839c2015-12-07 10:58:57 -05002901 check_flush_dependency(pwq->wq, work);
2902
Tejun Heo112202d2013-02-13 19:29:12 -08002903 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002904 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002905
Tejun Heoe159489b2011-01-09 23:32:15 +01002906 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002907 * Force a lock recursion deadlock when using flush_work() inside a
2908 * single-threaded or rescuer equipped workqueue.
2909 *
2910 * For single threaded workqueues the deadlock happens when the work
2911 * is after the work issuing the flush_work(). For rescuer equipped
2912 * workqueues the deadlock happens when the rescuer stalls, blocking
2913 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002914 */
Johannes Bergd6e89782018-08-22 11:49:03 +02002915 if (!from_cancel &&
2916 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08002917 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002918 lock_map_release(&pwq->wq->lockdep_map);
2919 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002920
Tejun Heobaf59022010-09-16 10:42:16 +02002921 return true;
2922already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002923 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002924 return false;
2925}
2926
Johannes Bergd6e89782018-08-22 11:49:03 +02002927static bool __flush_work(struct work_struct *work, bool from_cancel)
2928{
2929 struct wq_barrier barr;
2930
2931 if (WARN_ON(!wq_online))
2932 return false;
2933
Johannes Berg87915ad2018-08-22 11:49:04 +02002934 if (!from_cancel) {
2935 lock_map_acquire(&work->lockdep_map);
2936 lock_map_release(&work->lockdep_map);
2937 }
2938
Johannes Bergd6e89782018-08-22 11:49:03 +02002939 if (start_flush_work(work, &barr, from_cancel)) {
2940 wait_for_completion(&barr.done);
2941 destroy_work_on_stack(&barr.work);
2942 return true;
2943 } else {
2944 return false;
2945 }
2946}
2947
Oleg Nesterovdb700892008-07-25 01:47:49 -07002948/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002949 * flush_work - wait for a work to finish executing the last queueing instance
2950 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002951 *
Tejun Heo606a5022012-08-20 14:51:23 -07002952 * Wait until @work has finished execution. @work is guaranteed to be idle
2953 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002954 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002955 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002956 * %true if flush_work() waited for the work to finish execution,
2957 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002958 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002959bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002960{
Johannes Bergd6e89782018-08-22 11:49:03 +02002961 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07002962}
2963EXPORT_SYMBOL_GPL(flush_work);
2964
Tejun Heo8603e1b32015-03-05 08:04:13 -05002965struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002966 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002967 struct work_struct *work;
2968};
2969
Ingo Molnarac6424b2017-06-20 12:06:13 +02002970static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002971{
2972 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2973
2974 if (cwait->work != key)
2975 return 0;
2976 return autoremove_wake_function(wait, mode, sync, key);
2977}
2978
Tejun Heo36e227d2012-08-03 10:30:46 -07002979static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002980{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002981 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002982 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002983 int ret;
2984
2985 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002986 ret = try_to_grab_pending(work, is_dwork, &flags);
2987 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002988 * If someone else is already canceling, wait for it to
2989 * finish. flush_work() doesn't work for PREEMPT_NONE
2990 * because we may get scheduled between @work's completion
2991 * and the other canceling task resuming and clearing
2992 * CANCELING - flush_work() will return false immediately
2993 * as @work is no longer busy, try_to_grab_pending() will
2994 * return -ENOENT as @work is still being canceled and the
2995 * other canceling task won't be able to clear CANCELING as
2996 * we're hogging the CPU.
2997 *
2998 * Let's wait for completion using a waitqueue. As this
2999 * may lead to the thundering herd problem, use a custom
3000 * wake function which matches @work along with exclusive
3001 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07003002 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05003003 if (unlikely(ret == -ENOENT)) {
3004 struct cwt_wait cwait;
3005
3006 init_wait(&cwait.wait);
3007 cwait.wait.func = cwt_wakefn;
3008 cwait.work = work;
3009
3010 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3011 TASK_UNINTERRUPTIBLE);
3012 if (work_is_canceling(work))
3013 schedule();
3014 finish_wait(&cancel_waitq, &cwait.wait);
3015 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003016 } while (unlikely(ret < 0));
3017
Tejun Heobbb68df2012-08-03 10:30:46 -07003018 /* tell other tasks trying to grab @work to back off */
3019 mark_work_canceling(work);
3020 local_irq_restore(flags);
3021
Tejun Heo3347fa02016-09-16 15:49:32 -04003022 /*
3023 * This allows canceling during early boot. We know that @work
3024 * isn't executing.
3025 */
3026 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003027 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003028
Tejun Heo7a22ad72010-06-29 10:07:13 +02003029 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003030
3031 /*
3032 * Paired with prepare_to_wait() above so that either
3033 * waitqueue_active() is visible here or !work_is_canceling() is
3034 * visible there.
3035 */
3036 smp_mb();
3037 if (waitqueue_active(&cancel_waitq))
3038 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3039
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003040 return ret;
3041}
3042
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003043/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003044 * cancel_work_sync - cancel a work and wait for it to finish
3045 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003046 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003047 * Cancel @work and wait for its execution to finish. This function
3048 * can be used even if the work re-queues itself or migrates to
3049 * another workqueue. On return from this function, @work is
3050 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003051 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003052 * cancel_work_sync(&delayed_work->work) must not be used for
3053 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003054 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003055 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003056 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003057 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003058 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003059 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003060 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003061bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003062{
Tejun Heo36e227d2012-08-03 10:30:46 -07003063 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003064}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003065EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003066
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003067/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003068 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3069 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003070 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003071 * Delayed timer is cancelled and the pending work is queued for
3072 * immediate execution. Like flush_work(), this function only
3073 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003074 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003075 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003076 * %true if flush_work() waited for the work to finish execution,
3077 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003078 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003079bool flush_delayed_work(struct delayed_work *dwork)
3080{
Tejun Heo8930cab2012-08-03 10:30:45 -07003081 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003082 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003083 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003084 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003085 return flush_work(&dwork->work);
3086}
3087EXPORT_SYMBOL(flush_delayed_work);
3088
Tejun Heo05f0fe62018-03-14 12:45:13 -07003089/**
3090 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3091 * @rwork: the rcu work to flush
3092 *
3093 * Return:
3094 * %true if flush_rcu_work() waited for the work to finish execution,
3095 * %false if it was already idle.
3096 */
3097bool flush_rcu_work(struct rcu_work *rwork)
3098{
3099 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3100 rcu_barrier();
3101 flush_work(&rwork->work);
3102 return true;
3103 } else {
3104 return flush_work(&rwork->work);
3105 }
3106}
3107EXPORT_SYMBOL(flush_rcu_work);
3108
Jens Axboef72b8792016-08-24 15:51:50 -06003109static bool __cancel_work(struct work_struct *work, bool is_dwork)
3110{
3111 unsigned long flags;
3112 int ret;
3113
3114 do {
3115 ret = try_to_grab_pending(work, is_dwork, &flags);
3116 } while (unlikely(ret == -EAGAIN));
3117
3118 if (unlikely(ret < 0))
3119 return false;
3120
3121 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3122 local_irq_restore(flags);
3123 return ret;
3124}
3125
Tejun Heo401a8d02010-09-16 10:36:00 +02003126/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003127 * cancel_delayed_work - cancel a delayed work
3128 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003129 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003130 * Kill off a pending delayed_work.
3131 *
3132 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3133 * pending.
3134 *
3135 * Note:
3136 * The work callback function may still be running on return, unless
3137 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3138 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003139 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003140 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003141 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003142bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003143{
Jens Axboef72b8792016-08-24 15:51:50 -06003144 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003145}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003146EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003147
3148/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003149 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3150 * @dwork: the delayed work cancel
3151 *
3152 * This is cancel_work_sync() for delayed works.
3153 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003154 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003155 * %true if @dwork was pending, %false otherwise.
3156 */
3157bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003158{
Tejun Heo36e227d2012-08-03 10:30:46 -07003159 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003160}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003161EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003163/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003164 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003165 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003166 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003167 * schedule_on_each_cpu() executes @func on each online CPU using the
3168 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003169 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003170 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003171 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003172 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003173 */
David Howells65f27f32006-11-22 14:55:48 +00003174int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003175{
3176 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003177 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003178
Andrew Mortonb6136772006-06-25 05:47:49 -07003179 works = alloc_percpu(struct work_struct);
3180 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003181 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003182
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003183 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003184
Christoph Lameter15316ba2006-01-08 01:00:43 -08003185 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003186 struct work_struct *work = per_cpu_ptr(works, cpu);
3187
3188 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003189 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003190 }
Tejun Heo93981802009-11-17 14:06:20 -08003191
3192 for_each_online_cpu(cpu)
3193 flush_work(per_cpu_ptr(works, cpu));
3194
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003195 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003196 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003197 return 0;
3198}
3199
Alan Sterneef6a7d2010-02-12 17:39:21 +09003200/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003201 * execute_in_process_context - reliably execute the routine with user context
3202 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003203 * @ew: guaranteed storage for the execute work structure (must
3204 * be available when the work executes)
3205 *
3206 * Executes the function immediately if process context is available,
3207 * otherwise schedules the function for delayed execution.
3208 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003209 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003210 * 1 - function was scheduled for execution
3211 */
David Howells65f27f32006-11-22 14:55:48 +00003212int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003213{
3214 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003215 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003216 return 0;
3217 }
3218
David Howells65f27f32006-11-22 14:55:48 +00003219 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003220 schedule_work(&ew->work);
3221
3222 return 1;
3223}
3224EXPORT_SYMBOL_GPL(execute_in_process_context);
3225
Tejun Heo7a4e3442013-03-12 11:30:00 -07003226/**
3227 * free_workqueue_attrs - free a workqueue_attrs
3228 * @attrs: workqueue_attrs to free
3229 *
3230 * Undo alloc_workqueue_attrs().
3231 */
3232void free_workqueue_attrs(struct workqueue_attrs *attrs)
3233{
3234 if (attrs) {
3235 free_cpumask_var(attrs->cpumask);
3236 kfree(attrs);
3237 }
3238}
3239
3240/**
3241 * alloc_workqueue_attrs - allocate a workqueue_attrs
3242 * @gfp_mask: allocation mask to use
3243 *
3244 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003245 * return it.
3246 *
3247 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003248 */
3249struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3250{
3251 struct workqueue_attrs *attrs;
3252
3253 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3254 if (!attrs)
3255 goto fail;
3256 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3257 goto fail;
3258
Tejun Heo13e2e552013-04-01 11:23:31 -07003259 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003260 return attrs;
3261fail:
3262 free_workqueue_attrs(attrs);
3263 return NULL;
3264}
3265
Tejun Heo29c91e92013-03-12 11:30:03 -07003266static void copy_workqueue_attrs(struct workqueue_attrs *to,
3267 const struct workqueue_attrs *from)
3268{
3269 to->nice = from->nice;
3270 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003271 /*
3272 * Unlike hash and equality test, this function doesn't ignore
3273 * ->no_numa as it is used for both pool and wq attrs. Instead,
3274 * get_unbound_pool() explicitly clears ->no_numa after copying.
3275 */
3276 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003277}
3278
Tejun Heo29c91e92013-03-12 11:30:03 -07003279/* hash value of the content of @attr */
3280static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3281{
3282 u32 hash = 0;
3283
3284 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003285 hash = jhash(cpumask_bits(attrs->cpumask),
3286 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003287 return hash;
3288}
3289
3290/* content equality test */
3291static bool wqattrs_equal(const struct workqueue_attrs *a,
3292 const struct workqueue_attrs *b)
3293{
3294 if (a->nice != b->nice)
3295 return false;
3296 if (!cpumask_equal(a->cpumask, b->cpumask))
3297 return false;
3298 return true;
3299}
3300
Tejun Heo7a4e3442013-03-12 11:30:00 -07003301/**
3302 * init_worker_pool - initialize a newly zalloc'd worker_pool
3303 * @pool: worker_pool to initialize
3304 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303305 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003306 *
3307 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003308 * inside @pool proper are initialized and put_unbound_pool() can be called
3309 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003310 */
3311static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003312{
3313 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003314 pool->id = -1;
3315 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003316 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003317 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003318 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003319 INIT_LIST_HEAD(&pool->worklist);
3320 INIT_LIST_HEAD(&pool->idle_list);
3321 hash_init(pool->busy_hash);
3322
Kees Cook32a6c722017-10-16 15:58:25 -07003323 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003324
Kees Cook32a6c722017-10-16 15:58:25 -07003325 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003326
Lai Jiangshanda028462014-05-20 17:46:31 +08003327 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003328
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003329 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003330 INIT_HLIST_NODE(&pool->hash_node);
3331 pool->refcnt = 1;
3332
3333 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003334 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3335 if (!pool->attrs)
3336 return -ENOMEM;
3337 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003338}
3339
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003340static void rcu_free_wq(struct rcu_head *rcu)
3341{
3342 struct workqueue_struct *wq =
3343 container_of(rcu, struct workqueue_struct, rcu);
3344
3345 if (!(wq->flags & WQ_UNBOUND))
3346 free_percpu(wq->cpu_pwqs);
3347 else
3348 free_workqueue_attrs(wq->unbound_attrs);
3349
3350 kfree(wq->rescuer);
3351 kfree(wq);
3352}
3353
Tejun Heo29c91e92013-03-12 11:30:03 -07003354static void rcu_free_pool(struct rcu_head *rcu)
3355{
3356 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3357
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003358 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003359 free_workqueue_attrs(pool->attrs);
3360 kfree(pool);
3361}
3362
3363/**
3364 * put_unbound_pool - put a worker_pool
3365 * @pool: worker_pool to put
3366 *
3367 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003368 * safe manner. get_unbound_pool() calls this function on its failure path
3369 * and this function should be able to release pools which went through,
3370 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003371 *
3372 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003373 */
3374static void put_unbound_pool(struct worker_pool *pool)
3375{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003376 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003377 struct worker *worker;
3378
Tejun Heoa892cac2013-04-01 11:23:32 -07003379 lockdep_assert_held(&wq_pool_mutex);
3380
3381 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003382 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003383
3384 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003385 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003386 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003387 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003388
3389 /* release id and unhash */
3390 if (pool->id >= 0)
3391 idr_remove(&worker_pool_idr, pool->id);
3392 hash_del(&pool->hash_node);
3393
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003394 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003395 * Become the manager and destroy all workers. This prevents
3396 * @pool's workers from blocking on attach_mutex. We're the last
3397 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003398 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003399 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003400 wait_event_lock_irq(wq_manager_wait,
3401 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3402 pool->flags |= POOL_MANAGER_ACTIVE;
3403
Lai Jiangshan1037de32014-05-22 16:44:07 +08003404 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003405 destroy_worker(worker);
3406 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003407 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003408
Tejun Heo1258fae2018-05-18 08:47:13 -07003409 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003410 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003411 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003412 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003413
3414 if (pool->detach_completion)
3415 wait_for_completion(pool->detach_completion);
3416
Tejun Heo29c91e92013-03-12 11:30:03 -07003417 /* shut down the timers */
3418 del_timer_sync(&pool->idle_timer);
3419 del_timer_sync(&pool->mayday_timer);
3420
3421 /* sched-RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003422 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003423}
3424
3425/**
3426 * get_unbound_pool - get a worker_pool with the specified attributes
3427 * @attrs: the attributes of the worker_pool to get
3428 *
3429 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3430 * reference count and return it. If there already is a matching
3431 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003432 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003433 *
3434 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003435 *
3436 * Return: On success, a worker_pool with the same attributes as @attrs.
3437 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003438 */
3439static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3440{
Tejun Heo29c91e92013-03-12 11:30:03 -07003441 u32 hash = wqattrs_hash(attrs);
3442 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003443 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003444 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003445
Tejun Heoa892cac2013-04-01 11:23:32 -07003446 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003447
3448 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003449 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3450 if (wqattrs_equal(pool->attrs, attrs)) {
3451 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003452 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003453 }
3454 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003455
Xunlei Pange22735842015-10-09 11:53:12 +08003456 /* if cpumask is contained inside a NUMA node, we belong to that node */
3457 if (wq_numa_enabled) {
3458 for_each_node(node) {
3459 if (cpumask_subset(attrs->cpumask,
3460 wq_numa_possible_cpumask[node])) {
3461 target_node = node;
3462 break;
3463 }
3464 }
3465 }
3466
Tejun Heo29c91e92013-03-12 11:30:03 -07003467 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003468 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003469 if (!pool || init_worker_pool(pool) < 0)
3470 goto fail;
3471
Tejun Heo8864b4e2013-03-12 11:30:04 -07003472 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003473 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003474 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003475
Shaohua Li2865a8f2013-08-01 09:56:36 +08003476 /*
3477 * no_numa isn't a worker_pool attribute, always clear it. See
3478 * 'struct workqueue_attrs' comments for detail.
3479 */
3480 pool->attrs->no_numa = false;
3481
Tejun Heo29c91e92013-03-12 11:30:03 -07003482 if (worker_pool_assign_id(pool) < 0)
3483 goto fail;
3484
3485 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003486 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003487 goto fail;
3488
Tejun Heo29c91e92013-03-12 11:30:03 -07003489 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003490 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003491
Tejun Heo29c91e92013-03-12 11:30:03 -07003492 return pool;
3493fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003494 if (pool)
3495 put_unbound_pool(pool);
3496 return NULL;
3497}
3498
Tejun Heo8864b4e2013-03-12 11:30:04 -07003499static void rcu_free_pwq(struct rcu_head *rcu)
3500{
3501 kmem_cache_free(pwq_cache,
3502 container_of(rcu, struct pool_workqueue, rcu));
3503}
3504
3505/*
3506 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3507 * and needs to be destroyed.
3508 */
3509static void pwq_unbound_release_workfn(struct work_struct *work)
3510{
3511 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3512 unbound_release_work);
3513 struct workqueue_struct *wq = pwq->wq;
3514 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003515 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003516
3517 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3518 return;
3519
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003520 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003521 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003522 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003523 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003524
Tejun Heoa892cac2013-04-01 11:23:32 -07003525 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003526 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003527 mutex_unlock(&wq_pool_mutex);
3528
Paul E. McKenney25b00772018-11-06 19:18:45 -08003529 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003530
3531 /*
3532 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003533 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003534 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003535 if (is_last)
Paul E. McKenney25b00772018-11-06 19:18:45 -08003536 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003537}
3538
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003539/**
Tejun Heo699ce092013-03-13 16:51:35 -07003540 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003541 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003542 *
Tejun Heo699ce092013-03-13 16:51:35 -07003543 * If @pwq isn't freezing, set @pwq->max_active to the associated
3544 * workqueue's saved_max_active and activate delayed work items
3545 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003546 */
Tejun Heo699ce092013-03-13 16:51:35 -07003547static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003548{
Tejun Heo699ce092013-03-13 16:51:35 -07003549 struct workqueue_struct *wq = pwq->wq;
3550 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003551 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003552
Tejun Heo699ce092013-03-13 16:51:35 -07003553 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003554 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003555
3556 /* fast exit for non-freezable wqs */
3557 if (!freezable && pwq->max_active == wq->saved_max_active)
3558 return;
3559
Tejun Heo3347fa02016-09-16 15:49:32 -04003560 /* this function can be called during early boot w/ irq disabled */
3561 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003562
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003563 /*
3564 * During [un]freezing, the caller is responsible for ensuring that
3565 * this function is called at least once after @workqueue_freezing
3566 * is updated and visible.
3567 */
3568 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003569 pwq->max_active = wq->saved_max_active;
3570
3571 while (!list_empty(&pwq->delayed_works) &&
3572 pwq->nr_active < pwq->max_active)
3573 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003574
3575 /*
3576 * Need to kick a worker after thawed or an unbound wq's
3577 * max_active is bumped. It's a slow path. Do it always.
3578 */
3579 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003580 } else {
3581 pwq->max_active = 0;
3582 }
3583
Tejun Heo3347fa02016-09-16 15:49:32 -04003584 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003585}
3586
Tejun Heoe50aba92013-04-01 11:23:35 -07003587/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003588static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3589 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003590{
3591 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3592
Tejun Heoe50aba92013-04-01 11:23:35 -07003593 memset(pwq, 0, sizeof(*pwq));
3594
Tejun Heod2c1d402013-03-12 11:30:04 -07003595 pwq->pool = pool;
3596 pwq->wq = wq;
3597 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003598 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003599 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003600 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003601 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003602 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003603}
Tejun Heod2c1d402013-03-12 11:30:04 -07003604
Tejun Heof147f292013-04-01 11:23:35 -07003605/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003606static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003607{
3608 struct workqueue_struct *wq = pwq->wq;
3609
3610 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003611
Tejun Heo1befcf32013-04-01 11:23:35 -07003612 /* may be called multiple times, ignore if already linked */
3613 if (!list_empty(&pwq->pwqs_node))
3614 return;
3615
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003616 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003617 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003618
3619 /* sync max_active to the current setting */
3620 pwq_adjust_max_active(pwq);
3621
3622 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003623 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003624}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003625
Tejun Heof147f292013-04-01 11:23:35 -07003626/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3627static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3628 const struct workqueue_attrs *attrs)
3629{
3630 struct worker_pool *pool;
3631 struct pool_workqueue *pwq;
3632
3633 lockdep_assert_held(&wq_pool_mutex);
3634
3635 pool = get_unbound_pool(attrs);
3636 if (!pool)
3637 return NULL;
3638
Tejun Heoe50aba92013-04-01 11:23:35 -07003639 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003640 if (!pwq) {
3641 put_unbound_pool(pool);
3642 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003643 }
Tejun Heo6029a912013-04-01 11:23:34 -07003644
Tejun Heof147f292013-04-01 11:23:35 -07003645 init_pwq(pwq, wq, pool);
3646 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003647}
3648
Tejun Heo4c16bd32013-04-01 11:23:36 -07003649/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003650 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003651 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003652 * @node: the target NUMA node
3653 * @cpu_going_down: if >= 0, the CPU to consider as offline
3654 * @cpumask: outarg, the resulting cpumask
3655 *
3656 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3657 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003658 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003659 *
3660 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3661 * enabled and @node has online CPUs requested by @attrs, the returned
3662 * cpumask is the intersection of the possible CPUs of @node and
3663 * @attrs->cpumask.
3664 *
3665 * The caller is responsible for ensuring that the cpumask of @node stays
3666 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003667 *
3668 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3669 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003670 */
3671static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3672 int cpu_going_down, cpumask_t *cpumask)
3673{
Tejun Heod55262c2013-04-01 11:23:38 -07003674 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003675 goto use_dfl;
3676
3677 /* does @node have any online CPUs @attrs wants? */
3678 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3679 if (cpu_going_down >= 0)
3680 cpumask_clear_cpu(cpu_going_down, cpumask);
3681
3682 if (cpumask_empty(cpumask))
3683 goto use_dfl;
3684
3685 /* yeap, return possible CPUs in @node that @attrs wants */
3686 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003687
3688 if (cpumask_empty(cpumask)) {
3689 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3690 "possible intersect\n");
3691 return false;
3692 }
3693
Tejun Heo4c16bd32013-04-01 11:23:36 -07003694 return !cpumask_equal(cpumask, attrs->cpumask);
3695
3696use_dfl:
3697 cpumask_copy(cpumask, attrs->cpumask);
3698 return false;
3699}
3700
Tejun Heo1befcf32013-04-01 11:23:35 -07003701/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3702static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3703 int node,
3704 struct pool_workqueue *pwq)
3705{
3706 struct pool_workqueue *old_pwq;
3707
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003708 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003709 lockdep_assert_held(&wq->mutex);
3710
3711 /* link_pwq() can handle duplicate calls */
3712 link_pwq(pwq);
3713
3714 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3715 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3716 return old_pwq;
3717}
3718
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003719/* context to store the prepared attrs & pwqs before applying */
3720struct apply_wqattrs_ctx {
3721 struct workqueue_struct *wq; /* target workqueue */
3722 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003723 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003724 struct pool_workqueue *dfl_pwq;
3725 struct pool_workqueue *pwq_tbl[];
3726};
3727
3728/* free the resources after success or abort */
3729static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3730{
3731 if (ctx) {
3732 int node;
3733
3734 for_each_node(node)
3735 put_pwq_unlocked(ctx->pwq_tbl[node]);
3736 put_pwq_unlocked(ctx->dfl_pwq);
3737
3738 free_workqueue_attrs(ctx->attrs);
3739
3740 kfree(ctx);
3741 }
3742}
3743
3744/* allocate the attrs and pwqs for later installation */
3745static struct apply_wqattrs_ctx *
3746apply_wqattrs_prepare(struct workqueue_struct *wq,
3747 const struct workqueue_attrs *attrs)
3748{
3749 struct apply_wqattrs_ctx *ctx;
3750 struct workqueue_attrs *new_attrs, *tmp_attrs;
3751 int node;
3752
3753 lockdep_assert_held(&wq_pool_mutex);
3754
Kees Cookacafe7e2018-05-08 13:45:50 -07003755 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003756
3757 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3758 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3759 if (!ctx || !new_attrs || !tmp_attrs)
3760 goto out_free;
3761
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003762 /*
3763 * Calculate the attrs of the default pwq.
3764 * If the user configured cpumask doesn't overlap with the
3765 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3766 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003767 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003768 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003769 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3770 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003771
3772 /*
3773 * We may create multiple pwqs with differing cpumasks. Make a
3774 * copy of @new_attrs which will be modified and used to obtain
3775 * pools.
3776 */
3777 copy_workqueue_attrs(tmp_attrs, new_attrs);
3778
3779 /*
3780 * If something goes wrong during CPU up/down, we'll fall back to
3781 * the default pwq covering whole @attrs->cpumask. Always create
3782 * it even if we don't use it immediately.
3783 */
3784 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3785 if (!ctx->dfl_pwq)
3786 goto out_free;
3787
3788 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003789 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003790 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3791 if (!ctx->pwq_tbl[node])
3792 goto out_free;
3793 } else {
3794 ctx->dfl_pwq->refcnt++;
3795 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3796 }
3797 }
3798
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003799 /* save the user configured attrs and sanitize it. */
3800 copy_workqueue_attrs(new_attrs, attrs);
3801 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003802 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003803
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003804 ctx->wq = wq;
3805 free_workqueue_attrs(tmp_attrs);
3806 return ctx;
3807
3808out_free:
3809 free_workqueue_attrs(tmp_attrs);
3810 free_workqueue_attrs(new_attrs);
3811 apply_wqattrs_cleanup(ctx);
3812 return NULL;
3813}
3814
3815/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3816static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3817{
3818 int node;
3819
3820 /* all pwqs have been created successfully, let's install'em */
3821 mutex_lock(&ctx->wq->mutex);
3822
3823 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3824
3825 /* save the previous pwq and install the new one */
3826 for_each_node(node)
3827 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3828 ctx->pwq_tbl[node]);
3829
3830 /* @dfl_pwq might not have been used, ensure it's linked */
3831 link_pwq(ctx->dfl_pwq);
3832 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3833
3834 mutex_unlock(&ctx->wq->mutex);
3835}
3836
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003837static void apply_wqattrs_lock(void)
3838{
3839 /* CPUs should stay stable across pwq creations and installations */
3840 get_online_cpus();
3841 mutex_lock(&wq_pool_mutex);
3842}
3843
3844static void apply_wqattrs_unlock(void)
3845{
3846 mutex_unlock(&wq_pool_mutex);
3847 put_online_cpus();
3848}
3849
3850static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3851 const struct workqueue_attrs *attrs)
3852{
3853 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003854
3855 /* only unbound workqueues can change attributes */
3856 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3857 return -EINVAL;
3858
3859 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003860 if (!list_empty(&wq->pwqs)) {
3861 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3862 return -EINVAL;
3863
3864 wq->flags &= ~__WQ_ORDERED;
3865 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003866
3867 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003868 if (!ctx)
3869 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003870
3871 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003872 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003873 apply_wqattrs_cleanup(ctx);
3874
wanghaibin62011712016-01-07 20:38:59 +08003875 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003876}
3877
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003878/**
3879 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3880 * @wq: the target workqueue
3881 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3882 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003883 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3884 * machines, this function maps a separate pwq to each NUMA node with
3885 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3886 * NUMA node it was issued on. Older pwqs are released as in-flight work
3887 * items finish. Note that a work item which repeatedly requeues itself
3888 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003889 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003890 * Performs GFP_KERNEL allocations.
3891 *
3892 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003893 */
3894int apply_workqueue_attrs(struct workqueue_struct *wq,
3895 const struct workqueue_attrs *attrs)
3896{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003897 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003898
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003899 apply_wqattrs_lock();
3900 ret = apply_workqueue_attrs_locked(wq, attrs);
3901 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003902
Tejun Heo48621252013-04-01 11:23:31 -07003903 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003904}
NeilBrown6106c0f2018-01-11 15:06:40 +11003905EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003906
Tejun Heo4c16bd32013-04-01 11:23:36 -07003907/**
3908 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3909 * @wq: the target workqueue
3910 * @cpu: the CPU coming up or going down
3911 * @online: whether @cpu is coming up or going down
3912 *
3913 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3914 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3915 * @wq accordingly.
3916 *
3917 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3918 * falls back to @wq->dfl_pwq which may not be optimal but is always
3919 * correct.
3920 *
3921 * Note that when the last allowed CPU of a NUMA node goes offline for a
3922 * workqueue with a cpumask spanning multiple nodes, the workers which were
3923 * already executing the work items for the workqueue will lose their CPU
3924 * affinity and may execute on any CPU. This is similar to how per-cpu
3925 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3926 * affinity, it's the user's responsibility to flush the work item from
3927 * CPU_DOWN_PREPARE.
3928 */
3929static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3930 bool online)
3931{
3932 int node = cpu_to_node(cpu);
3933 int cpu_off = online ? -1 : cpu;
3934 struct pool_workqueue *old_pwq = NULL, *pwq;
3935 struct workqueue_attrs *target_attrs;
3936 cpumask_t *cpumask;
3937
3938 lockdep_assert_held(&wq_pool_mutex);
3939
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003940 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3941 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003942 return;
3943
3944 /*
3945 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3946 * Let's use a preallocated one. The following buf is protected by
3947 * CPU hotplug exclusion.
3948 */
3949 target_attrs = wq_update_unbound_numa_attrs_buf;
3950 cpumask = target_attrs->cpumask;
3951
Tejun Heo4c16bd32013-04-01 11:23:36 -07003952 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3953 pwq = unbound_pwq_by_node(wq, node);
3954
3955 /*
3956 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003957 * different from the default pwq's, we need to compare it to @pwq's
3958 * and create a new one if they don't match. If the target cpumask
3959 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003960 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003961 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003962 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003963 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003964 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003965 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003966 }
3967
Tejun Heo4c16bd32013-04-01 11:23:36 -07003968 /* create a new pwq */
3969 pwq = alloc_unbound_pwq(wq, target_attrs);
3970 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003971 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3972 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003973 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003974 }
3975
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003976 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003977 mutex_lock(&wq->mutex);
3978 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3979 goto out_unlock;
3980
3981use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003982 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003983 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3984 get_pwq(wq->dfl_pwq);
3985 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3986 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3987out_unlock:
3988 mutex_unlock(&wq->mutex);
3989 put_pwq_unlocked(old_pwq);
3990}
3991
Tejun Heo30cdf2492013-03-12 11:29:57 -07003992static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003993{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003994 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003995 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003996
Tejun Heo30cdf2492013-03-12 11:29:57 -07003997 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003998 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3999 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07004000 return -ENOMEM;
4001
4002 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004003 struct pool_workqueue *pwq =
4004 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07004005 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07004006 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004007
Tejun Heof147f292013-04-01 11:23:35 -07004008 init_pwq(pwq, wq, &cpu_pools[highpri]);
4009
4010 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07004011 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07004012 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004013 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004014 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004015 } else if (wq->flags & __WQ_ORDERED) {
4016 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4017 /* there should only be single pwq for ordering guarantee */
4018 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4019 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4020 "ordering guarantee broken for workqueue %s\n", wq->name);
4021 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07004022 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004023 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004024 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004025}
4026
Tejun Heof3421792010-07-02 10:03:51 +02004027static int wq_clamp_max_active(int max_active, unsigned int flags,
4028 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004029{
Tejun Heof3421792010-07-02 10:03:51 +02004030 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4031
4032 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004033 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4034 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004035
Tejun Heof3421792010-07-02 10:03:51 +02004036 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004037}
4038
Tejun Heo983c7512018-01-08 05:38:32 -08004039/*
4040 * Workqueues which may be used during memory reclaim should have a rescuer
4041 * to guarantee forward progress.
4042 */
4043static int init_rescuer(struct workqueue_struct *wq)
4044{
4045 struct worker *rescuer;
4046 int ret;
4047
4048 if (!(wq->flags & WQ_MEM_RECLAIM))
4049 return 0;
4050
4051 rescuer = alloc_worker(NUMA_NO_NODE);
4052 if (!rescuer)
4053 return -ENOMEM;
4054
4055 rescuer->rescue_wq = wq;
4056 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4057 ret = PTR_ERR_OR_ZERO(rescuer->task);
4058 if (ret) {
4059 kfree(rescuer);
4060 return ret;
4061 }
4062
4063 wq->rescuer = rescuer;
4064 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4065 wake_up_process(rescuer->task);
4066
4067 return 0;
4068}
4069
Tejun Heob196be82012-01-10 15:11:35 -08004070struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004071 unsigned int flags,
4072 int max_active,
4073 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004074 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004075{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004076 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004077 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004078 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004079 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004080
Tejun Heo5c0338c2017-07-18 18:41:52 -04004081 /*
4082 * Unbound && max_active == 1 used to imply ordered, which is no
4083 * longer the case on NUMA machines due to per-node pools. While
4084 * alloc_ordered_workqueue() is the right way to create an ordered
4085 * workqueue, keep the previous behavior to avoid subtle breakages
4086 * on NUMA.
4087 */
4088 if ((flags & WQ_UNBOUND) && max_active == 1)
4089 flags |= __WQ_ORDERED;
4090
Viresh Kumarcee22a12013-04-08 16:45:40 +05304091 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4092 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4093 flags |= WQ_UNBOUND;
4094
Tejun Heoecf68812013-04-01 11:23:34 -07004095 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004096 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004097 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004098
4099 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004100 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004101 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004102
Tejun Heo6029a912013-04-01 11:23:34 -07004103 if (flags & WQ_UNBOUND) {
4104 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4105 if (!wq->unbound_attrs)
4106 goto err_free_wq;
4107 }
4108
Tejun Heoecf68812013-04-01 11:23:34 -07004109 va_start(args, lock_name);
4110 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004111 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004112
Tejun Heod320c032010-06-29 10:07:14 +02004113 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004114 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004115
Tejun Heob196be82012-01-10 15:11:35 -08004116 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004117 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004118 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004119 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004120 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004121 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004122 INIT_LIST_HEAD(&wq->flusher_queue);
4123 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004124 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004125
Johannes Bergeb13ba82008-01-16 09:51:58 +01004126 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004127 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004128
Tejun Heo30cdf2492013-03-12 11:29:57 -07004129 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004130 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004131
Tejun Heo40c17f72018-01-08 05:38:37 -08004132 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004133 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004134
Tejun Heo226223a2013-03-12 11:30:05 -07004135 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4136 goto err_destroy;
4137
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004138 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004139 * wq_pool_mutex protects global freeze state and workqueues list.
4140 * Grab it, adjust max_active and add the new @wq to workqueues
4141 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004142 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004143 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004144
Lai Jiangshana357fc02013-03-25 16:57:19 -07004145 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004146 for_each_pwq(pwq, wq)
4147 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004148 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004149
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004150 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004151
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004152 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004153
Oleg Nesterov3af244332007-05-09 02:34:09 -07004154 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004155
4156err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004157 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004158 kfree(wq);
4159 return NULL;
4160err_destroy:
4161 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004162 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004163}
Tejun Heod320c032010-06-29 10:07:14 +02004164EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004165
4166/**
4167 * destroy_workqueue - safely terminate a workqueue
4168 * @wq: target workqueue
4169 *
4170 * Safely destroy a workqueue. All work currently pending will be done first.
4171 */
4172void destroy_workqueue(struct workqueue_struct *wq)
4173{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004174 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004175 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004176
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004177 /* drain it before proceeding with destruction */
4178 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004179
Tejun Heo6183c002013-03-12 11:29:57 -07004180 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004181 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004182 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004183 int i;
4184
Tejun Heo76af4d92013-03-12 11:30:00 -07004185 for (i = 0; i < WORK_NR_COLORS; i++) {
4186 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004187 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004188 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004189 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004190 }
4191 }
4192
Lai Jiangshan5c529592013-04-04 10:05:38 +08004193 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004194 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004195 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004196 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004197 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004198 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004199 }
Tejun Heo6183c002013-03-12 11:29:57 -07004200 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004201 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004202
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004203 /*
4204 * wq list is used to freeze wq, remove from list after
4205 * flushing is complete in case freeze races us.
4206 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004207 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004208 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004209 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004210
Tejun Heo226223a2013-03-12 11:30:05 -07004211 workqueue_sysfs_unregister(wq);
4212
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004213 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004214 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004215
Tejun Heo8864b4e2013-03-12 11:30:04 -07004216 if (!(wq->flags & WQ_UNBOUND)) {
4217 /*
4218 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004219 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004220 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004221 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004222 } else {
4223 /*
4224 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004225 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4226 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004227 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004228 for_each_node(node) {
4229 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4230 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4231 put_pwq_unlocked(pwq);
4232 }
4233
4234 /*
4235 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4236 * put. Don't access it afterwards.
4237 */
4238 pwq = wq->dfl_pwq;
4239 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004240 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004241 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004242}
4243EXPORT_SYMBOL_GPL(destroy_workqueue);
4244
Tejun Heodcd989c2010-06-29 10:07:14 +02004245/**
4246 * workqueue_set_max_active - adjust max_active of a workqueue
4247 * @wq: target workqueue
4248 * @max_active: new max_active value.
4249 *
4250 * Set max_active of @wq to @max_active.
4251 *
4252 * CONTEXT:
4253 * Don't call from IRQ context.
4254 */
4255void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4256{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004257 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004258
Tejun Heo8719dce2013-03-12 11:30:04 -07004259 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004260 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004261 return;
4262
Tejun Heof3421792010-07-02 10:03:51 +02004263 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004264
Lai Jiangshana357fc02013-03-25 16:57:19 -07004265 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004266
Tejun Heo0a94efb2017-07-23 08:36:15 -04004267 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004268 wq->saved_max_active = max_active;
4269
Tejun Heo699ce092013-03-13 16:51:35 -07004270 for_each_pwq(pwq, wq)
4271 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004272
Lai Jiangshana357fc02013-03-25 16:57:19 -07004273 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004274}
4275EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4276
4277/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004278 * current_work - retrieve %current task's work struct
4279 *
4280 * Determine if %current task is a workqueue worker and what it's working on.
4281 * Useful to find out the context that the %current task is running in.
4282 *
4283 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4284 */
4285struct work_struct *current_work(void)
4286{
4287 struct worker *worker = current_wq_worker();
4288
4289 return worker ? worker->current_work : NULL;
4290}
4291EXPORT_SYMBOL(current_work);
4292
4293/**
Tejun Heoe62676162013-03-12 17:41:37 -07004294 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4295 *
4296 * Determine whether %current is a workqueue rescuer. Can be used from
4297 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004298 *
4299 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004300 */
4301bool current_is_workqueue_rescuer(void)
4302{
4303 struct worker *worker = current_wq_worker();
4304
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004305 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004306}
4307
4308/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004309 * workqueue_congested - test whether a workqueue is congested
4310 * @cpu: CPU in question
4311 * @wq: target workqueue
4312 *
4313 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4314 * no synchronization around this function and the test result is
4315 * unreliable and only useful as advisory hints or for debugging.
4316 *
Tejun Heod3251852013-05-10 11:10:17 -07004317 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4318 * Note that both per-cpu and unbound workqueues may be associated with
4319 * multiple pool_workqueues which have separate congested states. A
4320 * workqueue being congested on one CPU doesn't mean the workqueue is also
4321 * contested on other CPUs / NUMA nodes.
4322 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004323 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004324 * %true if congested, %false otherwise.
4325 */
Tejun Heod84ff052013-03-12 11:29:59 -07004326bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004327{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004328 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004329 bool ret;
4330
Lai Jiangshan88109452013-03-20 03:28:10 +08004331 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004332
Tejun Heod3251852013-05-10 11:10:17 -07004333 if (cpu == WORK_CPU_UNBOUND)
4334 cpu = smp_processor_id();
4335
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004336 if (!(wq->flags & WQ_UNBOUND))
4337 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4338 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004339 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004340
Tejun Heo76af4d92013-03-12 11:30:00 -07004341 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004342 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004343
4344 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004345}
4346EXPORT_SYMBOL_GPL(workqueue_congested);
4347
4348/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004349 * work_busy - test whether a work is currently pending or running
4350 * @work: the work to be tested
4351 *
4352 * Test whether @work is currently pending or running. There is no
4353 * synchronization around this function and the test result is
4354 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004355 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004356 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004357 * OR'd bitmask of WORK_BUSY_* bits.
4358 */
4359unsigned int work_busy(struct work_struct *work)
4360{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004361 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004362 unsigned long flags;
4363 unsigned int ret = 0;
4364
Tejun Heodcd989c2010-06-29 10:07:14 +02004365 if (work_pending(work))
4366 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004367
Tejun Heofa1b54e2013-03-12 11:30:00 -07004368 local_irq_save(flags);
4369 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004370 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004371 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004372 if (find_worker_executing_work(pool, work))
4373 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004374 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004375 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004376 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004377
4378 return ret;
4379}
4380EXPORT_SYMBOL_GPL(work_busy);
4381
Tejun Heo3d1cb202013-04-30 15:27:22 -07004382/**
4383 * set_worker_desc - set description for the current work item
4384 * @fmt: printf-style format string
4385 * @...: arguments for the format string
4386 *
4387 * This function can be called by a running work function to describe what
4388 * the work item is about. If the worker task gets dumped, this
4389 * information will be printed out together to help debugging. The
4390 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4391 */
4392void set_worker_desc(const char *fmt, ...)
4393{
4394 struct worker *worker = current_wq_worker();
4395 va_list args;
4396
4397 if (worker) {
4398 va_start(args, fmt);
4399 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4400 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004401 }
4402}
Steffen Maier5c750d52018-05-17 19:14:57 +02004403EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004404
4405/**
4406 * print_worker_info - print out worker information and description
4407 * @log_lvl: the log level to use when printing
4408 * @task: target task
4409 *
4410 * If @task is a worker and currently executing a work item, print out the
4411 * name of the workqueue being serviced and worker description set with
4412 * set_worker_desc() by the currently executing work item.
4413 *
4414 * This function can be safely called on any task as long as the
4415 * task_struct itself is accessible. While safe, this function isn't
4416 * synchronized and may print out mixups or garbages of limited length.
4417 */
4418void print_worker_info(const char *log_lvl, struct task_struct *task)
4419{
4420 work_func_t *fn = NULL;
4421 char name[WQ_NAME_LEN] = { };
4422 char desc[WORKER_DESC_LEN] = { };
4423 struct pool_workqueue *pwq = NULL;
4424 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004425 struct worker *worker;
4426
4427 if (!(task->flags & PF_WQ_WORKER))
4428 return;
4429
4430 /*
4431 * This function is called without any synchronization and @task
4432 * could be in any state. Be careful with dereferences.
4433 */
Petr Mladeke7005912016-10-11 13:55:17 -07004434 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004435
4436 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004437 * Carefully copy the associated workqueue's workfn, name and desc.
4438 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004439 */
4440 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4441 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4442 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4443 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004444 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004445
4446 if (fn || name[0] || desc[0]) {
4447 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004448 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004449 pr_cont(" (%s)", desc);
4450 pr_cont("\n");
4451 }
4452}
4453
Tejun Heo3494fc32015-03-09 09:22:28 -04004454static void pr_cont_pool_info(struct worker_pool *pool)
4455{
4456 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4457 if (pool->node != NUMA_NO_NODE)
4458 pr_cont(" node=%d", pool->node);
4459 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4460}
4461
4462static void pr_cont_work(bool comma, struct work_struct *work)
4463{
4464 if (work->func == wq_barrier_func) {
4465 struct wq_barrier *barr;
4466
4467 barr = container_of(work, struct wq_barrier, work);
4468
4469 pr_cont("%s BAR(%d)", comma ? "," : "",
4470 task_pid_nr(barr->task));
4471 } else {
4472 pr_cont("%s %pf", comma ? "," : "", work->func);
4473 }
4474}
4475
4476static void show_pwq(struct pool_workqueue *pwq)
4477{
4478 struct worker_pool *pool = pwq->pool;
4479 struct work_struct *work;
4480 struct worker *worker;
4481 bool has_in_flight = false, has_pending = false;
4482 int bkt;
4483
4484 pr_info(" pwq %d:", pool->id);
4485 pr_cont_pool_info(pool);
4486
4487 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4488 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4489
4490 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4491 if (worker->current_pwq == pwq) {
4492 has_in_flight = true;
4493 break;
4494 }
4495 }
4496 if (has_in_flight) {
4497 bool comma = false;
4498
4499 pr_info(" in-flight:");
4500 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4501 if (worker->current_pwq != pwq)
4502 continue;
4503
4504 pr_cont("%s %d%s:%pf", comma ? "," : "",
4505 task_pid_nr(worker->task),
4506 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4507 worker->current_func);
4508 list_for_each_entry(work, &worker->scheduled, entry)
4509 pr_cont_work(false, work);
4510 comma = true;
4511 }
4512 pr_cont("\n");
4513 }
4514
4515 list_for_each_entry(work, &pool->worklist, entry) {
4516 if (get_work_pwq(work) == pwq) {
4517 has_pending = true;
4518 break;
4519 }
4520 }
4521 if (has_pending) {
4522 bool comma = false;
4523
4524 pr_info(" pending:");
4525 list_for_each_entry(work, &pool->worklist, entry) {
4526 if (get_work_pwq(work) != pwq)
4527 continue;
4528
4529 pr_cont_work(comma, work);
4530 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4531 }
4532 pr_cont("\n");
4533 }
4534
4535 if (!list_empty(&pwq->delayed_works)) {
4536 bool comma = false;
4537
4538 pr_info(" delayed:");
4539 list_for_each_entry(work, &pwq->delayed_works, entry) {
4540 pr_cont_work(comma, work);
4541 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4542 }
4543 pr_cont("\n");
4544 }
4545}
4546
4547/**
4548 * show_workqueue_state - dump workqueue state
4549 *
Roger Lu7b776af2016-07-01 11:05:02 +08004550 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4551 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004552 */
4553void show_workqueue_state(void)
4554{
4555 struct workqueue_struct *wq;
4556 struct worker_pool *pool;
4557 unsigned long flags;
4558 int pi;
4559
4560 rcu_read_lock_sched();
4561
4562 pr_info("Showing busy workqueues and worker pools:\n");
4563
4564 list_for_each_entry_rcu(wq, &workqueues, list) {
4565 struct pool_workqueue *pwq;
4566 bool idle = true;
4567
4568 for_each_pwq(pwq, wq) {
4569 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4570 idle = false;
4571 break;
4572 }
4573 }
4574 if (idle)
4575 continue;
4576
4577 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4578
4579 for_each_pwq(pwq, wq) {
4580 spin_lock_irqsave(&pwq->pool->lock, flags);
4581 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4582 show_pwq(pwq);
4583 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004584 /*
4585 * We could be printing a lot from atomic context, e.g.
4586 * sysrq-t -> show_workqueue_state(). Avoid triggering
4587 * hard lockup.
4588 */
4589 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004590 }
4591 }
4592
4593 for_each_pool(pool, pi) {
4594 struct worker *worker;
4595 bool first = true;
4596
4597 spin_lock_irqsave(&pool->lock, flags);
4598 if (pool->nr_workers == pool->nr_idle)
4599 goto next_pool;
4600
4601 pr_info("pool %d:", pool->id);
4602 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004603 pr_cont(" hung=%us workers=%d",
4604 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4605 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004606 if (pool->manager)
4607 pr_cont(" manager: %d",
4608 task_pid_nr(pool->manager->task));
4609 list_for_each_entry(worker, &pool->idle_list, entry) {
4610 pr_cont(" %s%d", first ? "idle: " : "",
4611 task_pid_nr(worker->task));
4612 first = false;
4613 }
4614 pr_cont("\n");
4615 next_pool:
4616 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004617 /*
4618 * We could be printing a lot from atomic context, e.g.
4619 * sysrq-t -> show_workqueue_state(). Avoid triggering
4620 * hard lockup.
4621 */
4622 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004623 }
4624
4625 rcu_read_unlock_sched();
4626}
4627
Tejun Heo6b598082018-05-18 08:47:13 -07004628/* used to show worker information through /proc/PID/{comm,stat,status} */
4629void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4630{
Tejun Heo6b598082018-05-18 08:47:13 -07004631 int off;
4632
4633 /* always show the actual comm */
4634 off = strscpy(buf, task->comm, size);
4635 if (off < 0)
4636 return;
4637
Tejun Heo197f6ac2018-05-21 08:04:35 -07004638 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004639 mutex_lock(&wq_pool_attach_mutex);
4640
Tejun Heo197f6ac2018-05-21 08:04:35 -07004641 if (task->flags & PF_WQ_WORKER) {
4642 struct worker *worker = kthread_data(task);
4643 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004644
Tejun Heo197f6ac2018-05-21 08:04:35 -07004645 if (pool) {
4646 spin_lock_irq(&pool->lock);
4647 /*
4648 * ->desc tracks information (wq name or
4649 * set_worker_desc()) for the latest execution. If
4650 * current, prepend '+', otherwise '-'.
4651 */
4652 if (worker->desc[0] != '\0') {
4653 if (worker->current_work)
4654 scnprintf(buf + off, size - off, "+%s",
4655 worker->desc);
4656 else
4657 scnprintf(buf + off, size - off, "-%s",
4658 worker->desc);
4659 }
4660 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004661 }
Tejun Heo6b598082018-05-18 08:47:13 -07004662 }
4663
4664 mutex_unlock(&wq_pool_attach_mutex);
4665}
4666
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004667#ifdef CONFIG_SMP
4668
Tejun Heodb7bccf2010-06-29 10:07:12 +02004669/*
4670 * CPU hotplug.
4671 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004672 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004673 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004674 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004675 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004676 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004677 * blocked draining impractical.
4678 *
Tejun Heo24647572013-01-24 11:01:33 -08004679 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004680 * running as an unbound one and allowing it to be reattached later if the
4681 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004682 */
4683
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004684static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004685{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004686 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004687 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004688
Tejun Heof02ae732013-03-12 11:30:03 -07004689 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004690 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004691 spin_lock_irq(&pool->lock);
4692
4693 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004694 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004695 * unbound and set DISASSOCIATED. Before this, all workers
4696 * except for the ones which are still executing works from
4697 * before the last CPU down must be on the cpu. After
4698 * this, they may become diasporas.
4699 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004700 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004701 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004702
Tejun Heo24647572013-01-24 11:01:33 -08004703 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004704
Tejun Heo94cf58b2013-01-24 11:01:33 -08004705 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004706 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004707
Lai Jiangshaneb283422013-03-08 15:18:28 -08004708 /*
4709 * Call schedule() so that we cross rq->lock and thus can
4710 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4711 * This is necessary as scheduler callbacks may be invoked
4712 * from other cpus.
4713 */
4714 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004715
Lai Jiangshaneb283422013-03-08 15:18:28 -08004716 /*
4717 * Sched callbacks are disabled now. Zap nr_running.
4718 * After this, nr_running stays zero and need_more_worker()
4719 * and keep_working() are always true as long as the
4720 * worklist is not empty. This pool now behaves as an
4721 * unbound (in terms of concurrency management) pool which
4722 * are served by workers tied to the pool.
4723 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004724 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004725
4726 /*
4727 * With concurrency management just turned off, a busy
4728 * worker blocking could lead to lengthy stalls. Kick off
4729 * unbound chain execution of currently pending work items.
4730 */
4731 spin_lock_irq(&pool->lock);
4732 wake_up_worker(pool);
4733 spin_unlock_irq(&pool->lock);
4734 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004735}
4736
Tejun Heobd7c0892013-03-19 13:45:21 -07004737/**
4738 * rebind_workers - rebind all workers of a pool to the associated CPU
4739 * @pool: pool of interest
4740 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004741 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004742 */
4743static void rebind_workers(struct worker_pool *pool)
4744{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004745 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004746
Tejun Heo1258fae2018-05-18 08:47:13 -07004747 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004748
Tejun Heoa9ab7752013-03-19 13:45:21 -07004749 /*
4750 * Restore CPU affinity of all workers. As all idle workers should
4751 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304752 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004753 * of all workers first and then clear UNBOUND. As we're called
4754 * from CPU_ONLINE, the following shouldn't fail.
4755 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004756 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004757 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4758 pool->attrs->cpumask) < 0);
4759
4760 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004761
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004762 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004763
Lai Jiangshanda028462014-05-20 17:46:31 +08004764 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004765 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004766
4767 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004768 * A bound idle worker should actually be on the runqueue
4769 * of the associated CPU for local wake-ups targeting it to
4770 * work. Kick all idle workers so that they migrate to the
4771 * associated CPU. Doing this in the same loop as
4772 * replacing UNBOUND with REBOUND is safe as no worker will
4773 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004774 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004775 if (worker_flags & WORKER_IDLE)
4776 wake_up_process(worker->task);
4777
4778 /*
4779 * We want to clear UNBOUND but can't directly call
4780 * worker_clr_flags() or adjust nr_running. Atomically
4781 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4782 * @worker will clear REBOUND using worker_clr_flags() when
4783 * it initiates the next execution cycle thus restoring
4784 * concurrency management. Note that when or whether
4785 * @worker clears REBOUND doesn't affect correctness.
4786 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004787 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004788 * tested without holding any lock in
4789 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4790 * fail incorrectly leading to premature concurrency
4791 * management operations.
4792 */
4793 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4794 worker_flags |= WORKER_REBOUND;
4795 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004796 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004797 }
4798
Tejun Heoa9ab7752013-03-19 13:45:21 -07004799 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004800}
4801
Tejun Heo7dbc7252013-03-19 13:45:21 -07004802/**
4803 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4804 * @pool: unbound pool of interest
4805 * @cpu: the CPU which is coming up
4806 *
4807 * An unbound pool may end up with a cpumask which doesn't have any online
4808 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4809 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4810 * online CPU before, cpus_allowed of all its workers should be restored.
4811 */
4812static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4813{
4814 static cpumask_t cpumask;
4815 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004816
Tejun Heo1258fae2018-05-18 08:47:13 -07004817 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004818
4819 /* is @cpu allowed for @pool? */
4820 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4821 return;
4822
Tejun Heo7dbc7252013-03-19 13:45:21 -07004823 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004824
4825 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004826 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004827 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004828}
4829
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004830int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004831{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004832 struct worker_pool *pool;
4833
4834 for_each_cpu_worker_pool(pool, cpu) {
4835 if (pool->nr_workers)
4836 continue;
4837 if (!create_worker(pool))
4838 return -ENOMEM;
4839 }
4840 return 0;
4841}
4842
4843int workqueue_online_cpu(unsigned int cpu)
4844{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004845 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004846 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004847 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004848
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004849 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004850
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004851 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004852 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004853
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004854 if (pool->cpu == cpu)
4855 rebind_workers(pool);
4856 else if (pool->cpu < 0)
4857 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004858
Tejun Heo1258fae2018-05-18 08:47:13 -07004859 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004860 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004861
4862 /* update NUMA affinity of unbound workqueues */
4863 list_for_each_entry(wq, &workqueues, list)
4864 wq_update_unbound_numa(wq, cpu, true);
4865
4866 mutex_unlock(&wq_pool_mutex);
4867 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004868}
4869
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004870int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004871{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004872 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004873
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004874 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004875 if (WARN_ON(cpu != smp_processor_id()))
4876 return -1;
4877
4878 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004879
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004880 /* update NUMA affinity of unbound workqueues */
4881 mutex_lock(&wq_pool_mutex);
4882 list_for_each_entry(wq, &workqueues, list)
4883 wq_update_unbound_numa(wq, cpu, false);
4884 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004885
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004886 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004887}
4888
Rusty Russell2d3854a2008-11-05 13:39:10 +11004889struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004890 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004891 long (*fn)(void *);
4892 void *arg;
4893 long ret;
4894};
4895
Tejun Heoed48ece2012-09-18 12:48:43 -07004896static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004897{
Tejun Heoed48ece2012-09-18 12:48:43 -07004898 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4899
Rusty Russell2d3854a2008-11-05 13:39:10 +11004900 wfc->ret = wfc->fn(wfc->arg);
4901}
4902
4903/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004904 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004905 * @cpu: the cpu to run on
4906 * @fn: the function to run
4907 * @arg: the function arg
4908 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004909 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004910 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004911 *
4912 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004913 */
Tejun Heod84ff052013-03-12 11:29:59 -07004914long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004915{
Tejun Heoed48ece2012-09-18 12:48:43 -07004916 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004917
Tejun Heoed48ece2012-09-18 12:48:43 -07004918 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4919 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004920 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004921 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004922 return wfc.ret;
4923}
4924EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004925
4926/**
4927 * work_on_cpu_safe - run a function in thread context on a particular cpu
4928 * @cpu: the cpu to run on
4929 * @fn: the function to run
4930 * @arg: the function argument
4931 *
4932 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4933 * any locks which would prevent @fn from completing.
4934 *
4935 * Return: The value @fn returns.
4936 */
4937long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4938{
4939 long ret = -ENODEV;
4940
4941 get_online_cpus();
4942 if (cpu_online(cpu))
4943 ret = work_on_cpu(cpu, fn, arg);
4944 put_online_cpus();
4945 return ret;
4946}
4947EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004948#endif /* CONFIG_SMP */
4949
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004950#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304951
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004952/**
4953 * freeze_workqueues_begin - begin freezing workqueues
4954 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004955 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004956 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004957 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004958 *
4959 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004960 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004961 */
4962void freeze_workqueues_begin(void)
4963{
Tejun Heo24b8a842013-03-12 11:29:58 -07004964 struct workqueue_struct *wq;
4965 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004966
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004967 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004968
Tejun Heo6183c002013-03-12 11:29:57 -07004969 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004970 workqueue_freezing = true;
4971
Tejun Heo24b8a842013-03-12 11:29:58 -07004972 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004973 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004974 for_each_pwq(pwq, wq)
4975 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004976 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004977 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004978
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004979 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004980}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004981
4982/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004983 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004984 *
4985 * Check whether freezing is complete. This function must be called
4986 * between freeze_workqueues_begin() and thaw_workqueues().
4987 *
4988 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004989 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004990 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004991 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004992 * %true if some freezable workqueues are still busy. %false if freezing
4993 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004994 */
4995bool freeze_workqueues_busy(void)
4996{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004997 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004998 struct workqueue_struct *wq;
4999 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005000
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005001 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005002
Tejun Heo6183c002013-03-12 11:29:57 -07005003 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005004
Tejun Heo24b8a842013-03-12 11:29:58 -07005005 list_for_each_entry(wq, &workqueues, list) {
5006 if (!(wq->flags & WQ_FREEZABLE))
5007 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005008 /*
5009 * nr_active is monotonically decreasing. It's safe
5010 * to peek without lock.
5011 */
Lai Jiangshan88109452013-03-20 03:28:10 +08005012 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07005013 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07005014 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08005015 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005016 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08005017 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005018 goto out_unlock;
5019 }
5020 }
Lai Jiangshan88109452013-03-20 03:28:10 +08005021 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005022 }
5023out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005024 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005025 return busy;
5026}
5027
5028/**
5029 * thaw_workqueues - thaw workqueues
5030 *
5031 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005032 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005033 *
5034 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005035 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005036 */
5037void thaw_workqueues(void)
5038{
Tejun Heo24b8a842013-03-12 11:29:58 -07005039 struct workqueue_struct *wq;
5040 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005041
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005042 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005043
5044 if (!workqueue_freezing)
5045 goto out_unlock;
5046
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005047 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005048
Tejun Heo24b8a842013-03-12 11:29:58 -07005049 /* restore max_active and repopulate worklist */
5050 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005051 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005052 for_each_pwq(pwq, wq)
5053 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005054 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005055 }
5056
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005057out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005058 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005059}
5060#endif /* CONFIG_FREEZER */
5061
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005062static int workqueue_apply_unbound_cpumask(void)
5063{
5064 LIST_HEAD(ctxs);
5065 int ret = 0;
5066 struct workqueue_struct *wq;
5067 struct apply_wqattrs_ctx *ctx, *n;
5068
5069 lockdep_assert_held(&wq_pool_mutex);
5070
5071 list_for_each_entry(wq, &workqueues, list) {
5072 if (!(wq->flags & WQ_UNBOUND))
5073 continue;
5074 /* creating multiple pwqs breaks ordering guarantee */
5075 if (wq->flags & __WQ_ORDERED)
5076 continue;
5077
5078 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5079 if (!ctx) {
5080 ret = -ENOMEM;
5081 break;
5082 }
5083
5084 list_add_tail(&ctx->list, &ctxs);
5085 }
5086
5087 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5088 if (!ret)
5089 apply_wqattrs_commit(ctx);
5090 apply_wqattrs_cleanup(ctx);
5091 }
5092
5093 return ret;
5094}
5095
5096/**
5097 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5098 * @cpumask: the cpumask to set
5099 *
5100 * The low-level workqueues cpumask is a global cpumask that limits
5101 * the affinity of all unbound workqueues. This function check the @cpumask
5102 * and apply it to all unbound workqueues and updates all pwqs of them.
5103 *
5104 * Retun: 0 - Success
5105 * -EINVAL - Invalid @cpumask
5106 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5107 */
5108int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5109{
5110 int ret = -EINVAL;
5111 cpumask_var_t saved_cpumask;
5112
5113 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5114 return -ENOMEM;
5115
Tal Shorerc98a9802017-11-03 17:27:50 +02005116 /*
5117 * Not excluding isolated cpus on purpose.
5118 * If the user wishes to include them, we allow that.
5119 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005120 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5121 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005122 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005123
5124 /* save the old wq_unbound_cpumask. */
5125 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5126
5127 /* update wq_unbound_cpumask at first and apply it to wqs. */
5128 cpumask_copy(wq_unbound_cpumask, cpumask);
5129 ret = workqueue_apply_unbound_cpumask();
5130
5131 /* restore the wq_unbound_cpumask when failed. */
5132 if (ret < 0)
5133 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5134
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005135 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005136 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005137
5138 free_cpumask_var(saved_cpumask);
5139 return ret;
5140}
5141
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005142#ifdef CONFIG_SYSFS
5143/*
5144 * Workqueues with WQ_SYSFS flag set is visible to userland via
5145 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5146 * following attributes.
5147 *
5148 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5149 * max_active RW int : maximum number of in-flight work items
5150 *
5151 * Unbound workqueues have the following extra attributes.
5152 *
Wang Long9a19b462017-11-02 23:05:12 -04005153 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005154 * nice RW int : nice value of the workers
5155 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005156 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005157 */
5158struct wq_device {
5159 struct workqueue_struct *wq;
5160 struct device dev;
5161};
5162
5163static struct workqueue_struct *dev_to_wq(struct device *dev)
5164{
5165 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5166
5167 return wq_dev->wq;
5168}
5169
5170static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5171 char *buf)
5172{
5173 struct workqueue_struct *wq = dev_to_wq(dev);
5174
5175 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5176}
5177static DEVICE_ATTR_RO(per_cpu);
5178
5179static ssize_t max_active_show(struct device *dev,
5180 struct device_attribute *attr, char *buf)
5181{
5182 struct workqueue_struct *wq = dev_to_wq(dev);
5183
5184 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5185}
5186
5187static ssize_t max_active_store(struct device *dev,
5188 struct device_attribute *attr, const char *buf,
5189 size_t count)
5190{
5191 struct workqueue_struct *wq = dev_to_wq(dev);
5192 int val;
5193
5194 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5195 return -EINVAL;
5196
5197 workqueue_set_max_active(wq, val);
5198 return count;
5199}
5200static DEVICE_ATTR_RW(max_active);
5201
5202static struct attribute *wq_sysfs_attrs[] = {
5203 &dev_attr_per_cpu.attr,
5204 &dev_attr_max_active.attr,
5205 NULL,
5206};
5207ATTRIBUTE_GROUPS(wq_sysfs);
5208
5209static ssize_t wq_pool_ids_show(struct device *dev,
5210 struct device_attribute *attr, char *buf)
5211{
5212 struct workqueue_struct *wq = dev_to_wq(dev);
5213 const char *delim = "";
5214 int node, written = 0;
5215
5216 rcu_read_lock_sched();
5217 for_each_node(node) {
5218 written += scnprintf(buf + written, PAGE_SIZE - written,
5219 "%s%d:%d", delim, node,
5220 unbound_pwq_by_node(wq, node)->pool->id);
5221 delim = " ";
5222 }
5223 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5224 rcu_read_unlock_sched();
5225
5226 return written;
5227}
5228
5229static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5230 char *buf)
5231{
5232 struct workqueue_struct *wq = dev_to_wq(dev);
5233 int written;
5234
5235 mutex_lock(&wq->mutex);
5236 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5237 mutex_unlock(&wq->mutex);
5238
5239 return written;
5240}
5241
5242/* prepare workqueue_attrs for sysfs store operations */
5243static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5244{
5245 struct workqueue_attrs *attrs;
5246
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005247 lockdep_assert_held(&wq_pool_mutex);
5248
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005249 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5250 if (!attrs)
5251 return NULL;
5252
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005253 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005254 return attrs;
5255}
5256
5257static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5258 const char *buf, size_t count)
5259{
5260 struct workqueue_struct *wq = dev_to_wq(dev);
5261 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005262 int ret = -ENOMEM;
5263
5264 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005265
5266 attrs = wq_sysfs_prep_attrs(wq);
5267 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005268 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005269
5270 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5271 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005272 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005273 else
5274 ret = -EINVAL;
5275
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005276out_unlock:
5277 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005278 free_workqueue_attrs(attrs);
5279 return ret ?: count;
5280}
5281
5282static ssize_t wq_cpumask_show(struct device *dev,
5283 struct device_attribute *attr, char *buf)
5284{
5285 struct workqueue_struct *wq = dev_to_wq(dev);
5286 int written;
5287
5288 mutex_lock(&wq->mutex);
5289 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5290 cpumask_pr_args(wq->unbound_attrs->cpumask));
5291 mutex_unlock(&wq->mutex);
5292 return written;
5293}
5294
5295static ssize_t wq_cpumask_store(struct device *dev,
5296 struct device_attribute *attr,
5297 const char *buf, size_t count)
5298{
5299 struct workqueue_struct *wq = dev_to_wq(dev);
5300 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005301 int ret = -ENOMEM;
5302
5303 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005304
5305 attrs = wq_sysfs_prep_attrs(wq);
5306 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005307 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005308
5309 ret = cpumask_parse(buf, attrs->cpumask);
5310 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005311 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005312
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005313out_unlock:
5314 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005315 free_workqueue_attrs(attrs);
5316 return ret ?: count;
5317}
5318
5319static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5320 char *buf)
5321{
5322 struct workqueue_struct *wq = dev_to_wq(dev);
5323 int written;
5324
5325 mutex_lock(&wq->mutex);
5326 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5327 !wq->unbound_attrs->no_numa);
5328 mutex_unlock(&wq->mutex);
5329
5330 return written;
5331}
5332
5333static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5334 const char *buf, size_t count)
5335{
5336 struct workqueue_struct *wq = dev_to_wq(dev);
5337 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005338 int v, ret = -ENOMEM;
5339
5340 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005341
5342 attrs = wq_sysfs_prep_attrs(wq);
5343 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005344 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005345
5346 ret = -EINVAL;
5347 if (sscanf(buf, "%d", &v) == 1) {
5348 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005349 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005350 }
5351
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005352out_unlock:
5353 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005354 free_workqueue_attrs(attrs);
5355 return ret ?: count;
5356}
5357
5358static struct device_attribute wq_sysfs_unbound_attrs[] = {
5359 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5360 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5361 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5362 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5363 __ATTR_NULL,
5364};
5365
5366static struct bus_type wq_subsys = {
5367 .name = "workqueue",
5368 .dev_groups = wq_sysfs_groups,
5369};
5370
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005371static ssize_t wq_unbound_cpumask_show(struct device *dev,
5372 struct device_attribute *attr, char *buf)
5373{
5374 int written;
5375
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005376 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005377 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5378 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005379 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005380
5381 return written;
5382}
5383
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005384static ssize_t wq_unbound_cpumask_store(struct device *dev,
5385 struct device_attribute *attr, const char *buf, size_t count)
5386{
5387 cpumask_var_t cpumask;
5388 int ret;
5389
5390 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5391 return -ENOMEM;
5392
5393 ret = cpumask_parse(buf, cpumask);
5394 if (!ret)
5395 ret = workqueue_set_unbound_cpumask(cpumask);
5396
5397 free_cpumask_var(cpumask);
5398 return ret ? ret : count;
5399}
5400
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005401static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005402 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5403 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005404
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005405static int __init wq_sysfs_init(void)
5406{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005407 int err;
5408
5409 err = subsys_virtual_register(&wq_subsys, NULL);
5410 if (err)
5411 return err;
5412
5413 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005414}
5415core_initcall(wq_sysfs_init);
5416
5417static void wq_device_release(struct device *dev)
5418{
5419 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5420
5421 kfree(wq_dev);
5422}
5423
5424/**
5425 * workqueue_sysfs_register - make a workqueue visible in sysfs
5426 * @wq: the workqueue to register
5427 *
5428 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5429 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5430 * which is the preferred method.
5431 *
5432 * Workqueue user should use this function directly iff it wants to apply
5433 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5434 * apply_workqueue_attrs() may race against userland updating the
5435 * attributes.
5436 *
5437 * Return: 0 on success, -errno on failure.
5438 */
5439int workqueue_sysfs_register(struct workqueue_struct *wq)
5440{
5441 struct wq_device *wq_dev;
5442 int ret;
5443
5444 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305445 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005446 * attributes breaks ordering guarantee. Disallow exposing ordered
5447 * workqueues.
5448 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005449 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005450 return -EINVAL;
5451
5452 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5453 if (!wq_dev)
5454 return -ENOMEM;
5455
5456 wq_dev->wq = wq;
5457 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005458 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005459 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005460
5461 /*
5462 * unbound_attrs are created separately. Suppress uevent until
5463 * everything is ready.
5464 */
5465 dev_set_uevent_suppress(&wq_dev->dev, true);
5466
5467 ret = device_register(&wq_dev->dev);
5468 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305469 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005470 wq->wq_dev = NULL;
5471 return ret;
5472 }
5473
5474 if (wq->flags & WQ_UNBOUND) {
5475 struct device_attribute *attr;
5476
5477 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5478 ret = device_create_file(&wq_dev->dev, attr);
5479 if (ret) {
5480 device_unregister(&wq_dev->dev);
5481 wq->wq_dev = NULL;
5482 return ret;
5483 }
5484 }
5485 }
5486
5487 dev_set_uevent_suppress(&wq_dev->dev, false);
5488 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5489 return 0;
5490}
5491
5492/**
5493 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5494 * @wq: the workqueue to unregister
5495 *
5496 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5497 */
5498static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5499{
5500 struct wq_device *wq_dev = wq->wq_dev;
5501
5502 if (!wq->wq_dev)
5503 return;
5504
5505 wq->wq_dev = NULL;
5506 device_unregister(&wq_dev->dev);
5507}
5508#else /* CONFIG_SYSFS */
5509static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5510#endif /* CONFIG_SYSFS */
5511
Tejun Heo82607adc2015-12-08 11:28:04 -05005512/*
5513 * Workqueue watchdog.
5514 *
5515 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5516 * flush dependency, a concurrency managed work item which stays RUNNING
5517 * indefinitely. Workqueue stalls can be very difficult to debug as the
5518 * usual warning mechanisms don't trigger and internal workqueue state is
5519 * largely opaque.
5520 *
5521 * Workqueue watchdog monitors all worker pools periodically and dumps
5522 * state if some pools failed to make forward progress for a while where
5523 * forward progress is defined as the first item on ->worklist changing.
5524 *
5525 * This mechanism is controlled through the kernel parameter
5526 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5527 * corresponding sysfs parameter file.
5528 */
5529#ifdef CONFIG_WQ_WATCHDOG
5530
Tejun Heo82607adc2015-12-08 11:28:04 -05005531static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005532static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005533
5534static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5535static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5536
5537static void wq_watchdog_reset_touched(void)
5538{
5539 int cpu;
5540
5541 wq_watchdog_touched = jiffies;
5542 for_each_possible_cpu(cpu)
5543 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5544}
5545
Kees Cook5cd79d62017-10-04 16:27:00 -07005546static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005547{
5548 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5549 bool lockup_detected = false;
5550 struct worker_pool *pool;
5551 int pi;
5552
5553 if (!thresh)
5554 return;
5555
5556 rcu_read_lock();
5557
5558 for_each_pool(pool, pi) {
5559 unsigned long pool_ts, touched, ts;
5560
5561 if (list_empty(&pool->worklist))
5562 continue;
5563
5564 /* get the latest of pool and touched timestamps */
5565 pool_ts = READ_ONCE(pool->watchdog_ts);
5566 touched = READ_ONCE(wq_watchdog_touched);
5567
5568 if (time_after(pool_ts, touched))
5569 ts = pool_ts;
5570 else
5571 ts = touched;
5572
5573 if (pool->cpu >= 0) {
5574 unsigned long cpu_touched =
5575 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5576 pool->cpu));
5577 if (time_after(cpu_touched, ts))
5578 ts = cpu_touched;
5579 }
5580
5581 /* did we stall? */
5582 if (time_after(jiffies, ts + thresh)) {
5583 lockup_detected = true;
5584 pr_emerg("BUG: workqueue lockup - pool");
5585 pr_cont_pool_info(pool);
5586 pr_cont(" stuck for %us!\n",
5587 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5588 }
5589 }
5590
5591 rcu_read_unlock();
5592
5593 if (lockup_detected)
5594 show_workqueue_state();
5595
5596 wq_watchdog_reset_touched();
5597 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5598}
5599
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005600notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005601{
5602 if (cpu >= 0)
5603 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5604 else
5605 wq_watchdog_touched = jiffies;
5606}
5607
5608static void wq_watchdog_set_thresh(unsigned long thresh)
5609{
5610 wq_watchdog_thresh = 0;
5611 del_timer_sync(&wq_watchdog_timer);
5612
5613 if (thresh) {
5614 wq_watchdog_thresh = thresh;
5615 wq_watchdog_reset_touched();
5616 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5617 }
5618}
5619
5620static int wq_watchdog_param_set_thresh(const char *val,
5621 const struct kernel_param *kp)
5622{
5623 unsigned long thresh;
5624 int ret;
5625
5626 ret = kstrtoul(val, 0, &thresh);
5627 if (ret)
5628 return ret;
5629
5630 if (system_wq)
5631 wq_watchdog_set_thresh(thresh);
5632 else
5633 wq_watchdog_thresh = thresh;
5634
5635 return 0;
5636}
5637
5638static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5639 .set = wq_watchdog_param_set_thresh,
5640 .get = param_get_ulong,
5641};
5642
5643module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5644 0644);
5645
5646static void wq_watchdog_init(void)
5647{
Kees Cook5cd79d62017-10-04 16:27:00 -07005648 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005649 wq_watchdog_set_thresh(wq_watchdog_thresh);
5650}
5651
5652#else /* CONFIG_WQ_WATCHDOG */
5653
5654static inline void wq_watchdog_init(void) { }
5655
5656#endif /* CONFIG_WQ_WATCHDOG */
5657
Tejun Heobce90382013-04-01 11:23:32 -07005658static void __init wq_numa_init(void)
5659{
5660 cpumask_var_t *tbl;
5661 int node, cpu;
5662
Tejun Heobce90382013-04-01 11:23:32 -07005663 if (num_possible_nodes() <= 1)
5664 return;
5665
Tejun Heod55262c2013-04-01 11:23:38 -07005666 if (wq_disable_numa) {
5667 pr_info("workqueue: NUMA affinity support disabled\n");
5668 return;
5669 }
5670
Tejun Heo4c16bd32013-04-01 11:23:36 -07005671 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5672 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5673
Tejun Heobce90382013-04-01 11:23:32 -07005674 /*
5675 * We want masks of possible CPUs of each node which isn't readily
5676 * available. Build one from cpu_to_node() which should have been
5677 * fully initialized by now.
5678 */
Kees Cook6396bb22018-06-12 14:03:40 -07005679 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005680 BUG_ON(!tbl);
5681
5682 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005683 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005684 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005685
5686 for_each_possible_cpu(cpu) {
5687 node = cpu_to_node(cpu);
5688 if (WARN_ON(node == NUMA_NO_NODE)) {
5689 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5690 /* happens iff arch is bonkers, let's just proceed */
5691 return;
5692 }
5693 cpumask_set_cpu(cpu, tbl[node]);
5694 }
5695
5696 wq_numa_possible_cpumask = tbl;
5697 wq_numa_enabled = true;
5698}
5699
Tejun Heo3347fa02016-09-16 15:49:32 -04005700/**
5701 * workqueue_init_early - early init for workqueue subsystem
5702 *
5703 * This is the first half of two-staged workqueue subsystem initialization
5704 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5705 * idr are up. It sets up all the data structures and system workqueues
5706 * and allows early boot code to create workqueues and queue/cancel work
5707 * items. Actual work item execution starts only after kthreads can be
5708 * created and scheduled right before early initcalls.
5709 */
5710int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005711{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005712 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005713 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005714 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005715
Tejun Heoe904e6c2013-03-12 11:29:57 -07005716 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5717
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005718 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005719 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005720
Tejun Heoe904e6c2013-03-12 11:29:57 -07005721 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5722
Tejun Heo706026c2013-01-24 11:01:34 -08005723 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005724 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005725 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005726
Tejun Heo7a4e3442013-03-12 11:30:00 -07005727 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005728 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005729 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005730 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005731 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005732 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005733 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005734
Tejun Heo9daf9e62013-01-24 11:01:33 -08005735 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005736 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005737 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005738 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005739 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005740 }
5741
Tejun Heo8a2b7532013-09-05 12:30:04 -04005742 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005743 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5744 struct workqueue_attrs *attrs;
5745
5746 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005747 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005748 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005749
5750 /*
5751 * An ordered wq should have only one pwq as ordering is
5752 * guaranteed by max_active which is enforced by pwqs.
5753 * Turn off NUMA so that dfl_pwq is used for all nodes.
5754 */
5755 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5756 attrs->nice = std_nice[i];
5757 attrs->no_numa = true;
5758 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005759 }
5760
Tejun Heod320c032010-06-29 10:07:14 +02005761 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005762 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005763 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005764 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5765 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005766 system_freezable_wq = alloc_workqueue("events_freezable",
5767 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305768 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5769 WQ_POWER_EFFICIENT, 0);
5770 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5771 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5772 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005773 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305774 !system_unbound_wq || !system_freezable_wq ||
5775 !system_power_efficient_wq ||
5776 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005777
Tejun Heo3347fa02016-09-16 15:49:32 -04005778 return 0;
5779}
5780
5781/**
5782 * workqueue_init - bring workqueue subsystem fully online
5783 *
5784 * This is the latter half of two-staged workqueue subsystem initialization
5785 * and invoked as soon as kthreads can be created and scheduled.
5786 * Workqueues have been created and work items queued on them, but there
5787 * are no kworkers executing the work items yet. Populate the worker pools
5788 * with the initial workers and enable future kworker creations.
5789 */
5790int __init workqueue_init(void)
5791{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005792 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005793 struct worker_pool *pool;
5794 int cpu, bkt;
5795
Tejun Heo2186d9f2016-10-19 12:01:27 -04005796 /*
5797 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5798 * CPU to node mapping may not be available that early on some
5799 * archs such as power and arm64. As per-cpu pools created
5800 * previously could be missing node hint and unbound pools NUMA
5801 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005802 *
5803 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005804 */
5805 wq_numa_init();
5806
5807 mutex_lock(&wq_pool_mutex);
5808
5809 for_each_possible_cpu(cpu) {
5810 for_each_cpu_worker_pool(pool, cpu) {
5811 pool->node = cpu_to_node(cpu);
5812 }
5813 }
5814
Tejun Heo40c17f72018-01-08 05:38:37 -08005815 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005816 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005817 WARN(init_rescuer(wq),
5818 "workqueue: failed to create early rescuer for %s",
5819 wq->name);
5820 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005821
5822 mutex_unlock(&wq_pool_mutex);
5823
Tejun Heo3347fa02016-09-16 15:49:32 -04005824 /* create the initial workers */
5825 for_each_online_cpu(cpu) {
5826 for_each_cpu_worker_pool(pool, cpu) {
5827 pool->flags &= ~POOL_DISASSOCIATED;
5828 BUG_ON(!create_worker(pool));
5829 }
5830 }
5831
5832 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5833 BUG_ON(!create_worker(pool));
5834
5835 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005836 wq_watchdog_init();
5837
Suresh Siddha6ee05782010-07-30 14:57:37 -07005838 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005839}