blob: a503ad9d0aec849e3bb1929b389eab3abb4236ad [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/**
913 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200914 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200915 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200916 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800917 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200918 *
Tejun Heocb444762010-07-02 10:03:50 +0200919 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800920 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200921 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800922static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200923{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700924 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200925
Tejun Heocb444762010-07-02 10:03:50 +0200926 WARN_ON_ONCE(worker->task != current);
927
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800928 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200929 if ((flags & WORKER_NOT_RUNNING) &&
930 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800931 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200932 }
933
Tejun Heod302f012010-06-29 10:07:13 +0200934 worker->flags |= flags;
935}
936
937/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200938 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200939 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200940 * @flags: flags to clear
941 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200942 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200943 *
Tejun Heocb444762010-07-02 10:03:50 +0200944 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800945 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200946 */
947static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
948{
Tejun Heo63d95a92012-07-12 14:46:37 -0700949 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200950 unsigned int oflags = worker->flags;
951
Tejun Heocb444762010-07-02 10:03:50 +0200952 WARN_ON_ONCE(worker->task != current);
953
Tejun Heod302f012010-06-29 10:07:13 +0200954 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200955
Tejun Heo42c025f2011-01-11 15:58:49 +0100956 /*
957 * If transitioning out of NOT_RUNNING, increment nr_running. Note
958 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
959 * of multiple flags, not a single flag.
960 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200961 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
962 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800963 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200964}
965
966/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200967 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800968 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200969 * @work: work to find worker for
970 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800971 * Find a worker which is executing @work on @pool by searching
972 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800973 * to match, its current execution should match the address of @work and
974 * its work function. This is to avoid unwanted dependency between
975 * unrelated work executions through a work item being recycled while still
976 * being executed.
977 *
978 * This is a bit tricky. A work item may be freed once its execution
979 * starts and nothing prevents the freed area from being recycled for
980 * another work item. If the same work item address ends up being reused
981 * before the original execution finishes, workqueue will identify the
982 * recycled work item as currently executing and make it wait until the
983 * current execution finishes, introducing an unwanted dependency.
984 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700985 * This function checks the work item address and work function to avoid
986 * false positives. Note that this isn't complete as one may construct a
987 * work function which can introduce dependency onto itself through a
988 * recycled work item. Well, if somebody wants to shoot oneself in the
989 * foot that badly, there's only so much we can do, and if such deadlock
990 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200991 *
992 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800993 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200994 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700995 * Return:
996 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200997 * otherwise.
998 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800999static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001000 struct work_struct *work)
1001{
Sasha Levin42f85702012-12-17 10:01:23 -05001002 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -05001003
Sasha Levinb67bfe02013-02-27 17:06:00 -08001004 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -08001005 (unsigned long)work)
1006 if (worker->current_work == work &&
1007 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -05001008 return worker;
1009
1010 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001011}
1012
1013/**
Tejun Heobf4ede02012-08-03 10:30:46 -07001014 * move_linked_works - move linked works to a list
1015 * @work: start of series of works to be scheduled
1016 * @head: target list to append @work to
Shailendra Verma402dd892015-05-23 10:38:14 +05301017 * @nextp: out parameter for nested worklist walking
Tejun Heobf4ede02012-08-03 10:30:46 -07001018 *
1019 * Schedule linked works starting from @work to @head. Work series to
1020 * be scheduled starts at @work and includes any consecutive work with
1021 * WORK_STRUCT_LINKED set in its predecessor.
1022 *
1023 * If @nextp is not NULL, it's updated to point to the next work of
1024 * the last scheduled work. This allows move_linked_works() to be
1025 * nested inside outer list_for_each_entry_safe().
1026 *
1027 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001028 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001029 */
1030static void move_linked_works(struct work_struct *work, struct list_head *head,
1031 struct work_struct **nextp)
1032{
1033 struct work_struct *n;
1034
1035 /*
1036 * Linked worklist will always end before the end of the list,
1037 * use NULL for list head.
1038 */
1039 list_for_each_entry_safe_from(work, n, NULL, entry) {
1040 list_move_tail(&work->entry, head);
1041 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1042 break;
1043 }
1044
1045 /*
1046 * If we're already inside safe list traversal and have moved
1047 * multiple works to the scheduled queue, the next position
1048 * needs to be updated.
1049 */
1050 if (nextp)
1051 *nextp = n;
1052}
1053
Tejun Heo8864b4e2013-03-12 11:30:04 -07001054/**
1055 * get_pwq - get an extra reference on the specified pool_workqueue
1056 * @pwq: pool_workqueue to get
1057 *
1058 * Obtain an extra reference on @pwq. The caller should guarantee that
1059 * @pwq has positive refcnt and be holding the matching pool->lock.
1060 */
1061static void get_pwq(struct pool_workqueue *pwq)
1062{
1063 lockdep_assert_held(&pwq->pool->lock);
1064 WARN_ON_ONCE(pwq->refcnt <= 0);
1065 pwq->refcnt++;
1066}
1067
1068/**
1069 * put_pwq - put a pool_workqueue reference
1070 * @pwq: pool_workqueue to put
1071 *
1072 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1073 * destruction. The caller should be holding the matching pool->lock.
1074 */
1075static void put_pwq(struct pool_workqueue *pwq)
1076{
1077 lockdep_assert_held(&pwq->pool->lock);
1078 if (likely(--pwq->refcnt))
1079 return;
1080 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1081 return;
1082 /*
1083 * @pwq can't be released under pool->lock, bounce to
1084 * pwq_unbound_release_workfn(). This never recurses on the same
1085 * pool->lock as this path is taken only for unbound workqueues and
1086 * the release work item is scheduled on a per-cpu workqueue. To
1087 * avoid lockdep warning, unbound pool->locks are given lockdep
1088 * subclass of 1 in get_unbound_pool().
1089 */
1090 schedule_work(&pwq->unbound_release_work);
1091}
1092
Tejun Heodce90d42013-04-01 11:23:35 -07001093/**
1094 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1095 * @pwq: pool_workqueue to put (can be %NULL)
1096 *
1097 * put_pwq() with locking. This function also allows %NULL @pwq.
1098 */
1099static void put_pwq_unlocked(struct pool_workqueue *pwq)
1100{
1101 if (pwq) {
1102 /*
1103 * As both pwqs and pools are sched-RCU protected, the
1104 * following lock operations are safe.
1105 */
1106 spin_lock_irq(&pwq->pool->lock);
1107 put_pwq(pwq);
1108 spin_unlock_irq(&pwq->pool->lock);
1109 }
1110}
1111
Tejun Heo112202d2013-02-13 19:29:12 -08001112static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001113{
Tejun Heo112202d2013-02-13 19:29:12 -08001114 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001115
1116 trace_workqueue_activate_work(work);
Tejun Heo82607adc2015-12-08 11:28:04 -05001117 if (list_empty(&pwq->pool->worklist))
1118 pwq->pool->watchdog_ts = jiffies;
Tejun Heo112202d2013-02-13 19:29:12 -08001119 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001120 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001121 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001122}
1123
Tejun Heo112202d2013-02-13 19:29:12 -08001124static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001125{
Tejun Heo112202d2013-02-13 19:29:12 -08001126 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001127 struct work_struct, entry);
1128
Tejun Heo112202d2013-02-13 19:29:12 -08001129 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001130}
1131
Tejun Heobf4ede02012-08-03 10:30:46 -07001132/**
Tejun Heo112202d2013-02-13 19:29:12 -08001133 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1134 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001135 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001136 *
1137 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001138 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001139 *
1140 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001141 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001142 */
Tejun Heo112202d2013-02-13 19:29:12 -08001143static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001144{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001145 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001146 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001147 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001148
Tejun Heo112202d2013-02-13 19:29:12 -08001149 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001150
Tejun Heo112202d2013-02-13 19:29:12 -08001151 pwq->nr_active--;
1152 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001153 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001154 if (pwq->nr_active < pwq->max_active)
1155 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001156 }
1157
1158 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001159 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001160 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001161
1162 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001163 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001164 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001165
Tejun Heo112202d2013-02-13 19:29:12 -08001166 /* this pwq is done, clear flush_color */
1167 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001168
1169 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001170 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001171 * will handle the rest.
1172 */
Tejun Heo112202d2013-02-13 19:29:12 -08001173 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1174 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001175out_put:
1176 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001177}
1178
Tejun Heo36e227d2012-08-03 10:30:46 -07001179/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001180 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001181 * @work: work item to steal
1182 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001183 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001184 *
1185 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001186 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001187 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001188 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001189 * 1 if @work was pending and we successfully stole PENDING
1190 * 0 if @work was idle and we claimed PENDING
1191 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001192 * -ENOENT if someone else is canceling @work, this state may persist
1193 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001194 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001195 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001196 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001197 * interrupted while holding PENDING and @work off queue, irq must be
1198 * disabled on entry. This, combined with delayed_work->timer being
1199 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001200 *
1201 * On successful return, >= 0, irq is disabled and the caller is
1202 * responsible for releasing it using local_irq_restore(*@flags).
1203 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001204 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001205 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001206static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1207 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001208{
Tejun Heod565ed62013-01-24 11:01:33 -08001209 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001210 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001211
Tejun Heobbb68df2012-08-03 10:30:46 -07001212 local_irq_save(*flags);
1213
Tejun Heo36e227d2012-08-03 10:30:46 -07001214 /* try to steal the timer if it exists */
1215 if (is_dwork) {
1216 struct delayed_work *dwork = to_delayed_work(work);
1217
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001218 /*
1219 * dwork->timer is irqsafe. If del_timer() fails, it's
1220 * guaranteed that the timer is not queued anywhere and not
1221 * running on the local CPU.
1222 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001223 if (likely(del_timer(&dwork->timer)))
1224 return 1;
1225 }
1226
1227 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001228 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1229 return 0;
1230
1231 /*
1232 * The queueing is in progress, or it is already queued. Try to
1233 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1234 */
Tejun Heod565ed62013-01-24 11:01:33 -08001235 pool = get_work_pool(work);
1236 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001237 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001238
Tejun Heod565ed62013-01-24 11:01:33 -08001239 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001240 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001241 * work->data is guaranteed to point to pwq only while the work
1242 * item is queued on pwq->wq, and both updating work->data to point
1243 * to pwq on queueing and to pool on dequeueing are done under
1244 * pwq->pool->lock. This in turn guarantees that, if work->data
1245 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001246 * item is currently queued on that pool.
1247 */
Tejun Heo112202d2013-02-13 19:29:12 -08001248 pwq = get_work_pwq(work);
1249 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001250 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001251
Tejun Heo16062832013-02-06 18:04:53 -08001252 /*
1253 * A delayed work item cannot be grabbed directly because
1254 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001255 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001256 * management later on and cause stall. Make sure the work
1257 * item is activated before grabbing.
1258 */
1259 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001260 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001261
Tejun Heo16062832013-02-06 18:04:53 -08001262 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001263 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001264
Tejun Heo112202d2013-02-13 19:29:12 -08001265 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001266 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001267
Tejun Heo16062832013-02-06 18:04:53 -08001268 spin_unlock(&pool->lock);
1269 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001270 }
Tejun Heod565ed62013-01-24 11:01:33 -08001271 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001272fail:
1273 local_irq_restore(*flags);
1274 if (work_is_canceling(work))
1275 return -ENOENT;
1276 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001277 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001278}
1279
1280/**
Tejun Heo706026c2013-01-24 11:01:34 -08001281 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001282 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001283 * @work: work to insert
1284 * @head: insertion point
1285 * @extra_flags: extra WORK_STRUCT_* flags to set
1286 *
Tejun Heo112202d2013-02-13 19:29:12 -08001287 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001288 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001289 *
1290 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001291 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001292 */
Tejun Heo112202d2013-02-13 19:29:12 -08001293static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1294 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001295{
Tejun Heo112202d2013-02-13 19:29:12 -08001296 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001297
Tejun Heo4690c4a2010-06-29 10:07:10 +02001298 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001299 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001300 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001301 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001302
1303 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001304 * Ensure either wq_worker_sleeping() sees the above
1305 * list_add_tail() or we see zero nr_running to avoid workers lying
1306 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001307 */
1308 smp_mb();
1309
Tejun Heo63d95a92012-07-12 14:46:37 -07001310 if (__need_more_worker(pool))
1311 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001312}
1313
Tejun Heoc8efcc22010-12-20 19:32:04 +01001314/*
1315 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001316 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001317 */
1318static bool is_chained_work(struct workqueue_struct *wq)
1319{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001320 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001321
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001322 worker = current_wq_worker();
1323 /*
1324 * Return %true iff I'm a worker execuing a work item on @wq. If
1325 * I'm @worker, it's safe to dereference it without locking.
1326 */
Tejun Heo112202d2013-02-13 19:29:12 -08001327 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001328}
1329
Mike Galbraithef5571802016-02-09 17:59:38 -05001330/*
1331 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1332 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1333 * avoid perturbing sensitive tasks.
1334 */
1335static int wq_select_unbound_cpu(int cpu)
1336{
Tejun Heof303fccb2016-02-09 17:59:38 -05001337 static bool printed_dbg_warning;
Mike Galbraithef5571802016-02-09 17:59:38 -05001338 int new_cpu;
1339
Tejun Heof303fccb2016-02-09 17:59:38 -05001340 if (likely(!wq_debug_force_rr_cpu)) {
1341 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1342 return cpu;
1343 } else if (!printed_dbg_warning) {
1344 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1345 printed_dbg_warning = true;
1346 }
1347
Mike Galbraithef5571802016-02-09 17:59:38 -05001348 if (cpumask_empty(wq_unbound_cpumask))
1349 return cpu;
1350
1351 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1352 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1353 if (unlikely(new_cpu >= nr_cpu_ids)) {
1354 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1355 if (unlikely(new_cpu >= nr_cpu_ids))
1356 return cpu;
1357 }
1358 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1359
1360 return new_cpu;
1361}
1362
Tejun Heod84ff052013-03-12 11:29:59 -07001363static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 struct work_struct *work)
1365{
Tejun Heo112202d2013-02-13 19:29:12 -08001366 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001367 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001368 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001369 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001370 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001371
1372 /*
1373 * While a work item is PENDING && off queue, a task trying to
1374 * steal the PENDING will busy-loop waiting for it to either get
1375 * queued or lose PENDING. Grabbing PENDING and queueing should
1376 * happen with IRQ disabled.
1377 */
Frederic Weisbecker8e8eb732017-11-06 16:01:19 +01001378 lockdep_assert_irqs_disabled();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001380 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001381
Li Bin9ef28a72013-09-09 13:13:58 +08001382 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001383 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001384 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001385 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001386retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001387 if (req_cpu == WORK_CPU_UNBOUND)
Mike Galbraithef5571802016-02-09 17:59:38 -05001388 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001389
Tejun Heoc9178082013-03-12 11:30:04 -07001390 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001391 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001392 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001393 else
1394 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001395
Tejun Heoc9178082013-03-12 11:30:04 -07001396 /*
1397 * If @work was previously on a different pool, it might still be
1398 * running there, in which case the work needs to be queued on that
1399 * pool to guarantee non-reentrancy.
1400 */
1401 last_pool = get_work_pool(work);
1402 if (last_pool && last_pool != pwq->pool) {
1403 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001404
Tejun Heoc9178082013-03-12 11:30:04 -07001405 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001406
Tejun Heoc9178082013-03-12 11:30:04 -07001407 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001408
Tejun Heoc9178082013-03-12 11:30:04 -07001409 if (worker && worker->current_pwq->wq == wq) {
1410 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001411 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001412 /* meh... not running there, queue here */
1413 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001414 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001415 }
Tejun Heof3421792010-07-02 10:03:51 +02001416 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001417 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001418 }
1419
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001420 /*
1421 * pwq is determined and locked. For unbound pools, we could have
1422 * raced with pwq release and it could already be dead. If its
1423 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001424 * without another pwq replacing it in the numa_pwq_tbl or while
1425 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001426 * make forward-progress.
1427 */
1428 if (unlikely(!pwq->refcnt)) {
1429 if (wq->flags & WQ_UNBOUND) {
1430 spin_unlock(&pwq->pool->lock);
1431 cpu_relax();
1432 goto retry;
1433 }
1434 /* oops */
1435 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1436 wq->name, cpu);
1437 }
1438
Tejun Heo112202d2013-02-13 19:29:12 -08001439 /* pwq determined, queue */
1440 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001441
Dan Carpenterf5b25522012-04-13 22:06:58 +03001442 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001443 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001444 return;
1445 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001446
Tejun Heo112202d2013-02-13 19:29:12 -08001447 pwq->nr_in_flight[pwq->work_color]++;
1448 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001449
Tejun Heo112202d2013-02-13 19:29:12 -08001450 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001451 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001452 pwq->nr_active++;
1453 worklist = &pwq->pool->worklist;
Tejun Heo82607adc2015-12-08 11:28:04 -05001454 if (list_empty(worklist))
1455 pwq->pool->watchdog_ts = jiffies;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001456 } else {
1457 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001458 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001459 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001460
Tejun Heo112202d2013-02-13 19:29:12 -08001461 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001462
Tejun Heo112202d2013-02-13 19:29:12 -08001463 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001466/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001467 * queue_work_on - queue work on specific cpu
1468 * @cpu: CPU number to execute work on
1469 * @wq: workqueue to use
1470 * @work: work to queue
1471 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001472 * We queue the work to a specific CPU, the caller must ensure it
1473 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001474 *
1475 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001476 */
Tejun Heod4283e92012-08-03 10:30:44 -07001477bool queue_work_on(int cpu, struct workqueue_struct *wq,
1478 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001479{
Tejun Heod4283e92012-08-03 10:30:44 -07001480 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001481 unsigned long flags;
1482
1483 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001484
Tejun Heo22df02b2010-06-29 10:07:10 +02001485 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001486 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001487 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001488 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001489
1490 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001491 return ret;
1492}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001493EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001494
Kees Cook8c20feb2017-10-04 16:27:07 -07001495void delayed_work_timer_fn(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
Kees Cook8c20feb2017-10-04 16:27:07 -07001497 struct delayed_work *dwork = from_timer(dwork, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001499 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001500 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001502EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001504static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1505 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001507 struct timer_list *timer = &dwork->timer;
1508 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Tejun Heo637fdba2017-03-06 15:33:42 -05001510 WARN_ON_ONCE(!wq);
Kees Cook841b86f2017-10-23 09:40:42 +02001511 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
Tejun Heofc4b5142012-12-04 07:40:39 -08001512 WARN_ON_ONCE(timer_pending(timer));
1513 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001514
Tejun Heo8852aac2012-12-01 16:23:42 -08001515 /*
1516 * If @delay is 0, queue @dwork->work immediately. This is for
1517 * both optimization and correctness. The earliest @timer can
1518 * expire is on the closest next tick and delayed_work users depend
1519 * on that there's no such delay when @delay is 0.
1520 */
1521 if (!delay) {
1522 __queue_work(cpu, wq, &dwork->work);
1523 return;
1524 }
1525
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001526 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001527 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001528 timer->expires = jiffies + delay;
1529
Tejun Heo041bd122016-02-09 16:11:26 -05001530 if (unlikely(cpu != WORK_CPU_UNBOUND))
1531 add_timer_on(timer, cpu);
1532 else
1533 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
1535
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001536/**
1537 * queue_delayed_work_on - queue work on specific CPU after delay
1538 * @cpu: CPU number to execute work on
1539 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001540 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001541 * @delay: number of jiffies to wait before queueing
1542 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001543 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001544 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1545 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001546 */
Tejun Heod4283e92012-08-03 10:30:44 -07001547bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1548 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001549{
David Howells52bad642006-11-22 14:54:01 +00001550 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001551 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001552 unsigned long flags;
1553
1554 /* read the comment in __queue_work() */
1555 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001556
Tejun Heo22df02b2010-06-29 10:07:10 +02001557 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001558 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001559 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001560 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001561
1562 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001563 return ret;
1564}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001565EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Tejun Heoc8e55f32010-06-29 10:07:12 +02001567/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001568 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1569 * @cpu: CPU number to execute work on
1570 * @wq: workqueue to use
1571 * @dwork: work to queue
1572 * @delay: number of jiffies to wait before queueing
1573 *
1574 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1575 * modify @dwork's timer so that it expires after @delay. If @delay is
1576 * zero, @work is guaranteed to be scheduled immediately regardless of its
1577 * current state.
1578 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001579 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001580 * pending and its timer was modified.
1581 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001582 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001583 * See try_to_grab_pending() for details.
1584 */
1585bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1586 struct delayed_work *dwork, unsigned long delay)
1587{
1588 unsigned long flags;
1589 int ret;
1590
1591 do {
1592 ret = try_to_grab_pending(&dwork->work, true, &flags);
1593 } while (unlikely(ret == -EAGAIN));
1594
1595 if (likely(ret >= 0)) {
1596 __queue_delayed_work(cpu, wq, dwork, delay);
1597 local_irq_restore(flags);
1598 }
1599
1600 /* -ENOENT from try_to_grab_pending() becomes %true */
1601 return ret;
1602}
1603EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1604
Tejun Heo05f0fe62018-03-14 12:45:13 -07001605static void rcu_work_rcufn(struct rcu_head *rcu)
1606{
1607 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1608
1609 /* read the comment in __queue_work() */
1610 local_irq_disable();
1611 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1612 local_irq_enable();
1613}
1614
1615/**
1616 * queue_rcu_work - queue work after a RCU grace period
1617 * @wq: workqueue to use
1618 * @rwork: work to queue
1619 *
1620 * Return: %false if @rwork was already pending, %true otherwise. Note
1621 * that a full RCU grace period is guaranteed only after a %true return.
1622 * While @rwork is guarnateed to be executed after a %false return, the
1623 * execution may happen before a full RCU grace period has passed.
1624 */
1625bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1626{
1627 struct work_struct *work = &rwork->work;
1628
1629 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1630 rwork->wq = wq;
1631 call_rcu(&rwork->rcu, rcu_work_rcufn);
1632 return true;
1633 }
1634
1635 return false;
1636}
1637EXPORT_SYMBOL(queue_rcu_work);
1638
Tejun Heo8376fe22012-08-03 10:30:47 -07001639/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001640 * worker_enter_idle - enter idle state
1641 * @worker: worker which is entering idle state
1642 *
1643 * @worker is entering idle state. Update stats and idle timer if
1644 * necessary.
1645 *
1646 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001647 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001648 */
1649static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001651 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Tejun Heo6183c002013-03-12 11:29:57 -07001653 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1654 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1655 (worker->hentry.next || worker->hentry.pprev)))
1656 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Lai Jiangshan051e1852014-07-22 13:03:02 +08001658 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001659 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001660 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001661 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001662
Tejun Heoc8e55f32010-06-29 10:07:12 +02001663 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001664 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001665
Tejun Heo628c78e2012-07-17 12:39:27 -07001666 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1667 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001668
Tejun Heo544ecf32012-05-14 15:04:50 -07001669 /*
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08001670 * Sanity check nr_running. Because unbind_workers() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001671 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001672 * nr_running, the warning may trigger spuriously. Check iff
1673 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001674 */
Tejun Heo24647572013-01-24 11:01:33 -08001675 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001676 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001677 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Tejun Heoc8e55f32010-06-29 10:07:12 +02001680/**
1681 * worker_leave_idle - leave idle state
1682 * @worker: worker which is leaving idle state
1683 *
1684 * @worker is leaving idle state. Update stats.
1685 *
1686 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001687 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001688 */
1689static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001691 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Tejun Heo6183c002013-03-12 11:29:57 -07001693 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1694 return;
Tejun Heod302f012010-06-29 10:07:13 +02001695 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001696 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001697 list_del_init(&worker->entry);
1698}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001700static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001701{
1702 struct worker *worker;
1703
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001704 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001705 if (worker) {
1706 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001707 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001708 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001709 /* on creation a worker is in !idle && prep state */
1710 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001711 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001712 return worker;
1713}
1714
1715/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001716 * worker_attach_to_pool() - attach a worker to a pool
1717 * @worker: worker to be attached
1718 * @pool: the target pool
1719 *
1720 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1721 * cpu-binding of @worker are kept coordinated with the pool across
1722 * cpu-[un]hotplugs.
1723 */
1724static void worker_attach_to_pool(struct worker *worker,
1725 struct worker_pool *pool)
1726{
Tejun Heo1258fae2018-05-18 08:47:13 -07001727 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001728
1729 /*
1730 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1731 * online CPUs. It'll be re-applied when any of the CPUs come up.
1732 */
1733 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1734
1735 /*
Tejun Heo1258fae2018-05-18 08:47:13 -07001736 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1737 * stable across this function. See the comments above the flag
1738 * definition for details.
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001739 */
1740 if (pool->flags & POOL_DISASSOCIATED)
1741 worker->flags |= WORKER_UNBOUND;
1742
1743 list_add_tail(&worker->node, &pool->workers);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001744 worker->pool = pool;
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001745
Tejun Heo1258fae2018-05-18 08:47:13 -07001746 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001747}
1748
1749/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001750 * worker_detach_from_pool() - detach a worker from its pool
1751 * @worker: worker which is attached to its pool
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001752 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001753 * Undo the attaching which had been done in worker_attach_to_pool(). The
1754 * caller worker shouldn't access to the pool after detached except it has
1755 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001756 */
Tejun Heoa2d812a2018-05-18 08:47:13 -07001757static void worker_detach_from_pool(struct worker *worker)
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001758{
Tejun Heoa2d812a2018-05-18 08:47:13 -07001759 struct worker_pool *pool = worker->pool;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001760 struct completion *detach_completion = NULL;
1761
Tejun Heo1258fae2018-05-18 08:47:13 -07001762 mutex_lock(&wq_pool_attach_mutex);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001763
Lai Jiangshanda028462014-05-20 17:46:31 +08001764 list_del(&worker->node);
Tejun Heoa2d812a2018-05-18 08:47:13 -07001765 worker->pool = NULL;
1766
Lai Jiangshanda028462014-05-20 17:46:31 +08001767 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001768 detach_completion = pool->detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07001769 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001770
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001771 /* clear leftover flags without pool->lock after it is detached */
1772 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1773
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001774 if (detach_completion)
1775 complete(detach_completion);
1776}
1777
1778/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001780 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001781 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001782 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001783 *
1784 * CONTEXT:
1785 * Might sleep. Does GFP_KERNEL allocations.
1786 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001787 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001788 * Pointer to the newly created worker.
1789 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001790static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001791{
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001793 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001794 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001795
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001796 /* ID is needed to determine kthread name */
1797 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001798 if (id < 0)
1799 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001800
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001801 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 if (!worker)
1803 goto fail;
1804
Tejun Heoc34056a2010-06-29 10:07:11 +02001805 worker->id = id;
1806
Tejun Heo29c91e92013-03-12 11:30:03 -07001807 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001808 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1809 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001810 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001811 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1812
Tejun Heof3f90ad2013-04-01 11:23:34 -07001813 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001814 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001815 if (IS_ERR(worker->task))
1816 goto fail;
1817
Oleg Nesterov91151222013-11-14 12:56:18 +01001818 set_user_nice(worker->task, pool->attrs->nice);
Peter Zijlstra25834c72015-05-15 17:43:34 +02001819 kthread_bind_mask(worker->task, pool->attrs->cpumask);
Oleg Nesterov91151222013-11-14 12:56:18 +01001820
Lai Jiangshanda028462014-05-20 17:46:31 +08001821 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001822 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001823
Lai Jiangshan051e1852014-07-22 13:03:02 +08001824 /* start the newly created worker */
1825 spin_lock_irq(&pool->lock);
1826 worker->pool->nr_workers++;
1827 worker_enter_idle(worker);
1828 wake_up_process(worker->task);
1829 spin_unlock_irq(&pool->lock);
1830
Tejun Heoc34056a2010-06-29 10:07:11 +02001831 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001832
Tejun Heoc34056a2010-06-29 10:07:11 +02001833fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001834 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001835 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001836 kfree(worker);
1837 return NULL;
1838}
1839
1840/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001841 * destroy_worker - destroy a workqueue worker
1842 * @worker: worker to be destroyed
1843 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001844 * Destroy @worker and adjust @pool stats accordingly. The worker should
1845 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001846 *
1847 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001848 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001849 */
1850static void destroy_worker(struct worker *worker)
1851{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001852 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001853
Tejun Heocd549682013-03-13 19:47:39 -07001854 lockdep_assert_held(&pool->lock);
1855
Tejun Heoc34056a2010-06-29 10:07:11 +02001856 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001857 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001858 WARN_ON(!list_empty(&worker->scheduled)) ||
1859 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001860 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001861
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001862 pool->nr_workers--;
1863 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001864
Tejun Heoc8e55f32010-06-29 10:07:12 +02001865 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001866 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001867 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001868}
1869
Kees Cook32a6c722017-10-16 15:58:25 -07001870static void idle_worker_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001871{
Kees Cook32a6c722017-10-16 15:58:25 -07001872 struct worker_pool *pool = from_timer(pool, t, idle_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873
Tejun Heod565ed62013-01-24 11:01:33 -08001874 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001875
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001876 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001877 struct worker *worker;
1878 unsigned long expires;
1879
1880 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001881 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001882 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1883
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001884 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001885 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001886 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001888
1889 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001890 }
1891
Tejun Heod565ed62013-01-24 11:01:33 -08001892 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001893}
1894
Tejun Heo493a1722013-03-12 11:29:59 -07001895static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001896{
Tejun Heo112202d2013-02-13 19:29:12 -08001897 struct pool_workqueue *pwq = get_work_pwq(work);
1898 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001899
Tejun Heo2e109a22013-03-13 19:47:40 -07001900 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
Tejun Heo493008a2013-03-12 11:30:03 -07001902 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001903 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001904
1905 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001906 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001907 /*
1908 * If @pwq is for an unbound wq, its base ref may be put at
1909 * any time due to an attribute change. Pin @pwq until the
1910 * rescuer is done with it.
1911 */
1912 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001913 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001915 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001916}
1917
Kees Cook32a6c722017-10-16 15:58:25 -07001918static void pool_mayday_timeout(struct timer_list *t)
Tejun Heoe22bee72010-06-29 10:07:14 +02001919{
Kees Cook32a6c722017-10-16 15:58:25 -07001920 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 struct work_struct *work;
1922
Tejun Heob2d82902014-12-08 12:39:16 -05001923 spin_lock_irq(&pool->lock);
1924 spin_lock(&wq_mayday_lock); /* for wq->maydays */
Tejun Heoe22bee72010-06-29 10:07:14 +02001925
Tejun Heo63d95a92012-07-12 14:46:37 -07001926 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001927 /*
1928 * We've been trying to create a new worker but
1929 * haven't been successful. We might be hitting an
1930 * allocation deadlock. Send distress signals to
1931 * rescuers.
1932 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001933 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001934 send_mayday(work);
1935 }
1936
Tejun Heob2d82902014-12-08 12:39:16 -05001937 spin_unlock(&wq_mayday_lock);
1938 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001939
Tejun Heo63d95a92012-07-12 14:46:37 -07001940 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001941}
1942
1943/**
1944 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001947 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001948 * have at least one idle worker on return from this function. If
1949 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001950 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001951 * possible allocation deadlock.
1952 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001953 * On return, need_to_create_worker() is guaranteed to be %false and
1954 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 *
1956 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001957 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001958 * multiple times. Does GFP_KERNEL allocations. Called only from
1959 * manager.
Tejun Heoe22bee72010-06-29 10:07:14 +02001960 */
Tejun Heo29187a92015-01-16 14:21:16 -05001961static void maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001962__releases(&pool->lock)
1963__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001964{
Tejun Heoe22bee72010-06-29 10:07:14 +02001965restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001966 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001967
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001970
1971 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001972 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 break;
1974
Lai Jiangshane212f362014-06-03 15:32:17 +08001975 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001976
Tejun Heo63d95a92012-07-12 14:46:37 -07001977 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 break;
1979 }
1980
Tejun Heo63d95a92012-07-12 14:46:37 -07001981 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001982 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001983 /*
1984 * This is necessary even after a new worker was just successfully
1985 * created as @pool->lock was dropped and the new worker might have
1986 * already become busy.
1987 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001988 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001989 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001990}
1991
1992/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 * manage_workers - manage worker pool
1994 * @worker: self
1995 *
Tejun Heo706026c2013-01-24 11:01:34 -08001996 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001998 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 *
2000 * The caller can safely start processing works on false return. On
2001 * true return, it's guaranteed that need_to_create_worker() is false
2002 * and may_start_working() is true.
2003 *
2004 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002005 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002006 * multiple times. Does GFP_KERNEL allocations.
2007 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002008 * Return:
Tejun Heo29187a92015-01-16 14:21:16 -05002009 * %false if the pool doesn't need management and the caller can safely
2010 * start processing works, %true if management function was performed and
2011 * the conditions that the caller verified before calling the function may
2012 * no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 */
2014static bool manage_workers(struct worker *worker)
2015{
Tejun Heo63d95a92012-07-12 14:46:37 -07002016 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002017
Tejun Heo692b4822017-10-09 08:04:13 -07002018 if (pool->flags & POOL_MANAGER_ACTIVE)
Tejun Heo29187a92015-01-16 14:21:16 -05002019 return false;
Tejun Heo692b4822017-10-09 08:04:13 -07002020
2021 pool->flags |= POOL_MANAGER_ACTIVE;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002022 pool->manager = worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02002023
Tejun Heo29187a92015-01-16 14:21:16 -05002024 maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002025
Tejun Heo2607d7a2015-03-09 09:22:28 -04002026 pool->manager = NULL;
Tejun Heo692b4822017-10-09 08:04:13 -07002027 pool->flags &= ~POOL_MANAGER_ACTIVE;
2028 wake_up(&wq_manager_wait);
Tejun Heo29187a92015-01-16 14:21:16 -05002029 return true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002030}
2031
Tejun Heoa62428c2010-06-29 10:07:10 +02002032/**
2033 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002034 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002035 * @work: work to process
2036 *
2037 * Process @work. This function contains all the logics necessary to
2038 * process a single work including synchronization against and
2039 * interaction with other workers on the same cpu, queueing and
2040 * flushing. As long as context requirement is met, any worker can
2041 * call this function to process a work.
2042 *
2043 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002044 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002045 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002046static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002047__releases(&pool->lock)
2048__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002049{
Tejun Heo112202d2013-02-13 19:29:12 -08002050 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002051 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002052 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002053 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002054 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002055#ifdef CONFIG_LOCKDEP
2056 /*
2057 * It is permissible to free the struct work_struct from
2058 * inside the function that is called from it, this we need to
2059 * take into account for lockdep too. To avoid bogus "held
2060 * lock freed" warnings as well as problems when looking into
2061 * work->lockdep_map, make a copy and use that here.
2062 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002063 struct lockdep_map lockdep_map;
2064
2065 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002066#endif
Lai Jiangshan807407c2014-06-03 15:33:28 +08002067 /* ensure we're on the correct CPU */
Lai Jiangshan85327af2014-06-03 15:33:28 +08002068 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002069 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002070
Tejun Heo7e116292010-06-29 10:07:13 +02002071 /*
2072 * A single work shouldn't be executed concurrently by
2073 * multiple workers on a single cpu. Check whether anyone is
2074 * already processing the work. If so, defer the work to the
2075 * currently executing one.
2076 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002077 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002078 if (unlikely(collision)) {
2079 move_linked_works(work, &collision->scheduled, NULL);
2080 return;
2081 }
2082
Tejun Heo8930cab2012-08-03 10:30:45 -07002083 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002084 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002085 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002086 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002087 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002088 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002089 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002090
Tejun Heo8bf89592018-05-18 08:47:13 -07002091 /*
2092 * Record wq name for cmdline and debug reporting, may get
2093 * overridden through set_worker_desc().
2094 */
2095 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2096
Tejun Heoa62428c2010-06-29 10:07:10 +02002097 list_del_init(&work->entry);
2098
Tejun Heo649027d2010-06-29 10:07:14 +02002099 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002100 * CPU intensive works don't participate in concurrency management.
2101 * They're the scheduler's responsibility. This takes @worker out
2102 * of concurrency management and the next code block will chain
2103 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02002104 */
2105 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002106 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002107
Tejun Heo974271c2012-07-12 14:46:37 -07002108 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002109 * Wake up another worker if necessary. The condition is always
2110 * false for normal per-cpu workers since nr_running would always
2111 * be >= 1 at this point. This is used to chain execution of the
2112 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002113 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002114 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002115 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002116 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002117
Tejun Heo8930cab2012-08-03 10:30:45 -07002118 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002119 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002120 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002121 * PENDING and queued state changes happen together while IRQ is
2122 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002123 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002124 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002125
Tejun Heod565ed62013-01-24 11:01:33 -08002126 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002127
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002128 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002129 lock_map_acquire(&lockdep_map);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002130 /*
Peter Zijlstraf52be572017-08-29 10:59:39 +02002131 * Strictly speaking we should mark the invariant state without holding
2132 * any locks, that is, before these two lock_map_acquire()'s.
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002133 *
2134 * However, that would result in:
2135 *
2136 * A(W1)
2137 * WFC(C)
2138 * A(W1)
2139 * C(C)
2140 *
2141 * Which would create W1->C->W1 dependencies, even though there is no
2142 * actual deadlock possible. There are two solutions, using a
2143 * read-recursive acquire on the work(queue) 'locks', but this will then
Peter Zijlstraf52be572017-08-29 10:59:39 +02002144 * hit the lockdep limitation on recursive locks, or simply discard
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +02002145 * these locks.
2146 *
2147 * AFAICT there is no possible deadlock scenario between the
2148 * flush_work() and complete() primitives (except for single-threaded
2149 * workqueues), so hiding them isn't a problem.
2150 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02002151 lockdep_invariant_state(true);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002152 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002153 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002154 /*
2155 * While we must be careful to not use "work" after this, the trace
2156 * point will only record its address.
2157 */
2158 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002159 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002160 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002161
2162 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002163 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2164 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002165 current->comm, preempt_count(), task_pid_nr(current),
2166 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002167 debug_show_held_locks(current);
2168 dump_stack();
2169 }
2170
Tejun Heob22ce272013-08-28 17:33:37 -04002171 /*
2172 * The following prevents a kworker from hogging CPU on !PREEMPT
2173 * kernels, where a requeueing work item waiting for something to
2174 * happen could deadlock with stop_machine as such work item could
2175 * indefinitely requeue itself while all other CPUs are trapped in
Joe Lawrence789cbbe2014-10-05 13:24:21 -04002176 * stop_machine. At the same time, report a quiescent RCU state so
2177 * the same condition doesn't freeze RCU.
Tejun Heob22ce272013-08-28 17:33:37 -04002178 */
Paul E. McKenneya7e64252017-10-24 08:25:02 -07002179 cond_resched();
Tejun Heob22ce272013-08-28 17:33:37 -04002180
Tejun Heod565ed62013-01-24 11:01:33 -08002181 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002182
Tejun Heofb0e7be2010-06-29 10:07:15 +02002183 /* clear cpu intensive status */
2184 if (unlikely(cpu_intensive))
2185 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2186
Tejun Heoa62428c2010-06-29 10:07:10 +02002187 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002188 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002189 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002190 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002191 worker->current_pwq = NULL;
2192 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002193}
2194
Tejun Heoaffee4b2010-06-29 10:07:12 +02002195/**
2196 * process_scheduled_works - process scheduled works
2197 * @worker: self
2198 *
2199 * Process all scheduled works. Please note that the scheduled list
2200 * may change while processing a work, so this function repeatedly
2201 * fetches a work from the top and executes it.
2202 *
2203 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002204 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002205 * multiple times.
2206 */
2207static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002209 while (!list_empty(&worker->scheduled)) {
2210 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002212 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214}
2215
Tejun Heo197f6ac2018-05-21 08:04:35 -07002216static void set_pf_worker(bool val)
2217{
2218 mutex_lock(&wq_pool_attach_mutex);
2219 if (val)
2220 current->flags |= PF_WQ_WORKER;
2221 else
2222 current->flags &= ~PF_WQ_WORKER;
2223 mutex_unlock(&wq_pool_attach_mutex);
2224}
2225
Tejun Heo4690c4a2010-06-29 10:07:10 +02002226/**
2227 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002228 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002229 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002230 * The worker thread function. All workers belong to a worker_pool -
2231 * either a per-cpu one or dynamic unbound one. These workers process all
2232 * work items regardless of their specific target workqueue. The only
2233 * exception is work items which belong to workqueues with a rescuer which
2234 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002235 *
2236 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002237 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002238static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239{
Tejun Heoc34056a2010-06-29 10:07:11 +02002240 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002241 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242
Tejun Heoe22bee72010-06-29 10:07:14 +02002243 /* tell the scheduler that this is a workqueue worker */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002244 set_pf_worker(true);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002245woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002246 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002247
Tejun Heoa9ab7752013-03-19 13:45:21 -07002248 /* am I supposed to die? */
2249 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002250 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002251 WARN_ON_ONCE(!list_empty(&worker->entry));
Tejun Heo197f6ac2018-05-21 08:04:35 -07002252 set_pf_worker(false);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002253
2254 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002255 ida_simple_remove(&pool->worker_ida, worker->id);
Tejun Heoa2d812a2018-05-18 08:47:13 -07002256 worker_detach_from_pool(worker);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002257 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002258 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002260
Tejun Heoc8e55f32010-06-29 10:07:12 +02002261 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002262recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002263 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002264 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002265 goto sleep;
2266
2267 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002268 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002269 goto recheck;
2270
Tejun Heoc8e55f32010-06-29 10:07:12 +02002271 /*
2272 * ->scheduled list can only be filled while a worker is
2273 * preparing to process a work or actually processing it.
2274 * Make sure nobody diddled with it while I was sleeping.
2275 */
Tejun Heo6183c002013-03-12 11:29:57 -07002276 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002277
Tejun Heoe22bee72010-06-29 10:07:14 +02002278 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002279 * Finish PREP stage. We're guaranteed to have at least one idle
2280 * worker or that someone else has already assumed the manager
2281 * role. This is where @worker starts participating in concurrency
2282 * management if applicable and concurrency management is restored
2283 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002284 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002285 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002286
2287 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002288 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002289 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002290 struct work_struct, entry);
2291
Tejun Heo82607adc2015-12-08 11:28:04 -05002292 pool->watchdog_ts = jiffies;
2293
Tejun Heoc8e55f32010-06-29 10:07:12 +02002294 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2295 /* optimization path, not strictly necessary */
2296 process_one_work(worker, work);
2297 if (unlikely(!list_empty(&worker->scheduled)))
2298 process_scheduled_works(worker);
2299 } else {
2300 move_linked_works(work, &worker->scheduled, NULL);
2301 process_scheduled_works(worker);
2302 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002303 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002304
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002305 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002306sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002307 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002308 * pool->lock is held and there's no work to process and no need to
2309 * manage, sleep. Workers are woken up only while holding
2310 * pool->lock or from local cpu, so setting the current state
2311 * before releasing pool->lock is enough to prevent losing any
2312 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002313 */
2314 worker_enter_idle(worker);
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002315 __set_current_state(TASK_IDLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002316 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002317 schedule();
2318 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319}
2320
Tejun Heoe22bee72010-06-29 10:07:14 +02002321/**
2322 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002323 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002324 *
2325 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002326 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002327 *
Tejun Heo706026c2013-01-24 11:01:34 -08002328 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002329 * worker which uses GFP_KERNEL allocation which has slight chance of
2330 * developing into deadlock if some works currently on the same queue
2331 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2332 * the problem rescuer solves.
2333 *
Tejun Heo706026c2013-01-24 11:01:34 -08002334 * When such condition is possible, the pool summons rescuers of all
2335 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002336 * those works so that forward progress can be guaranteed.
2337 *
2338 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002339 *
2340 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002341 */
Tejun Heo111c2252013-01-17 17:16:24 -08002342static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002343{
Tejun Heo111c2252013-01-17 17:16:24 -08002344 struct worker *rescuer = __rescuer;
2345 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002346 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002347 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002348
2349 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002350
2351 /*
2352 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2353 * doesn't participate in concurrency management.
2354 */
Tejun Heo197f6ac2018-05-21 08:04:35 -07002355 set_pf_worker(true);
Tejun Heoe22bee72010-06-29 10:07:14 +02002356repeat:
Peter Zijlstrac5a94a62017-08-23 13:58:44 +02002357 set_current_state(TASK_IDLE);
Tejun Heoe22bee72010-06-29 10:07:14 +02002358
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002359 /*
2360 * By the time the rescuer is requested to stop, the workqueue
2361 * shouldn't have any work pending, but @wq->maydays may still have
2362 * pwq(s) queued. This can happen by non-rescuer workers consuming
2363 * all the work items before the rescuer got to them. Go through
2364 * @wq->maydays processing before acting on should_stop so that the
2365 * list is always empty on exit.
2366 */
2367 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002368
Tejun Heo493a1722013-03-12 11:29:59 -07002369 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002370 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002371
2372 while (!list_empty(&wq->maydays)) {
2373 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2374 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002375 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002376 struct work_struct *work, *n;
Tejun Heo82607adc2015-12-08 11:28:04 -05002377 bool first = true;
Tejun Heoe22bee72010-06-29 10:07:14 +02002378
2379 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002380 list_del_init(&pwq->mayday_node);
2381
Tejun Heo2e109a22013-03-13 19:47:40 -07002382 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002383
Lai Jiangshan51697d392014-05-20 17:46:36 +08002384 worker_attach_to_pool(rescuer, pool);
2385
2386 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002387
2388 /*
2389 * Slurp in all works issued via this workqueue and
2390 * process'em.
2391 */
Tejun Heo0479c8c2014-12-04 10:14:13 -05002392 WARN_ON_ONCE(!list_empty(scheduled));
Tejun Heo82607adc2015-12-08 11:28:04 -05002393 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2394 if (get_work_pwq(work) == pwq) {
2395 if (first)
2396 pool->watchdog_ts = jiffies;
Tejun Heoe22bee72010-06-29 10:07:14 +02002397 move_linked_works(work, scheduled, &n);
Tejun Heo82607adc2015-12-08 11:28:04 -05002398 }
2399 first = false;
2400 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002401
NeilBrown008847f2014-12-08 12:39:16 -05002402 if (!list_empty(scheduled)) {
2403 process_scheduled_works(rescuer);
2404
2405 /*
2406 * The above execution of rescued work items could
2407 * have created more to rescue through
2408 * pwq_activate_first_delayed() or chained
2409 * queueing. Let's put @pwq back on mayday list so
2410 * that such back-to-back work items, which may be
2411 * being used to relieve memory pressure, don't
2412 * incur MAYDAY_INTERVAL delay inbetween.
2413 */
2414 if (need_to_create_worker(pool)) {
2415 spin_lock(&wq_mayday_lock);
2416 get_pwq(pwq);
2417 list_move_tail(&pwq->mayday_node, &wq->maydays);
2418 spin_unlock(&wq_mayday_lock);
2419 }
2420 }
Tejun Heo75769582011-02-14 14:04:46 +01002421
2422 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002423 * Put the reference grabbed by send_mayday(). @pool won't
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002424 * go away while we're still attached to it.
Lai Jiangshan77668c82014-04-18 11:04:16 -04002425 */
2426 put_pwq(pwq);
2427
2428 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002429 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002430 * regular worker; otherwise, we end up with 0 concurrency
2431 * and stalling the execution.
2432 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002433 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002434 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002435
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002436 spin_unlock_irq(&pool->lock);
2437
Tejun Heoa2d812a2018-05-18 08:47:13 -07002438 worker_detach_from_pool(rescuer);
Lai Jiangshan13b1d622014-07-22 13:03:47 +08002439
2440 spin_lock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002441 }
2442
Tejun Heo2e109a22013-03-13 19:47:40 -07002443 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002444
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002445 if (should_stop) {
2446 __set_current_state(TASK_RUNNING);
Tejun Heo197f6ac2018-05-21 08:04:35 -07002447 set_pf_worker(false);
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002448 return 0;
2449 }
2450
Tejun Heo111c2252013-01-17 17:16:24 -08002451 /* rescuers should never participate in concurrency management */
2452 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002453 schedule();
2454 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455}
2456
Tejun Heofca839c2015-12-07 10:58:57 -05002457/**
2458 * check_flush_dependency - check for flush dependency sanity
2459 * @target_wq: workqueue being flushed
2460 * @target_work: work item being flushed (NULL for workqueue flushes)
2461 *
2462 * %current is trying to flush the whole @target_wq or @target_work on it.
2463 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2464 * reclaiming memory or running on a workqueue which doesn't have
2465 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2466 * a deadlock.
2467 */
2468static void check_flush_dependency(struct workqueue_struct *target_wq,
2469 struct work_struct *target_work)
2470{
2471 work_func_t target_func = target_work ? target_work->func : NULL;
2472 struct worker *worker;
2473
2474 if (target_wq->flags & WQ_MEM_RECLAIM)
2475 return;
2476
2477 worker = current_wq_worker();
2478
2479 WARN_ONCE(current->flags & PF_MEMALLOC,
2480 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2481 current->pid, current->comm, target_wq->name, target_func);
Tejun Heo23d11a52016-01-29 05:59:46 -05002482 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2483 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
Tejun Heofca839c2015-12-07 10:58:57 -05002484 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2485 worker->current_pwq->wq->name, worker->current_func,
2486 target_wq->name, target_func);
2487}
2488
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002489struct wq_barrier {
2490 struct work_struct work;
2491 struct completion done;
Tejun Heo2607d7a2015-03-09 09:22:28 -04002492 struct task_struct *task; /* purely informational */
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002493};
2494
2495static void wq_barrier_func(struct work_struct *work)
2496{
2497 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2498 complete(&barr->done);
2499}
2500
Tejun Heo4690c4a2010-06-29 10:07:10 +02002501/**
2502 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002503 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002504 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002505 * @target: target work to attach @barr to
2506 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002507 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002508 * @barr is linked to @target such that @barr is completed only after
2509 * @target finishes execution. Please note that the ordering
2510 * guarantee is observed only with respect to @target and on the local
2511 * cpu.
2512 *
2513 * Currently, a queued barrier can't be canceled. This is because
2514 * try_to_grab_pending() can't determine whether the work to be
2515 * grabbed is at the head of the queue and thus can't clear LINKED
2516 * flag of the previous work while there must be a valid next work
2517 * after a work with LINKED flag set.
2518 *
2519 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002520 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002521 *
2522 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002523 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002524 */
Tejun Heo112202d2013-02-13 19:29:12 -08002525static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002526 struct wq_barrier *barr,
2527 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002528{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002529 struct list_head *head;
2530 unsigned int linked = 0;
2531
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002532 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002533 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002534 * as we know for sure that this will not trigger any of the
2535 * checks and call back into the fixup functions where we
2536 * might deadlock.
2537 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002538 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002539 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Boqun Feng52fa5bc2017-08-17 17:46:12 +08002540
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002541 init_completion_map(&barr->done, &target->lockdep_map);
2542
Tejun Heo2607d7a2015-03-09 09:22:28 -04002543 barr->task = current;
Oleg Nesterov83c22522007-05-09 02:33:54 -07002544
Tejun Heoaffee4b2010-06-29 10:07:12 +02002545 /*
2546 * If @target is currently being executed, schedule the
2547 * barrier to the worker; otherwise, put it after @target.
2548 */
2549 if (worker)
2550 head = worker->scheduled.next;
2551 else {
2552 unsigned long *bits = work_data_bits(target);
2553
2554 head = target->entry.next;
2555 /* there can already be other linked works, inherit and set */
2556 linked = *bits & WORK_STRUCT_LINKED;
2557 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2558 }
2559
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002560 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002561 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002562 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002563}
2564
Tejun Heo73f53c42010-06-29 10:07:11 +02002565/**
Tejun Heo112202d2013-02-13 19:29:12 -08002566 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002567 * @wq: workqueue being flushed
2568 * @flush_color: new flush color, < 0 for no-op
2569 * @work_color: new work color, < 0 for no-op
2570 *
Tejun Heo112202d2013-02-13 19:29:12 -08002571 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002572 *
Tejun Heo112202d2013-02-13 19:29:12 -08002573 * If @flush_color is non-negative, flush_color on all pwqs should be
2574 * -1. If no pwq has in-flight commands at the specified color, all
2575 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2576 * has in flight commands, its pwq->flush_color is set to
2577 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002578 * wakeup logic is armed and %true is returned.
2579 *
2580 * The caller should have initialized @wq->first_flusher prior to
2581 * calling this function with non-negative @flush_color. If
2582 * @flush_color is negative, no flush color update is done and %false
2583 * is returned.
2584 *
Tejun Heo112202d2013-02-13 19:29:12 -08002585 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 * work_color which is previous to @work_color and all will be
2587 * advanced to @work_color.
2588 *
2589 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002590 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002591 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002592 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002593 * %true if @flush_color >= 0 and there's something to flush. %false
2594 * otherwise.
2595 */
Tejun Heo112202d2013-02-13 19:29:12 -08002596static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002597 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598{
Tejun Heo73f53c42010-06-29 10:07:11 +02002599 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002600 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002601
Tejun Heo73f53c42010-06-29 10:07:11 +02002602 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002603 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002604 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002605 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002606
Tejun Heo49e3cf42013-03-12 11:29:58 -07002607 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002608 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002609
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002610 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002611
2612 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002613 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002614
Tejun Heo112202d2013-02-13 19:29:12 -08002615 if (pwq->nr_in_flight[flush_color]) {
2616 pwq->flush_color = flush_color;
2617 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002618 wait = true;
2619 }
2620 }
2621
2622 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002623 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002624 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002625 }
2626
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002627 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002628 }
2629
Tejun Heo112202d2013-02-13 19:29:12 -08002630 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002631 complete(&wq->first_flusher->done);
2632
2633 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634}
2635
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002636/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002637 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002638 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002640 * This function sleeps until all work items which were queued on entry
2641 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002643void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644{
Tejun Heo73f53c42010-06-29 10:07:11 +02002645 struct wq_flusher this_flusher = {
2646 .list = LIST_HEAD_INIT(this_flusher.list),
2647 .flush_color = -1,
Byungchul Parkfd1a5b02017-10-25 17:56:04 +09002648 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
Tejun Heo73f53c42010-06-29 10:07:11 +02002649 };
2650 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002651
Tejun Heo3347fa02016-09-16 15:49:32 -04002652 if (WARN_ON(!wq_online))
2653 return;
2654
Johannes Berg87915ad2018-08-22 11:49:04 +02002655 lock_map_acquire(&wq->lockdep_map);
2656 lock_map_release(&wq->lockdep_map);
2657
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002658 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002659
2660 /*
2661 * Start-to-wait phase
2662 */
2663 next_color = work_next_color(wq->work_color);
2664
2665 if (next_color != wq->flush_color) {
2666 /*
2667 * Color space is not full. The current work_color
2668 * becomes our flush_color and work_color is advanced
2669 * by one.
2670 */
Tejun Heo6183c002013-03-12 11:29:57 -07002671 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002672 this_flusher.flush_color = wq->work_color;
2673 wq->work_color = next_color;
2674
2675 if (!wq->first_flusher) {
2676 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002677 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002678
2679 wq->first_flusher = &this_flusher;
2680
Tejun Heo112202d2013-02-13 19:29:12 -08002681 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002682 wq->work_color)) {
2683 /* nothing to flush, done */
2684 wq->flush_color = next_color;
2685 wq->first_flusher = NULL;
2686 goto out_unlock;
2687 }
2688 } else {
2689 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002690 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002691 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002692 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002693 }
2694 } else {
2695 /*
2696 * Oops, color space is full, wait on overflow queue.
2697 * The next flush completion will assign us
2698 * flush_color and transfer to flusher_queue.
2699 */
2700 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2701 }
2702
Tejun Heofca839c2015-12-07 10:58:57 -05002703 check_flush_dependency(wq, NULL);
2704
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002705 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002706
2707 wait_for_completion(&this_flusher.done);
2708
2709 /*
2710 * Wake-up-and-cascade phase
2711 *
2712 * First flushers are responsible for cascading flushes and
2713 * handling overflow. Non-first flushers can simply return.
2714 */
2715 if (wq->first_flusher != &this_flusher)
2716 return;
2717
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002718 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002719
Tejun Heo4ce48b32010-07-02 10:03:51 +02002720 /* we might have raced, check again with mutex held */
2721 if (wq->first_flusher != &this_flusher)
2722 goto out_unlock;
2723
Tejun Heo73f53c42010-06-29 10:07:11 +02002724 wq->first_flusher = NULL;
2725
Tejun Heo6183c002013-03-12 11:29:57 -07002726 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2727 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002728
2729 while (true) {
2730 struct wq_flusher *next, *tmp;
2731
2732 /* complete all the flushers sharing the current flush color */
2733 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2734 if (next->flush_color != wq->flush_color)
2735 break;
2736 list_del_init(&next->list);
2737 complete(&next->done);
2738 }
2739
Tejun Heo6183c002013-03-12 11:29:57 -07002740 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2741 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002742
2743 /* this flush_color is finished, advance by one */
2744 wq->flush_color = work_next_color(wq->flush_color);
2745
2746 /* one color has been freed, handle overflow queue */
2747 if (!list_empty(&wq->flusher_overflow)) {
2748 /*
2749 * Assign the same color to all overflowed
2750 * flushers, advance work_color and append to
2751 * flusher_queue. This is the start-to-wait
2752 * phase for these overflowed flushers.
2753 */
2754 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2755 tmp->flush_color = wq->work_color;
2756
2757 wq->work_color = work_next_color(wq->work_color);
2758
2759 list_splice_tail_init(&wq->flusher_overflow,
2760 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002761 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002762 }
2763
2764 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002765 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002766 break;
2767 }
2768
2769 /*
2770 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002771 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002772 */
Tejun Heo6183c002013-03-12 11:29:57 -07002773 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2774 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002775
2776 list_del_init(&next->list);
2777 wq->first_flusher = next;
2778
Tejun Heo112202d2013-02-13 19:29:12 -08002779 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002780 break;
2781
2782 /*
2783 * Meh... this color is already done, clear first
2784 * flusher and repeat cascading.
2785 */
2786 wq->first_flusher = NULL;
2787 }
2788
2789out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002790 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791}
Tim Gardner1dadafa2015-08-04 11:26:04 -06002792EXPORT_SYMBOL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002794/**
2795 * drain_workqueue - drain a workqueue
2796 * @wq: workqueue to drain
2797 *
2798 * Wait until the workqueue becomes empty. While draining is in progress,
2799 * only chain queueing is allowed. IOW, only currently pending or running
2800 * work items on @wq can queue further work items on it. @wq is flushed
Chen Hanxiaob749b1b2015-05-13 06:10:05 -04002801 * repeatedly until it becomes empty. The number of flushing is determined
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002802 * by the depth of chaining and should be relatively short. Whine if it
2803 * takes too long.
2804 */
2805void drain_workqueue(struct workqueue_struct *wq)
2806{
2807 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002808 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002809
2810 /*
2811 * __queue_work() needs to test whether there are drainers, is much
2812 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002813 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002814 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002815 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002816 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002817 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002818 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002819reflush:
2820 flush_workqueue(wq);
2821
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002822 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002823
Tejun Heo49e3cf42013-03-12 11:29:58 -07002824 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002825 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002826
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002827 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002828 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002829 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002830
2831 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002832 continue;
2833
2834 if (++flush_cnt == 10 ||
2835 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002836 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002837 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002838
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002839 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002840 goto reflush;
2841 }
2842
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002843 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002844 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002845 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002846}
2847EXPORT_SYMBOL_GPL(drain_workqueue);
2848
Johannes Bergd6e89782018-08-22 11:49:03 +02002849static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2850 bool from_cancel)
Tejun Heobaf59022010-09-16 10:42:16 +02002851{
2852 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002853 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002854 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002855
2856 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002857
Tejun Heofa1b54e2013-03-12 11:30:00 -07002858 local_irq_disable();
2859 pool = get_work_pool(work);
2860 if (!pool) {
2861 local_irq_enable();
2862 return false;
2863 }
2864
2865 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002866 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002867 pwq = get_work_pwq(work);
2868 if (pwq) {
2869 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002870 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002871 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002872 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002873 if (!worker)
2874 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002875 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002876 }
Tejun Heobaf59022010-09-16 10:42:16 +02002877
Tejun Heofca839c2015-12-07 10:58:57 -05002878 check_flush_dependency(pwq->wq, work);
2879
Tejun Heo112202d2013-02-13 19:29:12 -08002880 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002881 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002882
Tejun Heoe159489b2011-01-09 23:32:15 +01002883 /*
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002884 * Force a lock recursion deadlock when using flush_work() inside a
2885 * single-threaded or rescuer equipped workqueue.
2886 *
2887 * For single threaded workqueues the deadlock happens when the work
2888 * is after the work issuing the flush_work(). For rescuer equipped
2889 * workqueues the deadlock happens when the rescuer stalls, blocking
2890 * forward progress.
Tejun Heoe159489b2011-01-09 23:32:15 +01002891 */
Johannes Bergd6e89782018-08-22 11:49:03 +02002892 if (!from_cancel &&
2893 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
Tejun Heo112202d2013-02-13 19:29:12 -08002894 lock_map_acquire(&pwq->wq->lockdep_map);
Peter Zijlstraa1d14932017-08-23 12:52:32 +02002895 lock_map_release(&pwq->wq->lockdep_map);
2896 }
Tejun Heoe159489b2011-01-09 23:32:15 +01002897
Tejun Heobaf59022010-09-16 10:42:16 +02002898 return true;
2899already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002900 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002901 return false;
2902}
2903
Johannes Bergd6e89782018-08-22 11:49:03 +02002904static bool __flush_work(struct work_struct *work, bool from_cancel)
2905{
2906 struct wq_barrier barr;
2907
2908 if (WARN_ON(!wq_online))
2909 return false;
2910
Tetsuo Handa4d43d392019-01-23 09:44:12 +09002911 if (WARN_ON(!work->func))
2912 return false;
2913
Johannes Berg87915ad2018-08-22 11:49:04 +02002914 if (!from_cancel) {
2915 lock_map_acquire(&work->lockdep_map);
2916 lock_map_release(&work->lockdep_map);
2917 }
2918
Johannes Bergd6e89782018-08-22 11:49:03 +02002919 if (start_flush_work(work, &barr, from_cancel)) {
2920 wait_for_completion(&barr.done);
2921 destroy_work_on_stack(&barr.work);
2922 return true;
2923 } else {
2924 return false;
2925 }
2926}
2927
Oleg Nesterovdb700892008-07-25 01:47:49 -07002928/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002929 * flush_work - wait for a work to finish executing the last queueing instance
2930 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002931 *
Tejun Heo606a5022012-08-20 14:51:23 -07002932 * Wait until @work has finished execution. @work is guaranteed to be idle
2933 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002934 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002935 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002936 * %true if flush_work() waited for the work to finish execution,
2937 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002938 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002939bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002940{
Johannes Bergd6e89782018-08-22 11:49:03 +02002941 return __flush_work(work, false);
Oleg Nesterovdb700892008-07-25 01:47:49 -07002942}
2943EXPORT_SYMBOL_GPL(flush_work);
2944
Tejun Heo8603e1b32015-03-05 08:04:13 -05002945struct cwt_wait {
Ingo Molnarac6424b2017-06-20 12:06:13 +02002946 wait_queue_entry_t wait;
Tejun Heo8603e1b32015-03-05 08:04:13 -05002947 struct work_struct *work;
2948};
2949
Ingo Molnarac6424b2017-06-20 12:06:13 +02002950static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Tejun Heo8603e1b32015-03-05 08:04:13 -05002951{
2952 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2953
2954 if (cwait->work != key)
2955 return 0;
2956 return autoremove_wake_function(wait, mode, sync, key);
2957}
2958
Tejun Heo36e227d2012-08-03 10:30:46 -07002959static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002960{
Tejun Heo8603e1b32015-03-05 08:04:13 -05002961 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
Tejun Heobbb68df2012-08-03 10:30:46 -07002962 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002963 int ret;
2964
2965 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002966 ret = try_to_grab_pending(work, is_dwork, &flags);
2967 /*
Tejun Heo8603e1b32015-03-05 08:04:13 -05002968 * If someone else is already canceling, wait for it to
2969 * finish. flush_work() doesn't work for PREEMPT_NONE
2970 * because we may get scheduled between @work's completion
2971 * and the other canceling task resuming and clearing
2972 * CANCELING - flush_work() will return false immediately
2973 * as @work is no longer busy, try_to_grab_pending() will
2974 * return -ENOENT as @work is still being canceled and the
2975 * other canceling task won't be able to clear CANCELING as
2976 * we're hogging the CPU.
2977 *
2978 * Let's wait for completion using a waitqueue. As this
2979 * may lead to the thundering herd problem, use a custom
2980 * wake function which matches @work along with exclusive
2981 * wait and wakeup.
Tejun Heobbb68df2012-08-03 10:30:46 -07002982 */
Tejun Heo8603e1b32015-03-05 08:04:13 -05002983 if (unlikely(ret == -ENOENT)) {
2984 struct cwt_wait cwait;
2985
2986 init_wait(&cwait.wait);
2987 cwait.wait.func = cwt_wakefn;
2988 cwait.work = work;
2989
2990 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2991 TASK_UNINTERRUPTIBLE);
2992 if (work_is_canceling(work))
2993 schedule();
2994 finish_wait(&cancel_waitq, &cwait.wait);
2995 }
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002996 } while (unlikely(ret < 0));
2997
Tejun Heobbb68df2012-08-03 10:30:46 -07002998 /* tell other tasks trying to grab @work to back off */
2999 mark_work_canceling(work);
3000 local_irq_restore(flags);
3001
Tejun Heo3347fa02016-09-16 15:49:32 -04003002 /*
3003 * This allows canceling during early boot. We know that @work
3004 * isn't executing.
3005 */
3006 if (wq_online)
Johannes Bergd6e89782018-08-22 11:49:03 +02003007 __flush_work(work, true);
Tejun Heo3347fa02016-09-16 15:49:32 -04003008
Tejun Heo7a22ad72010-06-29 10:07:13 +02003009 clear_work_data(work);
Tejun Heo8603e1b32015-03-05 08:04:13 -05003010
3011 /*
3012 * Paired with prepare_to_wait() above so that either
3013 * waitqueue_active() is visible here or !work_is_canceling() is
3014 * visible there.
3015 */
3016 smp_mb();
3017 if (waitqueue_active(&cancel_waitq))
3018 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3019
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003020 return ret;
3021}
3022
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003023/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003024 * cancel_work_sync - cancel a work and wait for it to finish
3025 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003026 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003027 * Cancel @work and wait for its execution to finish. This function
3028 * can be used even if the work re-queues itself or migrates to
3029 * another workqueue. On return from this function, @work is
3030 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003031 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003032 * cancel_work_sync(&delayed_work->work) must not be used for
3033 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003034 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003035 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003036 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02003037 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003038 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003039 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003040 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003041bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003042{
Tejun Heo36e227d2012-08-03 10:30:46 -07003043 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003044}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07003045EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07003046
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003047/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003048 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3049 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003050 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003051 * Delayed timer is cancelled and the pending work is queued for
3052 * immediate execution. Like flush_work(), this function only
3053 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003054 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003055 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003056 * %true if flush_work() waited for the work to finish execution,
3057 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003058 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003059bool flush_delayed_work(struct delayed_work *dwork)
3060{
Tejun Heo8930cab2012-08-03 10:30:45 -07003061 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003062 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08003063 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003064 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003065 return flush_work(&dwork->work);
3066}
3067EXPORT_SYMBOL(flush_delayed_work);
3068
Tejun Heo05f0fe62018-03-14 12:45:13 -07003069/**
3070 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3071 * @rwork: the rcu work to flush
3072 *
3073 * Return:
3074 * %true if flush_rcu_work() waited for the work to finish execution,
3075 * %false if it was already idle.
3076 */
3077bool flush_rcu_work(struct rcu_work *rwork)
3078{
3079 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3080 rcu_barrier();
3081 flush_work(&rwork->work);
3082 return true;
3083 } else {
3084 return flush_work(&rwork->work);
3085 }
3086}
3087EXPORT_SYMBOL(flush_rcu_work);
3088
Jens Axboef72b8792016-08-24 15:51:50 -06003089static bool __cancel_work(struct work_struct *work, bool is_dwork)
3090{
3091 unsigned long flags;
3092 int ret;
3093
3094 do {
3095 ret = try_to_grab_pending(work, is_dwork, &flags);
3096 } while (unlikely(ret == -EAGAIN));
3097
3098 if (unlikely(ret < 0))
3099 return false;
3100
3101 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3102 local_irq_restore(flags);
3103 return ret;
3104}
3105
Tejun Heo401a8d02010-09-16 10:36:00 +02003106/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07003107 * cancel_delayed_work - cancel a delayed work
3108 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02003109 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003110 * Kill off a pending delayed_work.
3111 *
3112 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3113 * pending.
3114 *
3115 * Note:
3116 * The work callback function may still be running on return, unless
3117 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3118 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02003119 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07003120 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02003121 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003122bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003123{
Jens Axboef72b8792016-08-24 15:51:50 -06003124 return __cancel_work(&dwork->work, true);
Tejun Heo09383492010-09-16 10:48:29 +02003125}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003126EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003127
3128/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003129 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3130 * @dwork: the delayed work cancel
3131 *
3132 * This is cancel_work_sync() for delayed works.
3133 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003134 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02003135 * %true if @dwork was pending, %false otherwise.
3136 */
3137bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003138{
Tejun Heo36e227d2012-08-03 10:30:46 -07003139 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003140}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003141EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003143/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003144 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003145 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003146 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003147 * schedule_on_each_cpu() executes @func on each online CPU using the
3148 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003149 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003150 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003151 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02003152 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003153 */
David Howells65f27f32006-11-22 14:55:48 +00003154int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003155{
3156 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003157 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003158
Andrew Mortonb6136772006-06-25 05:47:49 -07003159 works = alloc_percpu(struct work_struct);
3160 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003161 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003162
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003163 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003164
Christoph Lameter15316ba2006-01-08 01:00:43 -08003165 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003166 struct work_struct *work = per_cpu_ptr(works, cpu);
3167
3168 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003169 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003170 }
Tejun Heo93981802009-11-17 14:06:20 -08003171
3172 for_each_online_cpu(cpu)
3173 flush_work(per_cpu_ptr(works, cpu));
3174
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003175 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003176 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003177 return 0;
3178}
3179
Alan Sterneef6a7d2010-02-12 17:39:21 +09003180/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003181 * execute_in_process_context - reliably execute the routine with user context
3182 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003183 * @ew: guaranteed storage for the execute work structure (must
3184 * be available when the work executes)
3185 *
3186 * Executes the function immediately if process context is available,
3187 * otherwise schedules the function for delayed execution.
3188 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003189 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06003190 * 1 - function was scheduled for execution
3191 */
David Howells65f27f32006-11-22 14:55:48 +00003192int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003193{
3194 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003195 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003196 return 0;
3197 }
3198
David Howells65f27f32006-11-22 14:55:48 +00003199 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003200 schedule_work(&ew->work);
3201
3202 return 1;
3203}
3204EXPORT_SYMBOL_GPL(execute_in_process_context);
3205
Tejun Heo7a4e3442013-03-12 11:30:00 -07003206/**
3207 * free_workqueue_attrs - free a workqueue_attrs
3208 * @attrs: workqueue_attrs to free
3209 *
3210 * Undo alloc_workqueue_attrs().
3211 */
3212void free_workqueue_attrs(struct workqueue_attrs *attrs)
3213{
3214 if (attrs) {
3215 free_cpumask_var(attrs->cpumask);
3216 kfree(attrs);
3217 }
3218}
3219
3220/**
3221 * alloc_workqueue_attrs - allocate a workqueue_attrs
3222 * @gfp_mask: allocation mask to use
3223 *
3224 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003225 * return it.
3226 *
3227 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003228 */
3229struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3230{
3231 struct workqueue_attrs *attrs;
3232
3233 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3234 if (!attrs)
3235 goto fail;
3236 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3237 goto fail;
3238
Tejun Heo13e2e552013-04-01 11:23:31 -07003239 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003240 return attrs;
3241fail:
3242 free_workqueue_attrs(attrs);
3243 return NULL;
3244}
3245
Tejun Heo29c91e92013-03-12 11:30:03 -07003246static void copy_workqueue_attrs(struct workqueue_attrs *to,
3247 const struct workqueue_attrs *from)
3248{
3249 to->nice = from->nice;
3250 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003251 /*
3252 * Unlike hash and equality test, this function doesn't ignore
3253 * ->no_numa as it is used for both pool and wq attrs. Instead,
3254 * get_unbound_pool() explicitly clears ->no_numa after copying.
3255 */
3256 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003257}
3258
Tejun Heo29c91e92013-03-12 11:30:03 -07003259/* hash value of the content of @attr */
3260static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3261{
3262 u32 hash = 0;
3263
3264 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003265 hash = jhash(cpumask_bits(attrs->cpumask),
3266 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003267 return hash;
3268}
3269
3270/* content equality test */
3271static bool wqattrs_equal(const struct workqueue_attrs *a,
3272 const struct workqueue_attrs *b)
3273{
3274 if (a->nice != b->nice)
3275 return false;
3276 if (!cpumask_equal(a->cpumask, b->cpumask))
3277 return false;
3278 return true;
3279}
3280
Tejun Heo7a4e3442013-03-12 11:30:00 -07003281/**
3282 * init_worker_pool - initialize a newly zalloc'd worker_pool
3283 * @pool: worker_pool to initialize
3284 *
Shailendra Verma402dd892015-05-23 10:38:14 +05303285 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003286 *
3287 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003288 * inside @pool proper are initialized and put_unbound_pool() can be called
3289 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003290 */
3291static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003292{
3293 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003294 pool->id = -1;
3295 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003296 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003297 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo82607adc2015-12-08 11:28:04 -05003298 pool->watchdog_ts = jiffies;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003299 INIT_LIST_HEAD(&pool->worklist);
3300 INIT_LIST_HEAD(&pool->idle_list);
3301 hash_init(pool->busy_hash);
3302
Kees Cook32a6c722017-10-16 15:58:25 -07003303 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003304
Kees Cook32a6c722017-10-16 15:58:25 -07003305 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003306
Lai Jiangshanda028462014-05-20 17:46:31 +08003307 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003308
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003309 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003310 INIT_HLIST_NODE(&pool->hash_node);
3311 pool->refcnt = 1;
3312
3313 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003314 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3315 if (!pool->attrs)
3316 return -ENOMEM;
3317 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003318}
3319
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003320static void rcu_free_wq(struct rcu_head *rcu)
3321{
3322 struct workqueue_struct *wq =
3323 container_of(rcu, struct workqueue_struct, rcu);
3324
3325 if (!(wq->flags & WQ_UNBOUND))
3326 free_percpu(wq->cpu_pwqs);
3327 else
3328 free_workqueue_attrs(wq->unbound_attrs);
3329
3330 kfree(wq->rescuer);
3331 kfree(wq);
3332}
3333
Tejun Heo29c91e92013-03-12 11:30:03 -07003334static void rcu_free_pool(struct rcu_head *rcu)
3335{
3336 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3337
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003338 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003339 free_workqueue_attrs(pool->attrs);
3340 kfree(pool);
3341}
3342
3343/**
3344 * put_unbound_pool - put a worker_pool
3345 * @pool: worker_pool to put
3346 *
3347 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003348 * safe manner. get_unbound_pool() calls this function on its failure path
3349 * and this function should be able to release pools which went through,
3350 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003351 *
3352 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003353 */
3354static void put_unbound_pool(struct worker_pool *pool)
3355{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003356 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003357 struct worker *worker;
3358
Tejun Heoa892cac2013-04-01 11:23:32 -07003359 lockdep_assert_held(&wq_pool_mutex);
3360
3361 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003362 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003363
3364 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003365 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003366 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003367 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003368
3369 /* release id and unhash */
3370 if (pool->id >= 0)
3371 idr_remove(&worker_pool_idr, pool->id);
3372 hash_del(&pool->hash_node);
3373
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003374 /*
Tejun Heo692b4822017-10-09 08:04:13 -07003375 * Become the manager and destroy all workers. This prevents
3376 * @pool's workers from blocking on attach_mutex. We're the last
3377 * manager and @pool gets freed with the flag set.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003378 */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003379 spin_lock_irq(&pool->lock);
Tejun Heo692b4822017-10-09 08:04:13 -07003380 wait_event_lock_irq(wq_manager_wait,
3381 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3382 pool->flags |= POOL_MANAGER_ACTIVE;
3383
Lai Jiangshan1037de32014-05-22 16:44:07 +08003384 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003385 destroy_worker(worker);
3386 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003387 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003388
Tejun Heo1258fae2018-05-18 08:47:13 -07003389 mutex_lock(&wq_pool_attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003390 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003391 pool->detach_completion = &detach_completion;
Tejun Heo1258fae2018-05-18 08:47:13 -07003392 mutex_unlock(&wq_pool_attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003393
3394 if (pool->detach_completion)
3395 wait_for_completion(pool->detach_completion);
3396
Tejun Heo29c91e92013-03-12 11:30:03 -07003397 /* shut down the timers */
3398 del_timer_sync(&pool->idle_timer);
3399 del_timer_sync(&pool->mayday_timer);
3400
3401 /* sched-RCU protected to allow dereferences from get_work_pool() */
Paul E. McKenney25b00772018-11-06 19:18:45 -08003402 call_rcu(&pool->rcu, rcu_free_pool);
Tejun Heo29c91e92013-03-12 11:30:03 -07003403}
3404
3405/**
3406 * get_unbound_pool - get a worker_pool with the specified attributes
3407 * @attrs: the attributes of the worker_pool to get
3408 *
3409 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3410 * reference count and return it. If there already is a matching
3411 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003412 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003413 *
3414 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003415 *
3416 * Return: On success, a worker_pool with the same attributes as @attrs.
3417 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003418 */
3419static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3420{
Tejun Heo29c91e92013-03-12 11:30:03 -07003421 u32 hash = wqattrs_hash(attrs);
3422 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003423 int node;
Xunlei Pange22735842015-10-09 11:53:12 +08003424 int target_node = NUMA_NO_NODE;
Tejun Heo29c91e92013-03-12 11:30:03 -07003425
Tejun Heoa892cac2013-04-01 11:23:32 -07003426 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003427
3428 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003429 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3430 if (wqattrs_equal(pool->attrs, attrs)) {
3431 pool->refcnt++;
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003432 return pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003433 }
3434 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003435
Xunlei Pange22735842015-10-09 11:53:12 +08003436 /* if cpumask is contained inside a NUMA node, we belong to that node */
3437 if (wq_numa_enabled) {
3438 for_each_node(node) {
3439 if (cpumask_subset(attrs->cpumask,
3440 wq_numa_possible_cpumask[node])) {
3441 target_node = node;
3442 break;
3443 }
3444 }
3445 }
3446
Tejun Heo29c91e92013-03-12 11:30:03 -07003447 /* nope, create a new one */
Xunlei Pange22735842015-10-09 11:53:12 +08003448 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
Tejun Heo29c91e92013-03-12 11:30:03 -07003449 if (!pool || init_worker_pool(pool) < 0)
3450 goto fail;
3451
Tejun Heo8864b4e2013-03-12 11:30:04 -07003452 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003453 copy_workqueue_attrs(pool->attrs, attrs);
Xunlei Pange22735842015-10-09 11:53:12 +08003454 pool->node = target_node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003455
Shaohua Li2865a8f2013-08-01 09:56:36 +08003456 /*
3457 * no_numa isn't a worker_pool attribute, always clear it. See
3458 * 'struct workqueue_attrs' comments for detail.
3459 */
3460 pool->attrs->no_numa = false;
3461
Tejun Heo29c91e92013-03-12 11:30:03 -07003462 if (worker_pool_assign_id(pool) < 0)
3463 goto fail;
3464
3465 /* create and start the initial worker */
Tejun Heo3347fa02016-09-16 15:49:32 -04003466 if (wq_online && !create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003467 goto fail;
3468
Tejun Heo29c91e92013-03-12 11:30:03 -07003469 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003470 hash_add(unbound_pool_hash, &pool->hash_node, hash);
Lai Jiangshan3fb18232014-07-22 13:04:49 +08003471
Tejun Heo29c91e92013-03-12 11:30:03 -07003472 return pool;
3473fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003474 if (pool)
3475 put_unbound_pool(pool);
3476 return NULL;
3477}
3478
Tejun Heo8864b4e2013-03-12 11:30:04 -07003479static void rcu_free_pwq(struct rcu_head *rcu)
3480{
3481 kmem_cache_free(pwq_cache,
3482 container_of(rcu, struct pool_workqueue, rcu));
3483}
3484
3485/*
3486 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3487 * and needs to be destroyed.
3488 */
3489static void pwq_unbound_release_workfn(struct work_struct *work)
3490{
3491 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3492 unbound_release_work);
3493 struct workqueue_struct *wq = pwq->wq;
3494 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003495 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003496
3497 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3498 return;
3499
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003500 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003501 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003502 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003503 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003504
Tejun Heoa892cac2013-04-01 11:23:32 -07003505 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003506 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003507 mutex_unlock(&wq_pool_mutex);
3508
Paul E. McKenney25b00772018-11-06 19:18:45 -08003509 call_rcu(&pwq->rcu, rcu_free_pwq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003510
3511 /*
3512 * If we're the last pwq going away, @wq is already dead and no one
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003513 * is gonna access it anymore. Schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07003514 */
Tejun Heoe2dca7a2015-03-09 09:22:28 -04003515 if (is_last)
Paul E. McKenney25b00772018-11-06 19:18:45 -08003516 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003517}
3518
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003519/**
Tejun Heo699ce092013-03-13 16:51:35 -07003520 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003521 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003522 *
Tejun Heo699ce092013-03-13 16:51:35 -07003523 * If @pwq isn't freezing, set @pwq->max_active to the associated
3524 * workqueue's saved_max_active and activate delayed work items
3525 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003526 */
Tejun Heo699ce092013-03-13 16:51:35 -07003527static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003528{
Tejun Heo699ce092013-03-13 16:51:35 -07003529 struct workqueue_struct *wq = pwq->wq;
3530 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo3347fa02016-09-16 15:49:32 -04003531 unsigned long flags;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003532
Tejun Heo699ce092013-03-13 16:51:35 -07003533 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003534 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003535
3536 /* fast exit for non-freezable wqs */
3537 if (!freezable && pwq->max_active == wq->saved_max_active)
3538 return;
3539
Tejun Heo3347fa02016-09-16 15:49:32 -04003540 /* this function can be called during early boot w/ irq disabled */
3541 spin_lock_irqsave(&pwq->pool->lock, flags);
Tejun Heo699ce092013-03-13 16:51:35 -07003542
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003543 /*
3544 * During [un]freezing, the caller is responsible for ensuring that
3545 * this function is called at least once after @workqueue_freezing
3546 * is updated and visible.
3547 */
3548 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003549 pwq->max_active = wq->saved_max_active;
3550
3551 while (!list_empty(&pwq->delayed_works) &&
3552 pwq->nr_active < pwq->max_active)
3553 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003554
3555 /*
3556 * Need to kick a worker after thawed or an unbound wq's
3557 * max_active is bumped. It's a slow path. Do it always.
3558 */
3559 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003560 } else {
3561 pwq->max_active = 0;
3562 }
3563
Tejun Heo3347fa02016-09-16 15:49:32 -04003564 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003565}
3566
Tejun Heoe50aba92013-04-01 11:23:35 -07003567/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003568static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3569 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003570{
3571 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3572
Tejun Heoe50aba92013-04-01 11:23:35 -07003573 memset(pwq, 0, sizeof(*pwq));
3574
Tejun Heod2c1d402013-03-12 11:30:04 -07003575 pwq->pool = pool;
3576 pwq->wq = wq;
3577 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003578 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003579 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003580 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003581 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003582 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003583}
Tejun Heod2c1d402013-03-12 11:30:04 -07003584
Tejun Heof147f292013-04-01 11:23:35 -07003585/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003586static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003587{
3588 struct workqueue_struct *wq = pwq->wq;
3589
3590 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003591
Tejun Heo1befcf32013-04-01 11:23:35 -07003592 /* may be called multiple times, ignore if already linked */
3593 if (!list_empty(&pwq->pwqs_node))
3594 return;
3595
Lai Jiangshan29b1cb42014-07-22 13:04:27 +08003596 /* set the matching work_color */
Tejun Heo75ccf592013-03-12 11:30:04 -07003597 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003598
3599 /* sync max_active to the current setting */
3600 pwq_adjust_max_active(pwq);
3601
3602 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003603 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003604}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003605
Tejun Heof147f292013-04-01 11:23:35 -07003606/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3607static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3608 const struct workqueue_attrs *attrs)
3609{
3610 struct worker_pool *pool;
3611 struct pool_workqueue *pwq;
3612
3613 lockdep_assert_held(&wq_pool_mutex);
3614
3615 pool = get_unbound_pool(attrs);
3616 if (!pool)
3617 return NULL;
3618
Tejun Heoe50aba92013-04-01 11:23:35 -07003619 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003620 if (!pwq) {
3621 put_unbound_pool(pool);
3622 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003623 }
Tejun Heo6029a912013-04-01 11:23:34 -07003624
Tejun Heof147f292013-04-01 11:23:35 -07003625 init_pwq(pwq, wq, pool);
3626 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003627}
3628
Tejun Heo4c16bd32013-04-01 11:23:36 -07003629/**
Gong Zhaogang30186c62015-05-11 11:02:47 -04003630 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003631 * @attrs: the wq_attrs of the default pwq of the target workqueue
Tejun Heo4c16bd32013-04-01 11:23:36 -07003632 * @node: the target NUMA node
3633 * @cpu_going_down: if >= 0, the CPU to consider as offline
3634 * @cpumask: outarg, the resulting cpumask
3635 *
3636 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3637 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003638 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003639 *
3640 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3641 * enabled and @node has online CPUs requested by @attrs, the returned
3642 * cpumask is the intersection of the possible CPUs of @node and
3643 * @attrs->cpumask.
3644 *
3645 * The caller is responsible for ensuring that the cpumask of @node stays
3646 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003647 *
3648 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3649 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003650 */
3651static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3652 int cpu_going_down, cpumask_t *cpumask)
3653{
Tejun Heod55262c2013-04-01 11:23:38 -07003654 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003655 goto use_dfl;
3656
3657 /* does @node have any online CPUs @attrs wants? */
3658 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3659 if (cpu_going_down >= 0)
3660 cpumask_clear_cpu(cpu_going_down, cpumask);
3661
3662 if (cpumask_empty(cpumask))
3663 goto use_dfl;
3664
3665 /* yeap, return possible CPUs in @node that @attrs wants */
3666 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
Michael Bringmann1ad0f0a2017-07-27 16:27:14 -05003667
3668 if (cpumask_empty(cpumask)) {
3669 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3670 "possible intersect\n");
3671 return false;
3672 }
3673
Tejun Heo4c16bd32013-04-01 11:23:36 -07003674 return !cpumask_equal(cpumask, attrs->cpumask);
3675
3676use_dfl:
3677 cpumask_copy(cpumask, attrs->cpumask);
3678 return false;
3679}
3680
Tejun Heo1befcf32013-04-01 11:23:35 -07003681/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3682static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3683 int node,
3684 struct pool_workqueue *pwq)
3685{
3686 struct pool_workqueue *old_pwq;
3687
Lai Jiangshan5b95e1a2015-05-12 20:32:29 +08003688 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003689 lockdep_assert_held(&wq->mutex);
3690
3691 /* link_pwq() can handle duplicate calls */
3692 link_pwq(pwq);
3693
3694 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3695 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3696 return old_pwq;
3697}
3698
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003699/* context to store the prepared attrs & pwqs before applying */
3700struct apply_wqattrs_ctx {
3701 struct workqueue_struct *wq; /* target workqueue */
3702 struct workqueue_attrs *attrs; /* attrs to apply */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003703 struct list_head list; /* queued for batching commit */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003704 struct pool_workqueue *dfl_pwq;
3705 struct pool_workqueue *pwq_tbl[];
3706};
3707
3708/* free the resources after success or abort */
3709static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3710{
3711 if (ctx) {
3712 int node;
3713
3714 for_each_node(node)
3715 put_pwq_unlocked(ctx->pwq_tbl[node]);
3716 put_pwq_unlocked(ctx->dfl_pwq);
3717
3718 free_workqueue_attrs(ctx->attrs);
3719
3720 kfree(ctx);
3721 }
3722}
3723
3724/* allocate the attrs and pwqs for later installation */
3725static struct apply_wqattrs_ctx *
3726apply_wqattrs_prepare(struct workqueue_struct *wq,
3727 const struct workqueue_attrs *attrs)
3728{
3729 struct apply_wqattrs_ctx *ctx;
3730 struct workqueue_attrs *new_attrs, *tmp_attrs;
3731 int node;
3732
3733 lockdep_assert_held(&wq_pool_mutex);
3734
Kees Cookacafe7e2018-05-08 13:45:50 -07003735 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003736
3737 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3738 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3739 if (!ctx || !new_attrs || !tmp_attrs)
3740 goto out_free;
3741
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003742 /*
3743 * Calculate the attrs of the default pwq.
3744 * If the user configured cpumask doesn't overlap with the
3745 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3746 */
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003747 copy_workqueue_attrs(new_attrs, attrs);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08003748 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003749 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3750 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003751
3752 /*
3753 * We may create multiple pwqs with differing cpumasks. Make a
3754 * copy of @new_attrs which will be modified and used to obtain
3755 * pools.
3756 */
3757 copy_workqueue_attrs(tmp_attrs, new_attrs);
3758
3759 /*
3760 * If something goes wrong during CPU up/down, we'll fall back to
3761 * the default pwq covering whole @attrs->cpumask. Always create
3762 * it even if we don't use it immediately.
3763 */
3764 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3765 if (!ctx->dfl_pwq)
3766 goto out_free;
3767
3768 for_each_node(node) {
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003769 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003770 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3771 if (!ctx->pwq_tbl[node])
3772 goto out_free;
3773 } else {
3774 ctx->dfl_pwq->refcnt++;
3775 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3776 }
3777 }
3778
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003779 /* save the user configured attrs and sanitize it. */
3780 copy_workqueue_attrs(new_attrs, attrs);
3781 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003782 ctx->attrs = new_attrs;
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003783
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003784 ctx->wq = wq;
3785 free_workqueue_attrs(tmp_attrs);
3786 return ctx;
3787
3788out_free:
3789 free_workqueue_attrs(tmp_attrs);
3790 free_workqueue_attrs(new_attrs);
3791 apply_wqattrs_cleanup(ctx);
3792 return NULL;
3793}
3794
3795/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3796static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3797{
3798 int node;
3799
3800 /* all pwqs have been created successfully, let's install'em */
3801 mutex_lock(&ctx->wq->mutex);
3802
3803 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3804
3805 /* save the previous pwq and install the new one */
3806 for_each_node(node)
3807 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3808 ctx->pwq_tbl[node]);
3809
3810 /* @dfl_pwq might not have been used, ensure it's linked */
3811 link_pwq(ctx->dfl_pwq);
3812 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3813
3814 mutex_unlock(&ctx->wq->mutex);
3815}
3816
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003817static void apply_wqattrs_lock(void)
3818{
3819 /* CPUs should stay stable across pwq creations and installations */
3820 get_online_cpus();
3821 mutex_lock(&wq_pool_mutex);
3822}
3823
3824static void apply_wqattrs_unlock(void)
3825{
3826 mutex_unlock(&wq_pool_mutex);
3827 put_online_cpus();
3828}
3829
3830static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3831 const struct workqueue_attrs *attrs)
3832{
3833 struct apply_wqattrs_ctx *ctx;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003834
3835 /* only unbound workqueues can change attributes */
3836 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3837 return -EINVAL;
3838
3839 /* creating multiple pwqs breaks ordering guarantee */
Tejun Heo0a94efb2017-07-23 08:36:15 -04003840 if (!list_empty(&wq->pwqs)) {
3841 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3842 return -EINVAL;
3843
3844 wq->flags &= ~__WQ_ORDERED;
3845 }
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003846
3847 ctx = apply_wqattrs_prepare(wq, attrs);
wanghaibin62011712016-01-07 20:38:59 +08003848 if (!ctx)
3849 return -ENOMEM;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003850
3851 /* the ctx has been prepared successfully, let's commit it */
wanghaibin62011712016-01-07 20:38:59 +08003852 apply_wqattrs_commit(ctx);
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003853 apply_wqattrs_cleanup(ctx);
3854
wanghaibin62011712016-01-07 20:38:59 +08003855 return 0;
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003856}
3857
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003858/**
3859 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3860 * @wq: the target workqueue
3861 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3862 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003863 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3864 * machines, this function maps a separate pwq to each NUMA node with
3865 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3866 * NUMA node it was issued on. Older pwqs are released as in-flight work
3867 * items finish. Note that a work item which repeatedly requeues itself
3868 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003869 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003870 * Performs GFP_KERNEL allocations.
3871 *
3872 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003873 */
3874int apply_workqueue_attrs(struct workqueue_struct *wq,
3875 const struct workqueue_attrs *attrs)
3876{
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003877 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003878
Lai Jiangshana0111cf2015-05-19 18:03:47 +08003879 apply_wqattrs_lock();
3880 ret = apply_workqueue_attrs_locked(wq, attrs);
3881 apply_wqattrs_unlock();
Lai Jiangshan2d5f0762015-04-27 17:58:38 +08003882
Tejun Heo48621252013-04-01 11:23:31 -07003883 return ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003884}
NeilBrown6106c0f2018-01-11 15:06:40 +11003885EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003886
Tejun Heo4c16bd32013-04-01 11:23:36 -07003887/**
3888 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3889 * @wq: the target workqueue
3890 * @cpu: the CPU coming up or going down
3891 * @online: whether @cpu is coming up or going down
3892 *
3893 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3894 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3895 * @wq accordingly.
3896 *
3897 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3898 * falls back to @wq->dfl_pwq which may not be optimal but is always
3899 * correct.
3900 *
3901 * Note that when the last allowed CPU of a NUMA node goes offline for a
3902 * workqueue with a cpumask spanning multiple nodes, the workers which were
3903 * already executing the work items for the workqueue will lose their CPU
3904 * affinity and may execute on any CPU. This is similar to how per-cpu
3905 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3906 * affinity, it's the user's responsibility to flush the work item from
3907 * CPU_DOWN_PREPARE.
3908 */
3909static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3910 bool online)
3911{
3912 int node = cpu_to_node(cpu);
3913 int cpu_off = online ? -1 : cpu;
3914 struct pool_workqueue *old_pwq = NULL, *pwq;
3915 struct workqueue_attrs *target_attrs;
3916 cpumask_t *cpumask;
3917
3918 lockdep_assert_held(&wq_pool_mutex);
3919
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003920 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3921 wq->unbound_attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003922 return;
3923
3924 /*
3925 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3926 * Let's use a preallocated one. The following buf is protected by
3927 * CPU hotplug exclusion.
3928 */
3929 target_attrs = wq_update_unbound_numa_attrs_buf;
3930 cpumask = target_attrs->cpumask;
3931
Tejun Heo4c16bd32013-04-01 11:23:36 -07003932 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3933 pwq = unbound_pwq_by_node(wq, node);
3934
3935 /*
3936 * Let's determine what needs to be done. If the target cpumask is
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003937 * different from the default pwq's, we need to compare it to @pwq's
3938 * and create a new one if they don't match. If the target cpumask
3939 * equals the default pwq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003940 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08003941 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
Tejun Heo4c16bd32013-04-01 11:23:36 -07003942 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003943 return;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003944 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003945 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003946 }
3947
Tejun Heo4c16bd32013-04-01 11:23:36 -07003948 /* create a new pwq */
3949 pwq = alloc_unbound_pwq(wq, target_attrs);
3950 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003951 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3952 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003953 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003954 }
3955
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003956 /* Install the new pwq. */
Tejun Heo4c16bd32013-04-01 11:23:36 -07003957 mutex_lock(&wq->mutex);
3958 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3959 goto out_unlock;
3960
3961use_dfl_pwq:
Lai Jiangshanf7142ed2015-05-12 20:32:30 +08003962 mutex_lock(&wq->mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003963 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3964 get_pwq(wq->dfl_pwq);
3965 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3966 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3967out_unlock:
3968 mutex_unlock(&wq->mutex);
3969 put_pwq_unlocked(old_pwq);
3970}
3971
Tejun Heo30cdf2492013-03-12 11:29:57 -07003972static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003973{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003974 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003975 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003976
Tejun Heo30cdf2492013-03-12 11:29:57 -07003977 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003978 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3979 if (!wq->cpu_pwqs)
Tejun Heo30cdf2492013-03-12 11:29:57 -07003980 return -ENOMEM;
3981
3982 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003983 struct pool_workqueue *pwq =
3984 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003985 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003986 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003987
Tejun Heof147f292013-04-01 11:23:35 -07003988 init_pwq(pwq, wq, &cpu_pools[highpri]);
3989
3990 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003991 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003992 mutex_unlock(&wq->mutex);
Tejun Heo30cdf2492013-03-12 11:29:57 -07003993 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003994 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003995 } else if (wq->flags & __WQ_ORDERED) {
3996 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3997 /* there should only be single pwq for ordering guarantee */
3998 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3999 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4000 "ordering guarantee broken for workqueue %s\n", wq->name);
4001 return ret;
Tejun Heo30cdf2492013-03-12 11:29:57 -07004002 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07004003 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004004 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004005}
4006
Tejun Heof3421792010-07-02 10:03:51 +02004007static int wq_clamp_max_active(int max_active, unsigned int flags,
4008 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02004009{
Tejun Heof3421792010-07-02 10:03:51 +02004010 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4011
4012 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004013 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4014 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004015
Tejun Heof3421792010-07-02 10:03:51 +02004016 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004017}
4018
Tejun Heo983c7512018-01-08 05:38:32 -08004019/*
4020 * Workqueues which may be used during memory reclaim should have a rescuer
4021 * to guarantee forward progress.
4022 */
4023static int init_rescuer(struct workqueue_struct *wq)
4024{
4025 struct worker *rescuer;
4026 int ret;
4027
4028 if (!(wq->flags & WQ_MEM_RECLAIM))
4029 return 0;
4030
4031 rescuer = alloc_worker(NUMA_NO_NODE);
4032 if (!rescuer)
4033 return -ENOMEM;
4034
4035 rescuer->rescue_wq = wq;
4036 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4037 ret = PTR_ERR_OR_ZERO(rescuer->task);
4038 if (ret) {
4039 kfree(rescuer);
4040 return ret;
4041 }
4042
4043 wq->rescuer = rescuer;
4044 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4045 wake_up_process(rescuer->task);
4046
4047 return 0;
4048}
4049
Tejun Heob196be82012-01-10 15:11:35 -08004050struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004051 unsigned int flags,
4052 int max_active,
4053 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004054 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004055{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004056 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004057 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004058 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004059 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004060
Tejun Heo5c0338c2017-07-18 18:41:52 -04004061 /*
4062 * Unbound && max_active == 1 used to imply ordered, which is no
4063 * longer the case on NUMA machines due to per-node pools. While
4064 * alloc_ordered_workqueue() is the right way to create an ordered
4065 * workqueue, keep the previous behavior to avoid subtle breakages
4066 * on NUMA.
4067 */
4068 if ((flags & WQ_UNBOUND) && max_active == 1)
4069 flags |= __WQ_ORDERED;
4070
Viresh Kumarcee22a12013-04-08 16:45:40 +05304071 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4072 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4073 flags |= WQ_UNBOUND;
4074
Tejun Heoecf68812013-04-01 11:23:34 -07004075 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004076 if (flags & WQ_UNBOUND)
Lai Jiangshanddcb57e2014-07-22 13:05:40 +08004077 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004078
4079 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004080 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004081 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004082
Tejun Heo6029a912013-04-01 11:23:34 -07004083 if (flags & WQ_UNBOUND) {
4084 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4085 if (!wq->unbound_attrs)
4086 goto err_free_wq;
4087 }
4088
Tejun Heoecf68812013-04-01 11:23:34 -07004089 va_start(args, lock_name);
4090 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004091 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004092
Tejun Heod320c032010-06-29 10:07:14 +02004093 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004094 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004095
Tejun Heob196be82012-01-10 15:11:35 -08004096 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004097 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004098 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004099 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004100 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf2492013-03-12 11:29:57 -07004101 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004102 INIT_LIST_HEAD(&wq->flusher_queue);
4103 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004104 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004105
Johannes Bergeb13ba82008-01-16 09:51:58 +01004106 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004107 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004108
Tejun Heo30cdf2492013-03-12 11:29:57 -07004109 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004110 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004111
Tejun Heo40c17f72018-01-08 05:38:37 -08004112 if (wq_online && init_rescuer(wq) < 0)
Tejun Heo983c7512018-01-08 05:38:32 -08004113 goto err_destroy;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004114
Tejun Heo226223a2013-03-12 11:30:05 -07004115 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4116 goto err_destroy;
4117
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004118 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004119 * wq_pool_mutex protects global freeze state and workqueues list.
4120 * Grab it, adjust max_active and add the new @wq to workqueues
4121 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004122 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004123 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004124
Lai Jiangshana357fc02013-03-25 16:57:19 -07004125 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004126 for_each_pwq(pwq, wq)
4127 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004128 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004129
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004130 list_add_tail_rcu(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004131
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004132 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004133
Oleg Nesterov3af244332007-05-09 02:34:09 -07004134 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004135
4136err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004137 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004138 kfree(wq);
4139 return NULL;
4140err_destroy:
4141 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004142 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004143}
Tejun Heod320c032010-06-29 10:07:14 +02004144EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004145
4146/**
4147 * destroy_workqueue - safely terminate a workqueue
4148 * @wq: target workqueue
4149 *
4150 * Safely destroy a workqueue. All work currently pending will be done first.
4151 */
4152void destroy_workqueue(struct workqueue_struct *wq)
4153{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004154 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004155 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004156
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004157 /* drain it before proceeding with destruction */
4158 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004159
Tejun Heo6183c002013-03-12 11:29:57 -07004160 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004161 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004162 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004163 int i;
4164
Tejun Heo76af4d92013-03-12 11:30:00 -07004165 for (i = 0; i < WORK_NR_COLORS; i++) {
4166 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004167 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004168 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004169 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004170 }
4171 }
4172
Lai Jiangshan5c529592013-04-04 10:05:38 +08004173 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004174 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004175 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004176 mutex_unlock(&wq->mutex);
Tejun Heofa07fb62016-09-05 08:54:06 -04004177 show_workqueue_state();
Tejun Heo6183c002013-03-12 11:29:57 -07004178 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004179 }
Tejun Heo6183c002013-03-12 11:29:57 -07004180 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004181 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004182
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004183 /*
4184 * wq list is used to freeze wq, remove from list after
4185 * flushing is complete in case freeze races us.
4186 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004187 mutex_lock(&wq_pool_mutex);
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004188 list_del_rcu(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004189 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004190
Tejun Heo226223a2013-03-12 11:30:05 -07004191 workqueue_sysfs_unregister(wq);
4192
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004193 if (wq->rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02004194 kthread_stop(wq->rescuer->task);
Tejun Heoe22bee72010-06-29 10:07:14 +02004195
Tejun Heo8864b4e2013-03-12 11:30:04 -07004196 if (!(wq->flags & WQ_UNBOUND)) {
4197 /*
4198 * The base ref is never dropped on per-cpu pwqs. Directly
Tejun Heoe2dca7a2015-03-09 09:22:28 -04004199 * schedule RCU free.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004200 */
Paul E. McKenney25b00772018-11-06 19:18:45 -08004201 call_rcu(&wq->rcu, rcu_free_wq);
Tejun Heo8864b4e2013-03-12 11:30:04 -07004202 } else {
4203 /*
4204 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004205 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4206 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004207 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004208 for_each_node(node) {
4209 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4210 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4211 put_pwq_unlocked(pwq);
4212 }
4213
4214 /*
4215 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4216 * put. Don't access it afterwards.
4217 */
4218 pwq = wq->dfl_pwq;
4219 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004220 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004221 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004222}
4223EXPORT_SYMBOL_GPL(destroy_workqueue);
4224
Tejun Heodcd989c2010-06-29 10:07:14 +02004225/**
4226 * workqueue_set_max_active - adjust max_active of a workqueue
4227 * @wq: target workqueue
4228 * @max_active: new max_active value.
4229 *
4230 * Set max_active of @wq to @max_active.
4231 *
4232 * CONTEXT:
4233 * Don't call from IRQ context.
4234 */
4235void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4236{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004237 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004238
Tejun Heo8719dce2013-03-12 11:30:04 -07004239 /* disallow meddling with max_active for ordered workqueues */
Tejun Heo0a94efb2017-07-23 08:36:15 -04004240 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Tejun Heo8719dce2013-03-12 11:30:04 -07004241 return;
4242
Tejun Heof3421792010-07-02 10:03:51 +02004243 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004244
Lai Jiangshana357fc02013-03-25 16:57:19 -07004245 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004246
Tejun Heo0a94efb2017-07-23 08:36:15 -04004247 wq->flags &= ~__WQ_ORDERED;
Tejun Heodcd989c2010-06-29 10:07:14 +02004248 wq->saved_max_active = max_active;
4249
Tejun Heo699ce092013-03-13 16:51:35 -07004250 for_each_pwq(pwq, wq)
4251 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004252
Lai Jiangshana357fc02013-03-25 16:57:19 -07004253 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004254}
4255EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4256
4257/**
Lukas Wunner27d4ee02018-02-11 10:38:28 +01004258 * current_work - retrieve %current task's work struct
4259 *
4260 * Determine if %current task is a workqueue worker and what it's working on.
4261 * Useful to find out the context that the %current task is running in.
4262 *
4263 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4264 */
4265struct work_struct *current_work(void)
4266{
4267 struct worker *worker = current_wq_worker();
4268
4269 return worker ? worker->current_work : NULL;
4270}
4271EXPORT_SYMBOL(current_work);
4272
4273/**
Tejun Heoe62676162013-03-12 17:41:37 -07004274 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4275 *
4276 * Determine whether %current is a workqueue rescuer. Can be used from
4277 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004278 *
4279 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe62676162013-03-12 17:41:37 -07004280 */
4281bool current_is_workqueue_rescuer(void)
4282{
4283 struct worker *worker = current_wq_worker();
4284
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004285 return worker && worker->rescue_wq;
Tejun Heoe62676162013-03-12 17:41:37 -07004286}
4287
4288/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004289 * workqueue_congested - test whether a workqueue is congested
4290 * @cpu: CPU in question
4291 * @wq: target workqueue
4292 *
4293 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4294 * no synchronization around this function and the test result is
4295 * unreliable and only useful as advisory hints or for debugging.
4296 *
Tejun Heod3251852013-05-10 11:10:17 -07004297 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4298 * Note that both per-cpu and unbound workqueues may be associated with
4299 * multiple pool_workqueues which have separate congested states. A
4300 * workqueue being congested on one CPU doesn't mean the workqueue is also
4301 * contested on other CPUs / NUMA nodes.
4302 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004303 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004304 * %true if congested, %false otherwise.
4305 */
Tejun Heod84ff052013-03-12 11:29:59 -07004306bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004307{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004308 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004309 bool ret;
4310
Lai Jiangshan88109452013-03-20 03:28:10 +08004311 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004312
Tejun Heod3251852013-05-10 11:10:17 -07004313 if (cpu == WORK_CPU_UNBOUND)
4314 cpu = smp_processor_id();
4315
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004316 if (!(wq->flags & WQ_UNBOUND))
4317 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4318 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004319 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004320
Tejun Heo76af4d92013-03-12 11:30:00 -07004321 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004322 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004323
4324 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004325}
4326EXPORT_SYMBOL_GPL(workqueue_congested);
4327
4328/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004329 * work_busy - test whether a work is currently pending or running
4330 * @work: the work to be tested
4331 *
4332 * Test whether @work is currently pending or running. There is no
4333 * synchronization around this function and the test result is
4334 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004335 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004336 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004337 * OR'd bitmask of WORK_BUSY_* bits.
4338 */
4339unsigned int work_busy(struct work_struct *work)
4340{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004341 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004342 unsigned long flags;
4343 unsigned int ret = 0;
4344
Tejun Heodcd989c2010-06-29 10:07:14 +02004345 if (work_pending(work))
4346 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004347
Tejun Heofa1b54e2013-03-12 11:30:00 -07004348 local_irq_save(flags);
4349 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004350 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004351 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004352 if (find_worker_executing_work(pool, work))
4353 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004354 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004355 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004356 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004357
4358 return ret;
4359}
4360EXPORT_SYMBOL_GPL(work_busy);
4361
Tejun Heo3d1cb202013-04-30 15:27:22 -07004362/**
4363 * set_worker_desc - set description for the current work item
4364 * @fmt: printf-style format string
4365 * @...: arguments for the format string
4366 *
4367 * This function can be called by a running work function to describe what
4368 * the work item is about. If the worker task gets dumped, this
4369 * information will be printed out together to help debugging. The
4370 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4371 */
4372void set_worker_desc(const char *fmt, ...)
4373{
4374 struct worker *worker = current_wq_worker();
4375 va_list args;
4376
4377 if (worker) {
4378 va_start(args, fmt);
4379 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4380 va_end(args);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004381 }
4382}
Steffen Maier5c750d52018-05-17 19:14:57 +02004383EXPORT_SYMBOL_GPL(set_worker_desc);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004384
4385/**
4386 * print_worker_info - print out worker information and description
4387 * @log_lvl: the log level to use when printing
4388 * @task: target task
4389 *
4390 * If @task is a worker and currently executing a work item, print out the
4391 * name of the workqueue being serviced and worker description set with
4392 * set_worker_desc() by the currently executing work item.
4393 *
4394 * This function can be safely called on any task as long as the
4395 * task_struct itself is accessible. While safe, this function isn't
4396 * synchronized and may print out mixups or garbages of limited length.
4397 */
4398void print_worker_info(const char *log_lvl, struct task_struct *task)
4399{
4400 work_func_t *fn = NULL;
4401 char name[WQ_NAME_LEN] = { };
4402 char desc[WORKER_DESC_LEN] = { };
4403 struct pool_workqueue *pwq = NULL;
4404 struct workqueue_struct *wq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07004405 struct worker *worker;
4406
4407 if (!(task->flags & PF_WQ_WORKER))
4408 return;
4409
4410 /*
4411 * This function is called without any synchronization and @task
4412 * could be in any state. Be careful with dereferences.
4413 */
Petr Mladeke7005912016-10-11 13:55:17 -07004414 worker = kthread_probe_data(task);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004415
4416 /*
Tejun Heo8bf89592018-05-18 08:47:13 -07004417 * Carefully copy the associated workqueue's workfn, name and desc.
4418 * Keep the original last '\0' in case the original is garbage.
Tejun Heo3d1cb202013-04-30 15:27:22 -07004419 */
4420 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4421 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4422 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4423 probe_kernel_read(name, wq->name, sizeof(name) - 1);
Tejun Heo8bf89592018-05-18 08:47:13 -07004424 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
Tejun Heo3d1cb202013-04-30 15:27:22 -07004425
4426 if (fn || name[0] || desc[0]) {
4427 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
Tejun Heo8bf89592018-05-18 08:47:13 -07004428 if (strcmp(name, desc))
Tejun Heo3d1cb202013-04-30 15:27:22 -07004429 pr_cont(" (%s)", desc);
4430 pr_cont("\n");
4431 }
4432}
4433
Tejun Heo3494fc32015-03-09 09:22:28 -04004434static void pr_cont_pool_info(struct worker_pool *pool)
4435{
4436 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4437 if (pool->node != NUMA_NO_NODE)
4438 pr_cont(" node=%d", pool->node);
4439 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4440}
4441
4442static void pr_cont_work(bool comma, struct work_struct *work)
4443{
4444 if (work->func == wq_barrier_func) {
4445 struct wq_barrier *barr;
4446
4447 barr = container_of(work, struct wq_barrier, work);
4448
4449 pr_cont("%s BAR(%d)", comma ? "," : "",
4450 task_pid_nr(barr->task));
4451 } else {
4452 pr_cont("%s %pf", comma ? "," : "", work->func);
4453 }
4454}
4455
4456static void show_pwq(struct pool_workqueue *pwq)
4457{
4458 struct worker_pool *pool = pwq->pool;
4459 struct work_struct *work;
4460 struct worker *worker;
4461 bool has_in_flight = false, has_pending = false;
4462 int bkt;
4463
4464 pr_info(" pwq %d:", pool->id);
4465 pr_cont_pool_info(pool);
4466
4467 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4468 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4469
4470 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4471 if (worker->current_pwq == pwq) {
4472 has_in_flight = true;
4473 break;
4474 }
4475 }
4476 if (has_in_flight) {
4477 bool comma = false;
4478
4479 pr_info(" in-flight:");
4480 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4481 if (worker->current_pwq != pwq)
4482 continue;
4483
4484 pr_cont("%s %d%s:%pf", comma ? "," : "",
4485 task_pid_nr(worker->task),
4486 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4487 worker->current_func);
4488 list_for_each_entry(work, &worker->scheduled, entry)
4489 pr_cont_work(false, work);
4490 comma = true;
4491 }
4492 pr_cont("\n");
4493 }
4494
4495 list_for_each_entry(work, &pool->worklist, entry) {
4496 if (get_work_pwq(work) == pwq) {
4497 has_pending = true;
4498 break;
4499 }
4500 }
4501 if (has_pending) {
4502 bool comma = false;
4503
4504 pr_info(" pending:");
4505 list_for_each_entry(work, &pool->worklist, entry) {
4506 if (get_work_pwq(work) != pwq)
4507 continue;
4508
4509 pr_cont_work(comma, work);
4510 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4511 }
4512 pr_cont("\n");
4513 }
4514
4515 if (!list_empty(&pwq->delayed_works)) {
4516 bool comma = false;
4517
4518 pr_info(" delayed:");
4519 list_for_each_entry(work, &pwq->delayed_works, entry) {
4520 pr_cont_work(comma, work);
4521 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4522 }
4523 pr_cont("\n");
4524 }
4525}
4526
4527/**
4528 * show_workqueue_state - dump workqueue state
4529 *
Roger Lu7b776af2016-07-01 11:05:02 +08004530 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4531 * all busy workqueues and pools.
Tejun Heo3494fc32015-03-09 09:22:28 -04004532 */
4533void show_workqueue_state(void)
4534{
4535 struct workqueue_struct *wq;
4536 struct worker_pool *pool;
4537 unsigned long flags;
4538 int pi;
4539
4540 rcu_read_lock_sched();
4541
4542 pr_info("Showing busy workqueues and worker pools:\n");
4543
4544 list_for_each_entry_rcu(wq, &workqueues, list) {
4545 struct pool_workqueue *pwq;
4546 bool idle = true;
4547
4548 for_each_pwq(pwq, wq) {
4549 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4550 idle = false;
4551 break;
4552 }
4553 }
4554 if (idle)
4555 continue;
4556
4557 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4558
4559 for_each_pwq(pwq, wq) {
4560 spin_lock_irqsave(&pwq->pool->lock, flags);
4561 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4562 show_pwq(pwq);
4563 spin_unlock_irqrestore(&pwq->pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004564 /*
4565 * We could be printing a lot from atomic context, e.g.
4566 * sysrq-t -> show_workqueue_state(). Avoid triggering
4567 * hard lockup.
4568 */
4569 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004570 }
4571 }
4572
4573 for_each_pool(pool, pi) {
4574 struct worker *worker;
4575 bool first = true;
4576
4577 spin_lock_irqsave(&pool->lock, flags);
4578 if (pool->nr_workers == pool->nr_idle)
4579 goto next_pool;
4580
4581 pr_info("pool %d:", pool->id);
4582 pr_cont_pool_info(pool);
Tejun Heo82607adc2015-12-08 11:28:04 -05004583 pr_cont(" hung=%us workers=%d",
4584 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4585 pool->nr_workers);
Tejun Heo3494fc32015-03-09 09:22:28 -04004586 if (pool->manager)
4587 pr_cont(" manager: %d",
4588 task_pid_nr(pool->manager->task));
4589 list_for_each_entry(worker, &pool->idle_list, entry) {
4590 pr_cont(" %s%d", first ? "idle: " : "",
4591 task_pid_nr(worker->task));
4592 first = false;
4593 }
4594 pr_cont("\n");
4595 next_pool:
4596 spin_unlock_irqrestore(&pool->lock, flags);
Sergey Senozhatsky62635ea2018-01-11 09:53:35 +09004597 /*
4598 * We could be printing a lot from atomic context, e.g.
4599 * sysrq-t -> show_workqueue_state(). Avoid triggering
4600 * hard lockup.
4601 */
4602 touch_nmi_watchdog();
Tejun Heo3494fc32015-03-09 09:22:28 -04004603 }
4604
4605 rcu_read_unlock_sched();
4606}
4607
Tejun Heo6b598082018-05-18 08:47:13 -07004608/* used to show worker information through /proc/PID/{comm,stat,status} */
4609void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4610{
Tejun Heo6b598082018-05-18 08:47:13 -07004611 int off;
4612
4613 /* always show the actual comm */
4614 off = strscpy(buf, task->comm, size);
4615 if (off < 0)
4616 return;
4617
Tejun Heo197f6ac2018-05-21 08:04:35 -07004618 /* stabilize PF_WQ_WORKER and worker pool association */
Tejun Heo6b598082018-05-18 08:47:13 -07004619 mutex_lock(&wq_pool_attach_mutex);
4620
Tejun Heo197f6ac2018-05-21 08:04:35 -07004621 if (task->flags & PF_WQ_WORKER) {
4622 struct worker *worker = kthread_data(task);
4623 struct worker_pool *pool = worker->pool;
Tejun Heo6b598082018-05-18 08:47:13 -07004624
Tejun Heo197f6ac2018-05-21 08:04:35 -07004625 if (pool) {
4626 spin_lock_irq(&pool->lock);
4627 /*
4628 * ->desc tracks information (wq name or
4629 * set_worker_desc()) for the latest execution. If
4630 * current, prepend '+', otherwise '-'.
4631 */
4632 if (worker->desc[0] != '\0') {
4633 if (worker->current_work)
4634 scnprintf(buf + off, size - off, "+%s",
4635 worker->desc);
4636 else
4637 scnprintf(buf + off, size - off, "-%s",
4638 worker->desc);
4639 }
4640 spin_unlock_irq(&pool->lock);
Tejun Heo6b598082018-05-18 08:47:13 -07004641 }
Tejun Heo6b598082018-05-18 08:47:13 -07004642 }
4643
4644 mutex_unlock(&wq_pool_attach_mutex);
4645}
4646
Mathieu Malaterre66448bc2018-05-22 21:47:32 +02004647#ifdef CONFIG_SMP
4648
Tejun Heodb7bccf2010-06-29 10:07:12 +02004649/*
4650 * CPU hotplug.
4651 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004652 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004653 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004654 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004655 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004656 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004657 * blocked draining impractical.
4658 *
Tejun Heo24647572013-01-24 11:01:33 -08004659 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004660 * running as an unbound one and allowing it to be reattached later if the
4661 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004662 */
4663
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004664static void unbind_workers(int cpu)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004665{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004666 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004667 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004668
Tejun Heof02ae732013-03-12 11:30:03 -07004669 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004670 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004671 spin_lock_irq(&pool->lock);
4672
4673 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004674 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004675 * unbound and set DISASSOCIATED. Before this, all workers
4676 * except for the ones which are still executing works from
4677 * before the last CPU down must be on the cpu. After
4678 * this, they may become diasporas.
4679 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004680 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004681 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004682
Tejun Heo24647572013-01-24 11:01:33 -08004683 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004684
Tejun Heo94cf58b2013-01-24 11:01:33 -08004685 spin_unlock_irq(&pool->lock);
Tejun Heo1258fae2018-05-18 08:47:13 -07004686 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004687
Lai Jiangshaneb283422013-03-08 15:18:28 -08004688 /*
4689 * Call schedule() so that we cross rq->lock and thus can
4690 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4691 * This is necessary as scheduler callbacks may be invoked
4692 * from other cpus.
4693 */
4694 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004695
Lai Jiangshaneb283422013-03-08 15:18:28 -08004696 /*
4697 * Sched callbacks are disabled now. Zap nr_running.
4698 * After this, nr_running stays zero and need_more_worker()
4699 * and keep_working() are always true as long as the
4700 * worklist is not empty. This pool now behaves as an
4701 * unbound (in terms of concurrency management) pool which
4702 * are served by workers tied to the pool.
4703 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004704 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004705
4706 /*
4707 * With concurrency management just turned off, a busy
4708 * worker blocking could lead to lengthy stalls. Kick off
4709 * unbound chain execution of currently pending work items.
4710 */
4711 spin_lock_irq(&pool->lock);
4712 wake_up_worker(pool);
4713 spin_unlock_irq(&pool->lock);
4714 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004715}
4716
Tejun Heobd7c0892013-03-19 13:45:21 -07004717/**
4718 * rebind_workers - rebind all workers of a pool to the associated CPU
4719 * @pool: pool of interest
4720 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004721 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004722 */
4723static void rebind_workers(struct worker_pool *pool)
4724{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004725 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004726
Tejun Heo1258fae2018-05-18 08:47:13 -07004727 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004728
Tejun Heoa9ab7752013-03-19 13:45:21 -07004729 /*
4730 * Restore CPU affinity of all workers. As all idle workers should
4731 * be on the run-queue of the associated CPU before any local
Shailendra Verma402dd892015-05-23 10:38:14 +05304732 * wake-ups for concurrency management happen, restore CPU affinity
Tejun Heoa9ab7752013-03-19 13:45:21 -07004733 * of all workers first and then clear UNBOUND. As we're called
4734 * from CPU_ONLINE, the following shouldn't fail.
4735 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004736 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004737 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4738 pool->attrs->cpumask) < 0);
4739
4740 spin_lock_irq(&pool->lock);
Wanpeng Lif7c17d22016-05-11 17:55:18 +08004741
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004742 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004743
Lai Jiangshanda028462014-05-20 17:46:31 +08004744 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004745 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004746
4747 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004748 * A bound idle worker should actually be on the runqueue
4749 * of the associated CPU for local wake-ups targeting it to
4750 * work. Kick all idle workers so that they migrate to the
4751 * associated CPU. Doing this in the same loop as
4752 * replacing UNBOUND with REBOUND is safe as no worker will
4753 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004754 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004755 if (worker_flags & WORKER_IDLE)
4756 wake_up_process(worker->task);
4757
4758 /*
4759 * We want to clear UNBOUND but can't directly call
4760 * worker_clr_flags() or adjust nr_running. Atomically
4761 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4762 * @worker will clear REBOUND using worker_clr_flags() when
4763 * it initiates the next execution cycle thus restoring
4764 * concurrency management. Note that when or whether
4765 * @worker clears REBOUND doesn't affect correctness.
4766 *
Mark Rutlandc95491e2017-10-23 14:07:22 -07004767 * WRITE_ONCE() is necessary because @worker->flags may be
Tejun Heoa9ab7752013-03-19 13:45:21 -07004768 * tested without holding any lock in
4769 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4770 * fail incorrectly leading to premature concurrency
4771 * management operations.
4772 */
4773 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4774 worker_flags |= WORKER_REBOUND;
4775 worker_flags &= ~WORKER_UNBOUND;
Mark Rutlandc95491e2017-10-23 14:07:22 -07004776 WRITE_ONCE(worker->flags, worker_flags);
Tejun Heobd7c0892013-03-19 13:45:21 -07004777 }
4778
Tejun Heoa9ab7752013-03-19 13:45:21 -07004779 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004780}
4781
Tejun Heo7dbc7252013-03-19 13:45:21 -07004782/**
4783 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4784 * @pool: unbound pool of interest
4785 * @cpu: the CPU which is coming up
4786 *
4787 * An unbound pool may end up with a cpumask which doesn't have any online
4788 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4789 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4790 * online CPU before, cpus_allowed of all its workers should be restored.
4791 */
4792static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4793{
4794 static cpumask_t cpumask;
4795 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004796
Tejun Heo1258fae2018-05-18 08:47:13 -07004797 lockdep_assert_held(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004798
4799 /* is @cpu allowed for @pool? */
4800 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4801 return;
4802
Tejun Heo7dbc7252013-03-19 13:45:21 -07004803 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004804
4805 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004806 for_each_pool_worker(worker, pool)
Peter Zijlstrad945b5e2016-06-16 14:38:42 +02004807 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004808}
4809
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004810int workqueue_prepare_cpu(unsigned int cpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004811{
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004812 struct worker_pool *pool;
4813
4814 for_each_cpu_worker_pool(pool, cpu) {
4815 if (pool->nr_workers)
4816 continue;
4817 if (!create_worker(pool))
4818 return -ENOMEM;
4819 }
4820 return 0;
4821}
4822
4823int workqueue_online_cpu(unsigned int cpu)
4824{
Tejun Heo4ce62e92012-07-13 22:16:44 -07004825 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004826 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004827 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004828
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004829 mutex_lock(&wq_pool_mutex);
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004830
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004831 for_each_pool(pool, pi) {
Tejun Heo1258fae2018-05-18 08:47:13 -07004832 mutex_lock(&wq_pool_attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004833
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004834 if (pool->cpu == cpu)
4835 rebind_workers(pool);
4836 else if (pool->cpu < 0)
4837 restore_unbound_workers_cpumask(pool, cpu);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004838
Tejun Heo1258fae2018-05-18 08:47:13 -07004839 mutex_unlock(&wq_pool_attach_mutex);
Tejun Heo65758202012-07-17 12:39:26 -07004840 }
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004841
4842 /* update NUMA affinity of unbound workqueues */
4843 list_for_each_entry(wq, &workqueues, list)
4844 wq_update_unbound_numa(wq, cpu, true);
4845
4846 mutex_unlock(&wq_pool_mutex);
4847 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004848}
4849
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004850int workqueue_offline_cpu(unsigned int cpu)
Tejun Heo65758202012-07-17 12:39:26 -07004851{
Tejun Heo4c16bd32013-04-01 11:23:36 -07004852 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004853
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004854 /* unbinding per-cpu workers should happen on the local CPU */
Lai Jiangshane8b3f8d2017-12-01 22:20:36 +08004855 if (WARN_ON(cpu != smp_processor_id()))
4856 return -1;
4857
4858 unbind_workers(cpu);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004859
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004860 /* update NUMA affinity of unbound workqueues */
4861 mutex_lock(&wq_pool_mutex);
4862 list_for_each_entry(wq, &workqueues, list)
4863 wq_update_unbound_numa(wq, cpu, false);
4864 mutex_unlock(&wq_pool_mutex);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004865
Thomas Gleixner7ee681b2016-07-13 17:16:29 +00004866 return 0;
Tejun Heo65758202012-07-17 12:39:26 -07004867}
4868
Rusty Russell2d3854a2008-11-05 13:39:10 +11004869struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004870 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004871 long (*fn)(void *);
4872 void *arg;
4873 long ret;
4874};
4875
Tejun Heoed48ece2012-09-18 12:48:43 -07004876static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004877{
Tejun Heoed48ece2012-09-18 12:48:43 -07004878 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4879
Rusty Russell2d3854a2008-11-05 13:39:10 +11004880 wfc->ret = wfc->fn(wfc->arg);
4881}
4882
4883/**
Anna-Maria Gleixner22aceb32016-03-10 12:07:38 +01004884 * work_on_cpu - run a function in thread context on a particular cpu
Rusty Russell2d3854a2008-11-05 13:39:10 +11004885 * @cpu: the cpu to run on
4886 * @fn: the function to run
4887 * @arg: the function arg
4888 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004889 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06004890 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004891 *
4892 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004893 */
Tejun Heod84ff052013-03-12 11:29:59 -07004894long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004895{
Tejun Heoed48ece2012-09-18 12:48:43 -07004896 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004897
Tejun Heoed48ece2012-09-18 12:48:43 -07004898 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4899 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004900 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004901 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004902 return wfc.ret;
4903}
4904EXPORT_SYMBOL_GPL(work_on_cpu);
Thomas Gleixner0e8d6a92017-04-12 22:07:28 +02004905
4906/**
4907 * work_on_cpu_safe - run a function in thread context on a particular cpu
4908 * @cpu: the cpu to run on
4909 * @fn: the function to run
4910 * @arg: the function argument
4911 *
4912 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4913 * any locks which would prevent @fn from completing.
4914 *
4915 * Return: The value @fn returns.
4916 */
4917long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4918{
4919 long ret = -ENODEV;
4920
4921 get_online_cpus();
4922 if (cpu_online(cpu))
4923 ret = work_on_cpu(cpu, fn, arg);
4924 put_online_cpus();
4925 return ret;
4926}
4927EXPORT_SYMBOL_GPL(work_on_cpu_safe);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004928#endif /* CONFIG_SMP */
4929
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004930#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304931
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004932/**
4933 * freeze_workqueues_begin - begin freezing workqueues
4934 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004935 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004936 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004937 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004938 *
4939 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004940 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004941 */
4942void freeze_workqueues_begin(void)
4943{
Tejun Heo24b8a842013-03-12 11:29:58 -07004944 struct workqueue_struct *wq;
4945 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004946
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004947 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004948
Tejun Heo6183c002013-03-12 11:29:57 -07004949 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004950 workqueue_freezing = true;
4951
Tejun Heo24b8a842013-03-12 11:29:58 -07004952 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004953 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004954 for_each_pwq(pwq, wq)
4955 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004956 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004957 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004958
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004959 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004960}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004961
4962/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004963 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004964 *
4965 * Check whether freezing is complete. This function must be called
4966 * between freeze_workqueues_begin() and thaw_workqueues().
4967 *
4968 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004969 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004970 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004971 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004972 * %true if some freezable workqueues are still busy. %false if freezing
4973 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004974 */
4975bool freeze_workqueues_busy(void)
4976{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004977 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004978 struct workqueue_struct *wq;
4979 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004980
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004981 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004982
Tejun Heo6183c002013-03-12 11:29:57 -07004983 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004984
Tejun Heo24b8a842013-03-12 11:29:58 -07004985 list_for_each_entry(wq, &workqueues, list) {
4986 if (!(wq->flags & WQ_FREEZABLE))
4987 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004988 /*
4989 * nr_active is monotonically decreasing. It's safe
4990 * to peek without lock.
4991 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004992 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004993 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004994 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004995 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004996 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004997 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004998 goto out_unlock;
4999 }
5000 }
Lai Jiangshan88109452013-03-20 03:28:10 +08005001 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005002 }
5003out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005004 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005005 return busy;
5006}
5007
5008/**
5009 * thaw_workqueues - thaw workqueues
5010 *
5011 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08005012 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005013 *
5014 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07005015 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005016 */
5017void thaw_workqueues(void)
5018{
Tejun Heo24b8a842013-03-12 11:29:58 -07005019 struct workqueue_struct *wq;
5020 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005021
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005022 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005023
5024 if (!workqueue_freezing)
5025 goto out_unlock;
5026
Lai Jiangshan74b414e2014-05-22 19:01:16 +08005027 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005028
Tejun Heo24b8a842013-03-12 11:29:58 -07005029 /* restore max_active and repopulate worklist */
5030 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07005031 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07005032 for_each_pwq(pwq, wq)
5033 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07005034 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005035 }
5036
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005037out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005038 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02005039}
5040#endif /* CONFIG_FREEZER */
5041
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005042static int workqueue_apply_unbound_cpumask(void)
5043{
5044 LIST_HEAD(ctxs);
5045 int ret = 0;
5046 struct workqueue_struct *wq;
5047 struct apply_wqattrs_ctx *ctx, *n;
5048
5049 lockdep_assert_held(&wq_pool_mutex);
5050
5051 list_for_each_entry(wq, &workqueues, list) {
5052 if (!(wq->flags & WQ_UNBOUND))
5053 continue;
5054 /* creating multiple pwqs breaks ordering guarantee */
5055 if (wq->flags & __WQ_ORDERED)
5056 continue;
5057
5058 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5059 if (!ctx) {
5060 ret = -ENOMEM;
5061 break;
5062 }
5063
5064 list_add_tail(&ctx->list, &ctxs);
5065 }
5066
5067 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5068 if (!ret)
5069 apply_wqattrs_commit(ctx);
5070 apply_wqattrs_cleanup(ctx);
5071 }
5072
5073 return ret;
5074}
5075
5076/**
5077 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5078 * @cpumask: the cpumask to set
5079 *
5080 * The low-level workqueues cpumask is a global cpumask that limits
5081 * the affinity of all unbound workqueues. This function check the @cpumask
5082 * and apply it to all unbound workqueues and updates all pwqs of them.
5083 *
5084 * Retun: 0 - Success
5085 * -EINVAL - Invalid @cpumask
5086 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5087 */
5088int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5089{
5090 int ret = -EINVAL;
5091 cpumask_var_t saved_cpumask;
5092
5093 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5094 return -ENOMEM;
5095
Tal Shorerc98a9802017-11-03 17:27:50 +02005096 /*
5097 * Not excluding isolated cpus on purpose.
5098 * If the user wishes to include them, we allow that.
5099 */
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005100 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5101 if (!cpumask_empty(cpumask)) {
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005102 apply_wqattrs_lock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005103
5104 /* save the old wq_unbound_cpumask. */
5105 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5106
5107 /* update wq_unbound_cpumask at first and apply it to wqs. */
5108 cpumask_copy(wq_unbound_cpumask, cpumask);
5109 ret = workqueue_apply_unbound_cpumask();
5110
5111 /* restore the wq_unbound_cpumask when failed. */
5112 if (ret < 0)
5113 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5114
Lai Jiangshana0111cf2015-05-19 18:03:47 +08005115 apply_wqattrs_unlock();
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005116 }
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005117
5118 free_cpumask_var(saved_cpumask);
5119 return ret;
5120}
5121
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005122#ifdef CONFIG_SYSFS
5123/*
5124 * Workqueues with WQ_SYSFS flag set is visible to userland via
5125 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5126 * following attributes.
5127 *
5128 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5129 * max_active RW int : maximum number of in-flight work items
5130 *
5131 * Unbound workqueues have the following extra attributes.
5132 *
Wang Long9a19b462017-11-02 23:05:12 -04005133 * pool_ids RO int : the associated pool IDs for each node
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005134 * nice RW int : nice value of the workers
5135 * cpumask RW mask : bitmask of allowed CPUs for the workers
Wang Long9a19b462017-11-02 23:05:12 -04005136 * numa RW bool : whether enable NUMA affinity
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005137 */
5138struct wq_device {
5139 struct workqueue_struct *wq;
5140 struct device dev;
5141};
5142
5143static struct workqueue_struct *dev_to_wq(struct device *dev)
5144{
5145 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5146
5147 return wq_dev->wq;
5148}
5149
5150static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5151 char *buf)
5152{
5153 struct workqueue_struct *wq = dev_to_wq(dev);
5154
5155 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5156}
5157static DEVICE_ATTR_RO(per_cpu);
5158
5159static ssize_t max_active_show(struct device *dev,
5160 struct device_attribute *attr, char *buf)
5161{
5162 struct workqueue_struct *wq = dev_to_wq(dev);
5163
5164 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5165}
5166
5167static ssize_t max_active_store(struct device *dev,
5168 struct device_attribute *attr, const char *buf,
5169 size_t count)
5170{
5171 struct workqueue_struct *wq = dev_to_wq(dev);
5172 int val;
5173
5174 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5175 return -EINVAL;
5176
5177 workqueue_set_max_active(wq, val);
5178 return count;
5179}
5180static DEVICE_ATTR_RW(max_active);
5181
5182static struct attribute *wq_sysfs_attrs[] = {
5183 &dev_attr_per_cpu.attr,
5184 &dev_attr_max_active.attr,
5185 NULL,
5186};
5187ATTRIBUTE_GROUPS(wq_sysfs);
5188
5189static ssize_t wq_pool_ids_show(struct device *dev,
5190 struct device_attribute *attr, char *buf)
5191{
5192 struct workqueue_struct *wq = dev_to_wq(dev);
5193 const char *delim = "";
5194 int node, written = 0;
5195
5196 rcu_read_lock_sched();
5197 for_each_node(node) {
5198 written += scnprintf(buf + written, PAGE_SIZE - written,
5199 "%s%d:%d", delim, node,
5200 unbound_pwq_by_node(wq, node)->pool->id);
5201 delim = " ";
5202 }
5203 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5204 rcu_read_unlock_sched();
5205
5206 return written;
5207}
5208
5209static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5210 char *buf)
5211{
5212 struct workqueue_struct *wq = dev_to_wq(dev);
5213 int written;
5214
5215 mutex_lock(&wq->mutex);
5216 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5217 mutex_unlock(&wq->mutex);
5218
5219 return written;
5220}
5221
5222/* prepare workqueue_attrs for sysfs store operations */
5223static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5224{
5225 struct workqueue_attrs *attrs;
5226
Lai Jiangshan899a94f2015-05-20 14:41:18 +08005227 lockdep_assert_held(&wq_pool_mutex);
5228
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005229 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5230 if (!attrs)
5231 return NULL;
5232
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005233 copy_workqueue_attrs(attrs, wq->unbound_attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005234 return attrs;
5235}
5236
5237static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5238 const char *buf, size_t count)
5239{
5240 struct workqueue_struct *wq = dev_to_wq(dev);
5241 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005242 int ret = -ENOMEM;
5243
5244 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005245
5246 attrs = wq_sysfs_prep_attrs(wq);
5247 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005248 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005249
5250 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5251 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005252 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005253 else
5254 ret = -EINVAL;
5255
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005256out_unlock:
5257 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005258 free_workqueue_attrs(attrs);
5259 return ret ?: count;
5260}
5261
5262static ssize_t wq_cpumask_show(struct device *dev,
5263 struct device_attribute *attr, char *buf)
5264{
5265 struct workqueue_struct *wq = dev_to_wq(dev);
5266 int written;
5267
5268 mutex_lock(&wq->mutex);
5269 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5270 cpumask_pr_args(wq->unbound_attrs->cpumask));
5271 mutex_unlock(&wq->mutex);
5272 return written;
5273}
5274
5275static ssize_t wq_cpumask_store(struct device *dev,
5276 struct device_attribute *attr,
5277 const char *buf, size_t count)
5278{
5279 struct workqueue_struct *wq = dev_to_wq(dev);
5280 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005281 int ret = -ENOMEM;
5282
5283 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005284
5285 attrs = wq_sysfs_prep_attrs(wq);
5286 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005287 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005288
5289 ret = cpumask_parse(buf, attrs->cpumask);
5290 if (!ret)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005291 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005292
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005293out_unlock:
5294 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005295 free_workqueue_attrs(attrs);
5296 return ret ?: count;
5297}
5298
5299static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5300 char *buf)
5301{
5302 struct workqueue_struct *wq = dev_to_wq(dev);
5303 int written;
5304
5305 mutex_lock(&wq->mutex);
5306 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5307 !wq->unbound_attrs->no_numa);
5308 mutex_unlock(&wq->mutex);
5309
5310 return written;
5311}
5312
5313static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5314 const char *buf, size_t count)
5315{
5316 struct workqueue_struct *wq = dev_to_wq(dev);
5317 struct workqueue_attrs *attrs;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005318 int v, ret = -ENOMEM;
5319
5320 apply_wqattrs_lock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005321
5322 attrs = wq_sysfs_prep_attrs(wq);
5323 if (!attrs)
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005324 goto out_unlock;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005325
5326 ret = -EINVAL;
5327 if (sscanf(buf, "%d", &v) == 1) {
5328 attrs->no_numa = !v;
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005329 ret = apply_workqueue_attrs_locked(wq, attrs);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005330 }
5331
Lai Jiangshand4d3e252015-05-19 18:03:48 +08005332out_unlock:
5333 apply_wqattrs_unlock();
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005334 free_workqueue_attrs(attrs);
5335 return ret ?: count;
5336}
5337
5338static struct device_attribute wq_sysfs_unbound_attrs[] = {
5339 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5340 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5341 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5342 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5343 __ATTR_NULL,
5344};
5345
5346static struct bus_type wq_subsys = {
5347 .name = "workqueue",
5348 .dev_groups = wq_sysfs_groups,
5349};
5350
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005351static ssize_t wq_unbound_cpumask_show(struct device *dev,
5352 struct device_attribute *attr, char *buf)
5353{
5354 int written;
5355
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005356 mutex_lock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005357 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5358 cpumask_pr_args(wq_unbound_cpumask));
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005359 mutex_unlock(&wq_pool_mutex);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005360
5361 return written;
5362}
5363
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005364static ssize_t wq_unbound_cpumask_store(struct device *dev,
5365 struct device_attribute *attr, const char *buf, size_t count)
5366{
5367 cpumask_var_t cpumask;
5368 int ret;
5369
5370 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5371 return -ENOMEM;
5372
5373 ret = cpumask_parse(buf, cpumask);
5374 if (!ret)
5375 ret = workqueue_set_unbound_cpumask(cpumask);
5376
5377 free_cpumask_var(cpumask);
5378 return ret ? ret : count;
5379}
5380
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005381static struct device_attribute wq_sysfs_cpumask_attr =
Lai Jiangshan042f7df2015-04-30 17:16:12 +08005382 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5383 wq_unbound_cpumask_store);
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005384
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005385static int __init wq_sysfs_init(void)
5386{
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005387 int err;
5388
5389 err = subsys_virtual_register(&wq_subsys, NULL);
5390 if (err)
5391 return err;
5392
5393 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005394}
5395core_initcall(wq_sysfs_init);
5396
5397static void wq_device_release(struct device *dev)
5398{
5399 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5400
5401 kfree(wq_dev);
5402}
5403
5404/**
5405 * workqueue_sysfs_register - make a workqueue visible in sysfs
5406 * @wq: the workqueue to register
5407 *
5408 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5409 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5410 * which is the preferred method.
5411 *
5412 * Workqueue user should use this function directly iff it wants to apply
5413 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5414 * apply_workqueue_attrs() may race against userland updating the
5415 * attributes.
5416 *
5417 * Return: 0 on success, -errno on failure.
5418 */
5419int workqueue_sysfs_register(struct workqueue_struct *wq)
5420{
5421 struct wq_device *wq_dev;
5422 int ret;
5423
5424 /*
Shailendra Verma402dd892015-05-23 10:38:14 +05305425 * Adjusting max_active or creating new pwqs by applying
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005426 * attributes breaks ordering guarantee. Disallow exposing ordered
5427 * workqueues.
5428 */
Tejun Heo0a94efb2017-07-23 08:36:15 -04005429 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005430 return -EINVAL;
5431
5432 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5433 if (!wq_dev)
5434 return -ENOMEM;
5435
5436 wq_dev->wq = wq;
5437 wq_dev->dev.bus = &wq_subsys;
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005438 wq_dev->dev.release = wq_device_release;
Lars-Peter Clausen23217b42016-02-17 21:04:41 +01005439 dev_set_name(&wq_dev->dev, "%s", wq->name);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005440
5441 /*
5442 * unbound_attrs are created separately. Suppress uevent until
5443 * everything is ready.
5444 */
5445 dev_set_uevent_suppress(&wq_dev->dev, true);
5446
5447 ret = device_register(&wq_dev->dev);
5448 if (ret) {
Arvind Yadav537f4142018-03-06 15:35:43 +05305449 put_device(&wq_dev->dev);
Frederic Weisbecker6ba94422015-04-02 19:14:39 +08005450 wq->wq_dev = NULL;
5451 return ret;
5452 }
5453
5454 if (wq->flags & WQ_UNBOUND) {
5455 struct device_attribute *attr;
5456
5457 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5458 ret = device_create_file(&wq_dev->dev, attr);
5459 if (ret) {
5460 device_unregister(&wq_dev->dev);
5461 wq->wq_dev = NULL;
5462 return ret;
5463 }
5464 }
5465 }
5466
5467 dev_set_uevent_suppress(&wq_dev->dev, false);
5468 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5469 return 0;
5470}
5471
5472/**
5473 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5474 * @wq: the workqueue to unregister
5475 *
5476 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5477 */
5478static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5479{
5480 struct wq_device *wq_dev = wq->wq_dev;
5481
5482 if (!wq->wq_dev)
5483 return;
5484
5485 wq->wq_dev = NULL;
5486 device_unregister(&wq_dev->dev);
5487}
5488#else /* CONFIG_SYSFS */
5489static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5490#endif /* CONFIG_SYSFS */
5491
Tejun Heo82607adc2015-12-08 11:28:04 -05005492/*
5493 * Workqueue watchdog.
5494 *
5495 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5496 * flush dependency, a concurrency managed work item which stays RUNNING
5497 * indefinitely. Workqueue stalls can be very difficult to debug as the
5498 * usual warning mechanisms don't trigger and internal workqueue state is
5499 * largely opaque.
5500 *
5501 * Workqueue watchdog monitors all worker pools periodically and dumps
5502 * state if some pools failed to make forward progress for a while where
5503 * forward progress is defined as the first item on ->worklist changing.
5504 *
5505 * This mechanism is controlled through the kernel parameter
5506 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5507 * corresponding sysfs parameter file.
5508 */
5509#ifdef CONFIG_WQ_WATCHDOG
5510
Tejun Heo82607adc2015-12-08 11:28:04 -05005511static unsigned long wq_watchdog_thresh = 30;
Kees Cook5cd79d62017-10-04 16:27:00 -07005512static struct timer_list wq_watchdog_timer;
Tejun Heo82607adc2015-12-08 11:28:04 -05005513
5514static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5515static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5516
5517static void wq_watchdog_reset_touched(void)
5518{
5519 int cpu;
5520
5521 wq_watchdog_touched = jiffies;
5522 for_each_possible_cpu(cpu)
5523 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5524}
5525
Kees Cook5cd79d62017-10-04 16:27:00 -07005526static void wq_watchdog_timer_fn(struct timer_list *unused)
Tejun Heo82607adc2015-12-08 11:28:04 -05005527{
5528 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5529 bool lockup_detected = false;
5530 struct worker_pool *pool;
5531 int pi;
5532
5533 if (!thresh)
5534 return;
5535
5536 rcu_read_lock();
5537
5538 for_each_pool(pool, pi) {
5539 unsigned long pool_ts, touched, ts;
5540
5541 if (list_empty(&pool->worklist))
5542 continue;
5543
5544 /* get the latest of pool and touched timestamps */
5545 pool_ts = READ_ONCE(pool->watchdog_ts);
5546 touched = READ_ONCE(wq_watchdog_touched);
5547
5548 if (time_after(pool_ts, touched))
5549 ts = pool_ts;
5550 else
5551 ts = touched;
5552
5553 if (pool->cpu >= 0) {
5554 unsigned long cpu_touched =
5555 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5556 pool->cpu));
5557 if (time_after(cpu_touched, ts))
5558 ts = cpu_touched;
5559 }
5560
5561 /* did we stall? */
5562 if (time_after(jiffies, ts + thresh)) {
5563 lockup_detected = true;
5564 pr_emerg("BUG: workqueue lockup - pool");
5565 pr_cont_pool_info(pool);
5566 pr_cont(" stuck for %us!\n",
5567 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5568 }
5569 }
5570
5571 rcu_read_unlock();
5572
5573 if (lockup_detected)
5574 show_workqueue_state();
5575
5576 wq_watchdog_reset_touched();
5577 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5578}
5579
Vincent Whitchurchcb9d7fd2018-08-21 17:25:07 +02005580notrace void wq_watchdog_touch(int cpu)
Tejun Heo82607adc2015-12-08 11:28:04 -05005581{
5582 if (cpu >= 0)
5583 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5584 else
5585 wq_watchdog_touched = jiffies;
5586}
5587
5588static void wq_watchdog_set_thresh(unsigned long thresh)
5589{
5590 wq_watchdog_thresh = 0;
5591 del_timer_sync(&wq_watchdog_timer);
5592
5593 if (thresh) {
5594 wq_watchdog_thresh = thresh;
5595 wq_watchdog_reset_touched();
5596 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5597 }
5598}
5599
5600static int wq_watchdog_param_set_thresh(const char *val,
5601 const struct kernel_param *kp)
5602{
5603 unsigned long thresh;
5604 int ret;
5605
5606 ret = kstrtoul(val, 0, &thresh);
5607 if (ret)
5608 return ret;
5609
5610 if (system_wq)
5611 wq_watchdog_set_thresh(thresh);
5612 else
5613 wq_watchdog_thresh = thresh;
5614
5615 return 0;
5616}
5617
5618static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5619 .set = wq_watchdog_param_set_thresh,
5620 .get = param_get_ulong,
5621};
5622
5623module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5624 0644);
5625
5626static void wq_watchdog_init(void)
5627{
Kees Cook5cd79d62017-10-04 16:27:00 -07005628 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
Tejun Heo82607adc2015-12-08 11:28:04 -05005629 wq_watchdog_set_thresh(wq_watchdog_thresh);
5630}
5631
5632#else /* CONFIG_WQ_WATCHDOG */
5633
5634static inline void wq_watchdog_init(void) { }
5635
5636#endif /* CONFIG_WQ_WATCHDOG */
5637
Tejun Heobce90382013-04-01 11:23:32 -07005638static void __init wq_numa_init(void)
5639{
5640 cpumask_var_t *tbl;
5641 int node, cpu;
5642
Tejun Heobce90382013-04-01 11:23:32 -07005643 if (num_possible_nodes() <= 1)
5644 return;
5645
Tejun Heod55262c2013-04-01 11:23:38 -07005646 if (wq_disable_numa) {
5647 pr_info("workqueue: NUMA affinity support disabled\n");
5648 return;
5649 }
5650
Tejun Heo4c16bd32013-04-01 11:23:36 -07005651 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5652 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5653
Tejun Heobce90382013-04-01 11:23:32 -07005654 /*
5655 * We want masks of possible CPUs of each node which isn't readily
5656 * available. Build one from cpu_to_node() which should have been
5657 * fully initialized by now.
5658 */
Kees Cook6396bb22018-06-12 14:03:40 -07005659 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
Tejun Heobce90382013-04-01 11:23:32 -07005660 BUG_ON(!tbl);
5661
5662 for_each_node(node)
Yasuaki Ishimatsu5a6024f2014-07-07 09:56:48 -04005663 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
Tejun Heo1be0c252013-05-15 14:24:24 -07005664 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07005665
5666 for_each_possible_cpu(cpu) {
5667 node = cpu_to_node(cpu);
5668 if (WARN_ON(node == NUMA_NO_NODE)) {
5669 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5670 /* happens iff arch is bonkers, let's just proceed */
5671 return;
5672 }
5673 cpumask_set_cpu(cpu, tbl[node]);
5674 }
5675
5676 wq_numa_possible_cpumask = tbl;
5677 wq_numa_enabled = true;
5678}
5679
Tejun Heo3347fa02016-09-16 15:49:32 -04005680/**
5681 * workqueue_init_early - early init for workqueue subsystem
5682 *
5683 * This is the first half of two-staged workqueue subsystem initialization
5684 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5685 * idr are up. It sets up all the data structures and system workqueues
5686 * and allows early boot code to create workqueues and queue/cancel work
5687 * items. Actual work item execution starts only after kthreads can be
5688 * created and scheduled right before early initcalls.
5689 */
5690int __init workqueue_init_early(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005691{
Tejun Heo7a4e3442013-03-12 11:30:00 -07005692 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005693 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Tejun Heo7a4e3442013-03-12 11:30:00 -07005694 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02005695
Tejun Heoe904e6c2013-03-12 11:29:57 -07005696 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5697
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005698 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
Frederic Weisbecker1bda3f82018-02-21 05:17:26 +01005699 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
Frederic Weisbeckerb05a7922015-04-27 17:58:39 +08005700
Tejun Heoe904e6c2013-03-12 11:29:57 -07005701 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5702
Tejun Heo706026c2013-01-24 11:01:34 -08005703 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07005704 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07005705 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02005706
Tejun Heo7a4e3442013-03-12 11:30:00 -07005707 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07005708 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07005709 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08005710 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07005711 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07005712 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07005713 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07005714
Tejun Heo9daf9e62013-01-24 11:01:33 -08005715 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005716 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08005717 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07005718 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07005719 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02005720 }
5721
Tejun Heo8a2b7532013-09-05 12:30:04 -04005722 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07005723 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5724 struct workqueue_attrs *attrs;
5725
5726 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07005727 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07005728 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04005729
5730 /*
5731 * An ordered wq should have only one pwq as ordering is
5732 * guaranteed by max_active which is enforced by pwqs.
5733 * Turn off NUMA so that dfl_pwq is used for all nodes.
5734 */
5735 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5736 attrs->nice = std_nice[i];
5737 attrs->no_numa = true;
5738 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07005739 }
5740
Tejun Heod320c032010-06-29 10:07:14 +02005741 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005742 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02005743 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02005744 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5745 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01005746 system_freezable_wq = alloc_workqueue("events_freezable",
5747 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05305748 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5749 WQ_POWER_EFFICIENT, 0);
5750 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5751 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5752 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09005753 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05305754 !system_unbound_wq || !system_freezable_wq ||
5755 !system_power_efficient_wq ||
5756 !system_freezable_power_efficient_wq);
Tejun Heo82607adc2015-12-08 11:28:04 -05005757
Tejun Heo3347fa02016-09-16 15:49:32 -04005758 return 0;
5759}
5760
5761/**
5762 * workqueue_init - bring workqueue subsystem fully online
5763 *
5764 * This is the latter half of two-staged workqueue subsystem initialization
5765 * and invoked as soon as kthreads can be created and scheduled.
5766 * Workqueues have been created and work items queued on them, but there
5767 * are no kworkers executing the work items yet. Populate the worker pools
5768 * with the initial workers and enable future kworker creations.
5769 */
5770int __init workqueue_init(void)
5771{
Tejun Heo2186d9f2016-10-19 12:01:27 -04005772 struct workqueue_struct *wq;
Tejun Heo3347fa02016-09-16 15:49:32 -04005773 struct worker_pool *pool;
5774 int cpu, bkt;
5775
Tejun Heo2186d9f2016-10-19 12:01:27 -04005776 /*
5777 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5778 * CPU to node mapping may not be available that early on some
5779 * archs such as power and arm64. As per-cpu pools created
5780 * previously could be missing node hint and unbound pools NUMA
5781 * affinity, fix them up.
Tejun Heo40c17f72018-01-08 05:38:37 -08005782 *
5783 * Also, while iterating workqueues, create rescuers if requested.
Tejun Heo2186d9f2016-10-19 12:01:27 -04005784 */
5785 wq_numa_init();
5786
5787 mutex_lock(&wq_pool_mutex);
5788
5789 for_each_possible_cpu(cpu) {
5790 for_each_cpu_worker_pool(pool, cpu) {
5791 pool->node = cpu_to_node(cpu);
5792 }
5793 }
5794
Tejun Heo40c17f72018-01-08 05:38:37 -08005795 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo2186d9f2016-10-19 12:01:27 -04005796 wq_update_unbound_numa(wq, smp_processor_id(), true);
Tejun Heo40c17f72018-01-08 05:38:37 -08005797 WARN(init_rescuer(wq),
5798 "workqueue: failed to create early rescuer for %s",
5799 wq->name);
5800 }
Tejun Heo2186d9f2016-10-19 12:01:27 -04005801
5802 mutex_unlock(&wq_pool_mutex);
5803
Tejun Heo3347fa02016-09-16 15:49:32 -04005804 /* create the initial workers */
5805 for_each_online_cpu(cpu) {
5806 for_each_cpu_worker_pool(pool, cpu) {
5807 pool->flags &= ~POOL_DISASSOCIATED;
5808 BUG_ON(!create_worker(pool));
5809 }
5810 }
5811
5812 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5813 BUG_ON(!create_worker(pool));
5814
5815 wq_online = true;
Tejun Heo82607adc2015-12-08 11:28:04 -05005816 wq_watchdog_init();
5817
Suresh Siddha6ee05782010-07-30 14:57:37 -07005818 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005819}